mirror of
https://github.com/apache/nuttx.git
synced 2026-10-08 06:45:19 +00:00
f6ecf80ebb
The documentation grew one page at a time, so the tree follows the
history of who wrote what and not the shape of NuttX. Scheduling is
spread over three places, a driver page can sit above the subsystem
that owns it, and the front page lists everything at the same level.
That is a lot to face when all you want to know is where the scheduler
lives.
This change files every page under the code it describes. It is a move,
not a rewrite: outside the ten pages named below, every page keeps the
text that is already in master, and no page's text is deleted.
What it does:
* Groups the table of contents into nine chapters.
* Moves the OS subsystems under os/: scheduling, memory, drivers,
filesystem, networking, IPC, interrupts, libs, time.
* Renames the platform pages to the names the source tree uses, and
derives their tags from the tree instead of by hand.
* Splits guides/ by subject.
* Adds Documentation/redirects.py, with a rule for every page that left
its old path, so old URLs keep working. The redirect page also carries
a link's #anchor across to the new page.
Ten pages have text that is new or rewritten. Nine of them are the
landing page of a chapter, which has to exist for the new structure:
index the front page
os/index OS Design
os/scheduling/index Scheduling
os/interrupts/index Interrupts
os/ipc/index IPC
os/time/index Time and timers
about/index About
developing/index Developing NuttX
ReleaseNotes/index Release notes
The tenth is os/libs/libbuiltin, the only page here with technical
content: libs/libbuiltin/ had no page at all. Five SVG diagrams come
with these pages, hand-written XML with no editor metadata.
Nothing outside Documentation/ is touched.
How it was checked:
* Sphinx builds with -W: no warnings, and no document left outside a
toctree.
* A script, offered in the PR, proves the narrow claim this rests on.
For every page outside the ten named above it erases what a move
touches -- link target, path, tag line, toctree block, table border --
from the whole old text and the whole new text, and requires the two
to be byte for byte identical. It also requires every sentence of a
deleted page to turn up somewhere, and every page that left its old
path to have a redirect, from a URL that existed, to where its content
went. It exits non-zero and names the page if any of that is not true,
and it tests added pages too, so forgetting to declare one cannot make
it pass.
* An independent audit checked 133 factual claims on these ten pages
against the tree, one shell command per claim: 130 confirmed, 1
refuted and fixed here, 2 not checkable.
* tools/checkpatch.sh is clean over the range.
The diff is large because moving a page changes every link that points
to it. Most of it is pure renames, and board pages that gained one tag
line.
Assisted-by: Claude:claude-opus-5
81 lines
3.2 KiB
ReStructuredText
81 lines
3.2 KiB
ReStructuredText
=========================================
|
|
NTFC (NuttX Test Framework for Community)
|
|
=========================================
|
|
|
|
NTFC enables automated testing for NuttX across :doc:`simulator
|
|
</platforms/sim/sim/index>`, QEMU, and real hardware via serial interface. The
|
|
framework automatically detects available applications in NuttX images and
|
|
executes applicable tests using pytest-based test cases.
|
|
|
|
The framework and official test cases are available at:
|
|
|
|
- https://github.com/apache/nuttx-ntfc
|
|
- https://github.com/apache/nuttx-ntfc-testing
|
|
|
|
Detailed documentation is available in the framework repository.
|
|
|
|
CI runtime test cases use NTFC. Configurations with an NTFC runner include:
|
|
|
|
- :doc:`risc-v/qemu-rv </platforms/risc-v/qemu-rv/index>`: ``rv-virt/citest64``
|
|
- :doc:`risc-v/qemu-rv </platforms/risc-v/qemu-rv/index>`: ``rv-virt/citest``
|
|
- :doc:`sim/sim </platforms/sim/sim/index>`: ``sim/citest``
|
|
- :doc:`arm/imx6 </platforms/arm/imx6/index>`: ``sabre-6quad/citest``
|
|
- :doc:`arm64/qemu </platforms/arm64/qemu/boards/qemu-armv8a/index>`: ``qemu-armv8a/citest``
|
|
- :doc:`arm64/qemu </platforms/arm64/qemu/boards/qemu-armv8a/index>`: ``qemu-armv8a/citest_smp``
|
|
- :doc:`x86_64/qemu </platforms/x86_64/qemu/boards/qemu-intel64/index>`: ``qemu-intel64/citest_smp``
|
|
|
|
Running a CI Test Target Locally
|
|
================================
|
|
|
|
Run NTFC from the top-level NuttX source directory. The relative paths in a
|
|
target's ``config.yaml`` file, including the NuttX configuration and image
|
|
paths, are resolved from that directory. A working NuttX build environment
|
|
and any emulator or hardware required by the target must already be available.
|
|
|
|
Create a Python 3.10 or newer virtual environment and install the NTFC and test
|
|
case versions currently used by NuttX CI:
|
|
|
|
.. code-block:: console
|
|
|
|
$ python3 -m venv ../ntfc-venv
|
|
$ . ../ntfc-venv/bin/activate
|
|
$ python -m pip install ntfc==0.0.1
|
|
$ git clone --branch release-0.0.2 --depth 1 \
|
|
https://github.com/apache/nuttx-ntfc-testing ../nuttx-ntfc-testing
|
|
|
|
Build the target in the usual way. For example, the simulator CI
|
|
configuration uses the Make build:
|
|
|
|
.. code-block:: console
|
|
|
|
$ ./tools/configure.sh sim:citest
|
|
$ make
|
|
|
|
Configurations whose ``config.yaml`` refers to ``./build/nuttx`` require an
|
|
out-of-tree CMake build instead. For example, build ``qemu-armv8a:citest``
|
|
with:
|
|
|
|
.. code-block:: console
|
|
|
|
$ cmake -B build -DBOARD_CONFIG=qemu-armv8a:citest -GNinja
|
|
$ cmake --build build
|
|
|
|
Then pass the test case checkout and the target's NTFC configuration files to
|
|
NTFC. For ``sim:citest`` this is:
|
|
|
|
.. code-block:: console
|
|
|
|
$ python -m ntfc test \
|
|
--testpath=../nuttx-ntfc-testing \
|
|
--confpath=boards/sim/sim/sim/configs/citest/config.yaml \
|
|
--jsonconf=boards/sim/sim/sim/configs/citest/session.json
|
|
|
|
For another target, replace the build target and both configuration paths with
|
|
the files from that target's ``configs/<configuration>`` directory. NTFC
|
|
selects the applicable tests from the NuttX configuration and image and stores
|
|
the test results under ``result/`` by default.
|
|
|
|
NTFC exports test logs as CI artifacts. This allows test logs (including
|
|
:doc:`ostest </applications/testing/ostest/index>` output) to be downloaded
|
|
directly from the CI for all targets where the ``citest`` configuration is
|
|
enabled.
|