docs/applications/nsh: Add documentation for NSH_BUILTIN_AS_COMMAND - #17332
Merged
Conversation
Lenoids
requested review from
Donny9,
btashton,
raiden00pl and
xiaoxiang781216
as code owners
November 14, 2025 08:54
github-actions
Bot
added
Area: Documentation
xiaoxiang781216
previously approved these changes
Nov 14, 2025
This patch adds the description for NSH_BUILTIN_AS_COMMAND including its advantage and disadvantage. NSH_BUILTIN_AS_COMMAND is an optional configuration in nsh. It allows nsh builtin apps to run directly like nsh command without creating a thread. This is done in pull request apache/nuttx-apps#3168 Signed-off-by: Haokun Dong <donghaokun@lixiang.com>
fdcavalcanti
approved these changes
Nov 14, 2025
linguini1
approved these changes
Nov 15, 2025
linguini1
changed the title
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
4 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.
This patch adds the description for NSH_BUILTIN_AS_COMMAND including its advantage and disadvantage. NSH_BUILTIN_AS_COMMAND is an optional configuration in nsh. It allows nsh builtin apps to run directly like nsh command without creating a thread. This is done in pull request apache/nuttx-apps#3168
Summary
Add the description documentation for NSH_BUILTIN_AS_COMMAND.
Impact
Provide description, advantages and disadvantages for NSH_BUILTIN_AS_COMMAND. Make users easier to use.
Testing
N/A. No impact over the codebase.