Zepp-Hanzj opened a new pull request, #18965:
URL: https://github.com/apache/nuttx/pull/18965
## Summary
* Fill the blank `Documentation/applications/system/taskset/index.rst`
command reference page.
* Document the source-backed command forms: `taskset <mask> <command>
[args ...]`, `taskset -p [mask] <pid>`, and `taskset -h`.
* Document the `CONFIG_SYSTEM_TASKSET` enable option, its `CONFIG_SMP &&
CONFIG_SYSTEM_SYSTEM` dependency, and the related program name / priority /
stack-size options.
* Keep the patch documentation-only and scoped to one `.rst` file.
* Refs #11081.
## Impact
* Is new feature added? NO.
* Is existing feature changed? NO.
* Impact on user (will user need to adapt to change)? NO; this only adds
missing documentation for an existing command.
* Impact on build (will build process change)? NO.
* Impact on hardware (will arch(s) / board(s) / driver(s) change)? NO.
* Impact on documentation (is update required / provided)? YES; the
previously blank `taskset` command page is filled.
* Impact on security (any sort of implications)? NO.
* Impact on compatibility (backward/forward/interoperability)? NO.
* Anything else to consider or add? Documentation claims were checked
against `apps/system/taskset/taskset.c` and `apps/system/taskset/Kconfig` from
`nuttx-apps` upstream master.
## Testing
I confirm that changes are verified on local setup and work as intended:
* Build Host(s): WSL2 Linux x86_64 (`Linux DESKTOP-6B1686O
6.6.114.1-microsoft-standard-WSL2`), Python 3.8.10, Sphinx 7.1.2.
* Target(s): documentation-only change; no hardware target needed.
* Source verification:
* `git -C /home/hanzj/workspace/nuttxspace/apps show
upstream/master:system/taskset/taskset.c`
* `git -C /home/hanzj/workspace/nuttxspace/apps show
upstream/master:system/taskset/Kconfig`
Testing logs before change:
```
Documentation/applications/system/taskset/index.rst contained only the
page title.
Duplicate check found no open PR specifically documenting taskset.
```
Testing logs after change:
```
$ python3 - <<'PY'
from pathlib import Path
from docutils.core import publish_doctree
path = Path('Documentation/applications/system/taskset/index.rst')
publish_doctree(path.read_text(), source_path=str(path),
settings_overrides={'halt_level': 2, 'report_level': 2})
print('docutils OK')
PY
docutils OK
$ cd Documentation
$ PYTHONPATH=_extensions python3 -m sphinx -W -b dummy .
/tmp/nuttx-docs-build-taskset-<pid>
build succeeded.
The dummy builder generates no files.
```
## PR verification Self-Check
* [x] This PR introduces only one functional change.
* [x] I have updated all required description fields above.
* [x] My PR adheres to Contributing
[Guidelines](https://github.com/apache/nuttx/blob/master/CONTRIBUTING.md) and
[Documentation](https://nuttx.apache.org/docs/latest/contributing/index.html)
(git commit title and message, coding standard, etc).
* [ ] My PR is still work in progress (not ready for review).
* [x] My PR is ready for review and can be safely merged into a codebase.
--
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]
