Documentation/rexecd: document command-line options including -t#19240
Open
JianyuWang0623 wants to merge 1 commit into
Open
Documentation/rexecd: document command-line options including -t#19240JianyuWang0623 wants to merge 1 commit into
JianyuWang0623 wants to merge 1 commit into
Conversation
Fill in the previously empty rexecd page with a description of the daemon, its listening port/RPMsg name, usage, and all command-line options (-4/-6/-r/-t), including the new -t threadless option that serves each connection inline without a per-connection worker thread. Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
xiaoxiang781216
approved these changes
Jun 30, 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
The documentation page for the
rexecdremote execution server(
Documentation/applications/netutils/rexecd/index.rst) previouslycontained only a title and no content. This change fills it in with:
requests from the
rexecclient, listens on the rexec port(
REXECD_PORT, 512) for the IP families or on a corresponding RPMsgsocket name for
AF_RPMSG, authenticates the request, runs thecommand and pipes its output back to the client.
rexecdspawns a detached worker thread peraccepted connection so multiple sessions can run concurrently.
Usagesynopsis and anOptionssection documenting everycommand-line option:
-4(AF_INET, default),-6(AF_INET6),-r(AF_RPMSG, with a:doc:cross-reference to the RPMsg coreconcepts page), and the
-tthreadless option, which serves eachconnection inline in the main task instead of spawning a
per-connection worker thread.
The
-toption is the recently added "threadless" mode: it avoidsallocating the worker stack (
CONFIG_NETUTILS_REXECD_STACKSIZE) fromthe heap, which helps on low-memory targets, at the cost of serving
connections strictly one at a time.
Impact
or compatibility impact.
rexecddaemon and itscommand-line options, including the previously undocumented
-toption.
Testing
Pure documentation change, tested with
make html.nuttx/Documentationwithmake html.rexecdpage builds with no warnings or errors; the generated_build/html/applications/netutils/rexecd/index.htmlrenders thedescription, usage, and all options correctly.
:doc:cross-reference to the RPMsg concepts page resolves to avalid link (
../../../components/drivers/special/rpmsg/concepts.html,text "RPMsg Core Concepts"); no broken references.