Skip to content

Documentation/applications/system/critmon: add critmon man page#19133

Merged
xiaoxiang781216 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/critmon
Jun 16, 2026
Merged

Documentation/applications/system/critmon: add critmon man page#19133
xiaoxiang781216 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/critmon

Conversation

@Zepp-Hanzj

Copy link
Copy Markdown
Contributor

Summary

Add man page documentation for the critmon critical section monitor tool in Documentation/applications/system/critmon/index.rst.

The documentation covers:

  • Three commands: critmon (one-shot dump), critmon_start (start daemon), critmon_stop (stop daemon)
  • Output format explanation (PRE-EMPTION CALLER, CSECTION CALLER, RUN, TIME, PID, DESCRIPTION)
  • Configuration options (CONFIG_SYSTEM_CRITMONITOR, CONFIG_SCHED_CRITMONITOR, etc.)
  • Usage examples

Impact

No code impact. Documentation only.

Testing

Verified locally by building the documentation with Sphinx.

@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 13, 2026
anchao
anchao previously approved these changes Jun 14, 2026
@xiaoxiang781216

Copy link
Copy Markdown
Contributor

@Zepp-Hanzj please fix:

Warning, treated as error:
/home/runner/work/nuttx/nuttx/Documentation/applications/system/critmon/index.rst:1:Title overline too short.

acassis
acassis previously approved these changes Jun 14, 2026
@Zepp-Hanzj Zepp-Hanzj dismissed stale reviews from acassis, anchao, and xiaoxiang781216 via 748aa30 June 14, 2026 15:08
@Zepp-Hanzj Zepp-Hanzj force-pushed the docs/critmon branch 2 times, most recently from 748aa30 to 66fbf5d Compare June 14, 2026 15:08
@Zepp-Hanzj

Copy link
Copy Markdown
Contributor Author

Fixed. The title overline and underline now match the title length (33 characters). Force-pushed the amended commit.

Add documentation for the critmon command including:
- critmon (one-shot dump)
- critmon_start (start daemon)
- critmon_stop (stop daemon)
- Output format explanation
- Configuration options

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
@xiaoxiang781216 xiaoxiang781216 merged commit 5e5137a into apache:master Jun 16, 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.

5 participants