Skip to content

Documentation: Document tee command.#18963

Merged
linguini1 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/tee-command-docs
May 26, 2026
Merged

Documentation: Document tee command.#18963
linguini1 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/tee-command-docs

Conversation

@Zepp-Hanzj
Copy link
Copy Markdown
Contributor

Summary

  • Document the tee system command page that was previously blank.
  • Add configuration, usage, options, arguments, examples, and notes backed by apps/system/tee/tee.c and apps/system/tee/Kconfig.

Impact

  • Documentation only.
  • No runtime behavior changes.

Testing

  • Verified source behavior in apps/system/tee/tee.c and configuration in apps/system/tee/Kconfig.
  • Ran focused RST parse:
    python3 - <<'PY'
    from pathlib import Path
    from docutils.core import publish_doctree
    path = Path('Documentation/applications/system/tee/index.rst')
    publish_doctree(path.read_text(), source_path=str(path),
                    settings_overrides={'halt_level': 2, 'report_level': 2})
    print('docutils OK')
    PY
  • Ran full documentation dummy build:
    cd Documentation
    PYTHONPATH=_extensions python3 -m sphinx -W -b dummy . /tmp/nuttx-docs-build-tee

PR verification Self-Check

  • The change is limited to documentation.
  • The documented behavior is source-backed.
  • The documentation build completed without warnings.
  • No external dependency or board-specific setup is required.

Refs #11081

Add the missing application reference for the tee system command.  The
page now documents the command purpose, build configuration, usage,
options, arguments, examples, and error behavior using the implementation
in apps/system/tee as source evidence.

Signed-off-by: hanzhijian <hanzhijian@zepp.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 May 26, 2026
@linguini1 linguini1 merged commit cea3a33 into apache:master May 26, 2026
3 checks passed
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.

4 participants