Documentation/nxinit: document boot reason property and compound cmds - #19971
Merged
acassis merged 1 commit intoAug 26, 2026
Merged
Conversation
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>
JianyuWang0623
marked this pull request as ready for review
August 26, 2026 02:04
xiaoxiang781216
approved these changes
Aug 26, 2026
jerpelea
approved these changes
Aug 26, 2026
acassis
approved these changes
Aug 26, 2026
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
Reviewers on apps#3751 (support compound command and resetcause-based triggers) asked for documentation of the new features. This adds two sections to
Documentation/applications/system/nxinit/index.rst:sys.boot.reasonproperty set by NXInit at startup fromBOARDIOC_RESET_CAUSE, its two value forms (hardware cause with numeric subreason, or software reset reason string), and the behavior whenCONFIG_BOARDCTL_RESET_CAUSEis disabled or theboardctl()call fails.&&/||short-circuit semantics for chaining commands on a single action line, including quoting behavior.Impact
Documentation only. No code, config, or behavior changes.
Testing
Build Host: Linux x86_64, Sphinx 8.1.3, Python 3
Built the
applications/system/nxinitdoc page standalone with the repo's Sphinx config:No RST syntax/build errors. Also ran
tools/checkpatch.sh -fon the changed file:Marked as draft pending review from @linguini1 and @cederom on the original request in apps#3751.