Commit graph

6 commits

Author SHA1 Message Date
wangjianyu3
b4aa94d844 Documentation/applications/system/nxinit: document the "console" option
Some checks are pending
Build Documentation / build-html (push) Waiting to run
MemBrowse Memory Report / changes-filter (push) Waiting to run
MemBrowse Memory Report / load-targets (push) Waiting to run
MemBrowse Memory Report / identical (push) Blocked by required conditions
MemBrowse Memory Report / analyze (push) Blocked by required conditions
Document the per-service "console [<device>]" option added to nxinit
by the companion apache/nuttx-apps PR: what it does (open the given
device, or CONFIG_SYSTEM_NXINIT_CONSOLE_DEV if omitted, and dup it onto
the service's stdin/stdout/stderr before spawning), why a plain shell
service needs it (unlike nsh, it never opens a console device on its
own), and why a USB gadget console additionally needs the gadget
brought up first (e.g. via "exec -- sercon"), since the device does not
exist until then.

Assisted-by: Kiro:claude-sonnet-5
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2026-09-10 09:26:33 +02:00
wangjianyu3
5f29325a44 Documentation/nxinit: document boot reason property and compound cmds
Reviewers on apps#3751 (support compound command and resetcause-based
triggers) asked for documentation of the new features. Add two
sections to the nxinit doc:

- "Built-in Properties": describes the sys.boot.reason property set
  by NXInit at startup from BOARDIOC_RESET_CAUSE, its two value forms
  (hardware cause with numeric subreason, or software reset reason
  string), and behavior when CONFIG_BOARDCTL_RESET_CAUSE is disabled
  or the boardctl() call fails.
- "Compound Commands": describes the && / || short-circuit semantics
  for chaining commands on a single action line, including quoting
  behavior.

Assisted-by: GitHubCopilot:claude-sonnet-5
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2026-08-26 10:00:21 -03:00
wangjianyu3
f40e948594 Documentation/nxinit: document property triggers and fix CONFIG names
Some checks are pending
Build Documentation / build-html (push) Waiting to run
MemBrowse Memory Report / changes-filter (push) Waiting to run
MemBrowse Memory Report / load-targets (push) Waiting to run
MemBrowse Memory Report / identical (push) Blocked by required conditions
MemBrowse Memory Report / analyze (push) Blocked by required conditions
The Triggers section previously stated that action (property) triggers
were not yet implemented; they are supported now, so describe the
fnmatch value matching and the edge-triggered semantics of on <event>.
The Examples section used the stale CONFIG_SYSTEM_INIT_* prefix and now
uses CONFIG_SYSTEM_NXINIT_* together with a property trigger example.

This documents the behavior added in
https://github.com/apache/nuttx-apps/pull/3726.

Assisted-by: GitHubCopilot:claude-opus-4.8
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2026-08-17 17:04:04 +08:00
Matteo Golin
8b0c54b59e docs/nxinit: Add link to Android init docs
Add the same link from the NXInit Kconfig help.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2026-05-28 09:38:17 +08:00
Matteo Golin
cee841c775 docs/nxinit: Document configurable file path
Document that the init.rc file path is now configurable.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2026-05-28 09:38:17 +08:00
Alan Carvalho de Assis
4df7831d48 doc/nxinit: Rename Init to NXInit and fix review comments
Initially Xiang contributed NXInit as Init, but then the community
suggested to rename it to NXInit to avoid conflict with other init
systems.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2026-05-27 19:29:04 -04:00