Documentation: fill in pass1 directory description in organization.rst - #19337
Merged
Conversation
Replace the TODO placeholder with a description of the two-pass build mechanism (CONFIG_BUILD_2PASS). pass1/ supports two-pass builds where application-generated source files are compiled and linked into the kernel address space during pass 2, primarily for kernel symbol table generation required by loadable kernel modules. Signed-off-by: hanzhijian <hanzhijian@zepp.com> Author: hanzhijian <hanzhijian@zepp.com>
github-actions
Bot
added
Area: Documentation
xiaoxiang781216
approved these changes
Jul 6, 2026
Contributor
Author
|
By the way, I've also created a Chinese translation of the NuttX documentation: https://github.com/Zepp-Hanzj/nuttx-docs-zh Feedback and contributions are welcome! |
acassis
approved these changes
Jul 6, 2026
Contributor
@Zepp-Hanzj maybe we can include a multi-language support on NuttX Documentation. @xiaoxiang781216 what do you think? |
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
3 participants
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
Replace the
TODOplaceholder inDocumentation/quickstart/organization.rstfor thenuttx/pass1directory with a description of the two-pass build mechanism.Impact
Documentation only — no functional changes.
Testing
Verified against source code:
Kconfig(BUILD_2PASS,PASS1_TARGET,PASS1_BUILDIR,PASS1_OBJECT)pass1/README.txtandpass1/Makefiletools/Unix.mk(pass1 build invocation at line 554)tools/FlatLibs.mk/tools/ProtectedLibs.mk(NUTTXLIBS += libpass1)Documentation/ReleaseNotes/NuttX-7.26(kernel symbol table generation)apps/examples/module/(loadable kernel module example)