Skip to content

Documentation/rexecd: document command-line options including -t#19240

Open
JianyuWang0623 wants to merge 1 commit into
apache:masterfrom
JianyuWang0623:rexecd-doc
Open

Documentation/rexecd: document command-line options including -t#19240
JianyuWang0623 wants to merge 1 commit into
apache:masterfrom
JianyuWang0623:rexecd-doc

Conversation

@JianyuWang0623

Copy link
Copy Markdown
Contributor

Summary

The documentation page for the rexecd remote execution server
(Documentation/applications/netutils/rexecd/index.rst) previously
contained only a title and no content. This change fills it in with:

  • A short description of the daemon: it serves remote execution
    requests from the rexec client, listens on the rexec port
    (REXECD_PORT, 512) for the IP families or on a corresponding RPMsg
    socket name for AF_RPMSG, authenticates the request, runs the
    command and pipes its output back to the client.
  • A note that, by default, rexecd spawns a detached worker thread per
    accepted connection so multiple sessions can run concurrently.
  • A Usage synopsis and an Options section documenting every
    command-line option: -4 (AF_INET, default), -6 (AF_INET6),
    -r (AF_RPMSG, with a :doc: cross-reference to the RPMsg core
    concepts page), and the -t threadless option, which serves each
    connection inline in the main task instead of spawning a
    per-connection worker thread.

The -t option is the recently added "threadless" mode: it avoids
allocating the worker stack (CONFIG_NETUTILS_REXECD_STACKSIZE) from
the heap, which helps on low-memory targets, at the cost of serving
connections strictly one at a time.

Impact

  • Documentation only. No source code, build process, hardware, security
    or compatibility impact.
  • Adds user-facing documentation for the rexecd daemon and its
    command-line options, including the previously undocumented -t
    option.

Testing

Pure documentation change, tested with make html.

  • Host: Ubuntu 22.04, Python 3.10.12, Sphinx 8.1.3.
  • Built the docs from nuttx/Documentation with make html.
  • The rexecd page builds with no warnings or errors; the generated
    _build/html/applications/netutils/rexecd/index.html renders the
    description, usage, and all options correctly.
  • The :doc: cross-reference to the RPMsg concepts page resolves to a
    valid link (../../../components/drivers/special/rpmsg/concepts.html,
    text "RPMsg Core Concepts"); no broken references.

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>
@github-actions github-actions Bot added Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small labels Jun 30, 2026
@github-actions

Copy link
Copy Markdown

MemBrowse Memory Report

No memory changes detected for:

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: S The size of the change in this PR is small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants