Documentation: add initial nxpkg application page#18875
Conversation
ae8810a to
c519cfb
Compare
Signed-off-by: aviralgarg05 <gargaviral99@gmail.com>
|
|
||
| The current implementation uses the following default paths: | ||
|
|
||
| - repository metadata: ``/etc/nxpkg/index.json`` |
There was a problem hiding this comment.
/etc/nxpkg/nxpkg.conf ? :-)
| The current implementation uses the following default paths: | ||
|
|
||
| - repository metadata: ``/etc/nxpkg/index.json`` | ||
| - installed package database: ``/var/lib/nxpkg/installed.json`` |
There was a problem hiding this comment.
/var/db/nxpkg/local.json for local installed packages?
/var/db/nxpkg/repo.json for storage of packages available on repo?
:-)
|
|
||
| - repository metadata: ``/etc/nxpkg/index.json`` | ||
| - installed package database: ``/var/lib/nxpkg/installed.json`` | ||
| - package payload store: ``/var/lib/nxpkg/pkgs`` |
There was a problem hiding this comment.
/var/cache/nxpkg/ for local store of fetched *.nxpkg files?
This way nxpkg clean would just remove this location content in order to free up space?
| - repository metadata: ``/etc/nxpkg/index.json`` | ||
| - installed package database: ``/var/lib/nxpkg/installed.json`` | ||
| - package payload store: ``/var/lib/nxpkg/pkgs`` | ||
| - temporary staging area: ``/var/cache/nxpkg/pkg`` |
There was a problem hiding this comment.
/tmp/nxpkg for staging?
By staging you mean unpack, process, move to target location?
|
Thank you @aviralgarg05 :-) My comments in the code :-) Alternatively we may just use top level
What do you think @acassis ? :-) |
| └── hello/ | ||
| └── 1.0.0/ | ||
| └── hello | ||
|
|
There was a problem hiding this comment.
Please fix to follow what we discussed
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: