Documentation: add initial nxpkg application page#18875
Draft
aviralgarg05 wants to merge 3 commits into
Draft
Conversation
ae8810a to
c519cfb
Compare
Signed-off-by: aviralgarg05 <gargaviral99@gmail.com>
cederom
reviewed
May 13, 2026
cederom
reviewed
May 13, 2026
cederom
reviewed
May 13, 2026
cederom
reviewed
May 13, 2026
Contributor
|
Thank you @aviralgarg05 :-) My comments in the code :-) Alternatively we may just use top level
What do you think @acassis ? :-) |
acassis
reviewed
May 14, 2026
Signed-off-by: aviralgarg05 <gargaviral99@gmail.com>
| - install the payload into a versioned on-device store | ||
| - record installed package state and expose it through ``list`` | ||
|
|
||
| This first documentation page describes the current MVP only. Follow-up work |
Contributor
There was a problem hiding this comment.
The first time an abbreviation is used, it is helpful to spell out the full phrase and put the abbreviation in parenthesis. May I suggest "...the current Minimum Viable Product (MVP) only..."? (Assuming that's what the abbreviation stands for.) The rest of the places can stay as just MVP. Thanks!
| This first documentation page describes the current MVP only. Follow-up work | ||
| such as repository sync, dependency solving, shared-library packaging, and | ||
| rollback/update execution is intentionally out of scope for this initial | ||
| application-level slice. |
Contributor
There was a problem hiding this comment.
Not sure what is meant by "slice" here...
|
|
||
| During this validation, the XIAO ``esp32s3-xiao:elf`` configuration needed | ||
| explicit writable mounts for both ``/etc`` and ``/var``. The fixture mounted | ||
| ``tmpfs`` on those paths first, created ``/etc/nxpkg``, and then copied the |
Contributor
There was a problem hiding this comment.
Just to clarify, both /etc and /var mounted tmpfs?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note: Please adhere to Contributing Guidelines.
Summary
Add an initial
nxpkgapplication page underDocumentation/applications/system.This documents the current MVP scope of
nxpkg, the on-device/etc+/varlayout used by the current implementation, the configuration knobs, the local
repository generation helper, and the XIAO ESP32S3 runtime validation flow used
for the first app-side slice.
This documentation change is the follow-up requested during review of the
companion
nuttx-appsPR:Impact
nxpkgnuttxitselfTesting
Host used for documentation checks:
Companion app/runtime target used for the documented validation flow:
xtensaesp32s3-xiao:elfDocumentation verification performed:
python3 -m docutils.core --strict --halt=warning Documentation/applications/system/nxpkg/index.rst /tmp/nxpkg-doc.htmlPATH=/Users/aviralgarg/Library/Python/3.9/bin:$PATH make htmlfromDocumentation/Companion runtime flow verified on hardware and documented in the page:
nxpkgand confirm usage outputelfsource /mnt/elf/romfs/pkgtest.nshnxpkg install hellonxpkg listExact ROMFS-backed validation script used on the board:
Relevant observed output from the documented runtime flow: