Skip to content

Documentation/critmon: Document context-switch accounting. - #20086

Merged
michallenc merged 1 commit into
apache:masterfrom
yushuailong:docs/critmon-context-switch
Sep 8, 2026
Merged

Documentation/critmon: Document context-switch accounting.#20086
michallenc merged 1 commit into
apache:masterfrom
yushuailong:docs/critmon-context-switch

Conversation

@yushuailong

Copy link
Copy Markdown
Contributor

Summary

  • Remove the obsolete misspelled crimon documentation placeholder so the application appears only under its correct critmon name.
  • Briefly document how nxsched_switch_critmon() updates timing information across context switches.
  • Correct the descriptions of the PRE-EMPTION CALLER, CSECTION CALLER, RUN, and TIME output columns.
  • Link the critmon application documentation to the critical-section implementation documentation.
  • Follow up on the documentation request from sched/critmonitor: Fix context switch state tracking #20066.

Impact

None just documentation-only

Testing

I confirm that the changes were verified locally and work as intended.

  • Build host: macOS 26.6.2, arm64
  • Python: 3.10.21
  • Sphinx: 6.2.1
  • PlantUML: 1.2026.8
  • Target: NuttX HTML documentation

Remove the misspelled crimon placeholder so the application appears
only under its correct name.

Document how nxsched_switch_critmon() updates timing across context
switches, correct the RUN and TIME column descriptions, and link the
application page to the implementation guide.

This follows up on PR apache#20066

Assisted-by: OpenAI Codex
Signed-off-by: yushuailong <yyyusl@qq.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 Sep 8, 2026
@michallenc
michallenc merged commit 35e8eeb into apache:master Sep 8, 2026
7 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.

3 participants