Documentation/applications/system/nxinit: document the "console" option - #20098
Draft
JianyuWang0623 wants to merge 1 commit into
Draft
Documentation/applications/system/nxinit: document the "console" option#20098JianyuWang0623 wants to merge 1 commit into
JianyuWang0623 wants to merge 1 commit into
Conversation
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>
acassis
requested review from
JorgeGzm,
cederom,
linguini1,
simbit18 and
xiaoxiang781216
September 9, 2026 11:54
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.
Summary
Documents the per-service
console [<device>]option added to nxinitby the companion apache/nuttx-apps#3776.
Documentation/applications/system/nxinit/index.rstis nxinit's onlyexisting doc page. This adds
consoleto the option list in "Servicesand Options" and a dedicated subsection explaining:
CONFIG_SYSTEM_NXINIT_CONSOLE_DEVif omitted, and dup it onto theservice's stdin/stdout/stderr before spawning);
nshdoes not (nshalready does the equivalent internally via
nsh_consolemain());gadget itself brought up first (e.g. via
exec -- sercon), sincethe device does not exist until then, unlike a plain UART.
Impact
Documentation only, no code change.
Testing
Confirmed the new section renders correctly in the generated output
(
_build/html/applications/system/nxinit/index.html):