vrmay23 opened a new pull request, #20625:
URL: https://github.com/apache/nuttx/pull/20625
## Summary
Follow-up to #20413.
After it was merged, I read its pages again against current master.
This PR has two commits.
**1. `os/scheduling/index.rst` and its two figures.** I checked every
statement against the code. Some were wrong: the page described
`PENDING` as if it applied with SMP too, the sporadic replenishment
timing was wrong, and the state diagram named `task_activate()`, which
does not exist (the function is `nxtask_activate()`). Some were true
only on a single CPU. And some things a reader needs were missing: what
a thread, the TCB and the scheduler are, how interrupts relate to the
scheduler, priority inheritance and protect, that `sched_lock()` is not
a lock for shared data, and how the CPU set of a thread is chosen. The
commit message lists every change.
**2. Front page and `os/index.rst`.** Two paragraphs and one sentence
describe work that did not go in with #20413:
* "each subsystem is described once" (front page and `os/index.rst`):
`reference/os/{smp,shm,paging}` stayed when I cut #20413 down after
review, so these topics are still in two places.
* "the build fails when the two disagree" (front page): that needs the
board documentation check I took out of #20413 to discuss separately,
and it is not in master.
My mistake: I should have caught these when I reduced #20413.
They can come back in the PRs that make them true.
## Impact
Documentation only: text and two SVG figures. No page moves and no
toctree change; the scheduling page gains links to pages that already
exist.
## Testing
Build host: Ubuntu 26.04.1 LTS, Python 3.12.7, Sphinx 6.2.1.
* Sphinx with `-E -a -W --keep-going -j 4`: build succeeded, no
warnings.
* `tools/checkpatch.sh -c -m -g` on both commits, and `codespell` on the
changed files: clean.
* Every changed statement checked against master with `git grep` and
`git show`.
* Text check against `1381c1b268`: no prose changed outside the three
pages, and no page was removed.
* `git merge-tree` against current master (`1381c1b268`): no conflict.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
