Skip to content

doc/system: Add documentation for NXInit#18967

Open
acassis wants to merge 2 commits into
apache:masterfrom
acassis:doc_nxinit
Open

doc/system: Add documentation for NXInit#18967
acassis wants to merge 2 commits into
apache:masterfrom
acassis:doc_nxinit

Conversation

@acassis
Copy link
Copy Markdown
Contributor

@acassis acassis commented May 26, 2026

Summary

Add documentation for the Init component, including syntax explanations and simple examples.

Impact

User will be a documentation for reference

Testing

$ make html
...
copying images... [100%] _static/images/menuconfig-debug.png
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.

Add documentation for the Init component, including syntax explanations and
simple examples.

Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
@acassis acassis changed the title doc/system: Add documentation for Init doc/system: Add documentation for NXInit May 26, 2026
@github-actions github-actions Bot added Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium labels May 26, 2026
@acassis acassis requested a review from xiaoxiang781216 May 26, 2026 18:09
Comment thread Documentation/applications/system/init/index.rst Outdated
Comment thread Documentation/applications/system/init/index.rst Outdated
Comment thread Documentation/applications/system/init/index.rst Outdated
Comment thread Documentation/applications/system/init/index.rst Outdated
Comment thread Documentation/applications/system/init/index.rst Outdated
Comment thread Documentation/applications/system/init/index.rst Outdated
Comment thread Documentation/applications/system/init/index.rst Outdated
@cederom
Copy link
Copy Markdown
Contributor

cederom commented May 26, 2026

My remarks:

  • create common description of init describing possibilities.
  • create dedicated page for nsh/init.d and nxinit with detailed description and crosslink to the top document.
  • there is a .. warning:: rst mark that we can use to mark nxinit as work-in-progress experimental solution.

jerpelea
jerpelea previously approved these changes May 27, 2026
@acassis
Copy link
Copy Markdown
Contributor Author

acassis commented May 27, 2026

My remarks:

* create common description of init describing possibilities.

* create dedicated page for nsh/init.d and nxinit with detailed description and crosslink to the top document.

* there is a `.. warning::` rst mark that we can use to mark nxinit as work-in-progress experimental solution.

@cederom I liked the idea, but this PR is focused on NXInit. Could you please create an Issue with this suggestion?

@acassis acassis dismissed stale reviews from jerpelea and xiaoxiang781216 via 71d8f55 May 27, 2026 14:11
michallenc
michallenc previously approved these changes May 27, 2026
Comment thread Documentation/applications/system/nxinit/index.rst Outdated
Comment thread Documentation/applications/system/nxinit/index.rst Outdated
Comment thread Documentation/applications/system/nxinit/index.rst Outdated
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>
Copy link
Copy Markdown
Contributor

@cederom cederom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @acassis :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants