mirror of
https://github.com/apache/nuttx.git
synced 2026-10-10 15:50:23 +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
118 lines
2.5 KiB
ReStructuredText
118 lines
2.5 KiB
ReStructuredText
.. todo::
|
|
Create "tutorial" type documentation for specific subjects not to be covered in more general terms.
|
|
|
|
======
|
|
Guides
|
|
======
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
build/building_nuttx_with_app_out_of_src_tree.rst
|
|
build/building_uclibcpp.rst
|
|
build/cpp_cmake.rst
|
|
build/custom_app_directories.rst
|
|
build/customapps.rst
|
|
build/integrate_newlib.rst
|
|
build/nix_flake.rst
|
|
build/platform_directories.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
porting/customboards.rst
|
|
porting/include_files_board_h.rst
|
|
porting/port.rst
|
|
porting/port_bootsequence.rst
|
|
porting/port_relatedkernelconfigrations.rst
|
|
porting/specialstuff_in_nuttxheaderfiles.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
drivers/devicetree.rst
|
|
drivers/drivers.rst
|
|
drivers/logging_rambuffer.rst
|
|
drivers/lwl.rst
|
|
drivers/ofloader.rst
|
|
drivers/reading_can_msgs.rst
|
|
drivers/rndis.rst
|
|
drivers/usbtrace.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
concurrency/fork_vfork_migration.rst
|
|
concurrency/kernel_threads_with_custom_stacks.rst
|
|
concurrency/nestedinterrupts.rst
|
|
concurrency/signal_events_interrupt_handlers.rst
|
|
concurrency/signaling_sem_priority_inheritance.rst
|
|
concurrency/thread_local_storage.rst
|
|
concurrency/usingkernelthreads.rst
|
|
concurrency/versioning_and_task_names.rst
|
|
concurrency/zerolatencyinterrupts.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
programs/fully_linked_elf.rst
|
|
programs/partially_linked_elf.rst
|
|
programs/protected_build.rst
|
|
programs/updating_release_system_elf.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
filesystem/automounter.rst
|
|
filesystem/etcromfs.rst
|
|
filesystem/ram_rom_disks.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
networking/ipv6.rst
|
|
networking/nfs.rst
|
|
networking/nsh_network_link_management.rst
|
|
networking/testingtcpip.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
nsh/multiple_nsh_sessions.rst
|
|
nsh/remove_device_drivers_nsh.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
simulation/qemu_tips.rst
|
|
simulation/renode.rst
|
|
simulation/simulator.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
security/fortify.rst
|
|
security/optee.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
languages/pysimcoder.rst
|
|
languages/rust.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
chip-specific/armv7m_runtimestackcheck.rst
|
|
chip-specific/changing_systemclockconfig.rst
|
|
chip-specific/port_drivers_to_stm32f7.rst
|
|
chip-specific/semihosting.rst
|
|
chip-specific/smaller_vector_tables.rst
|
|
chip-specific/stm32_ports.rst
|
|
chip-specific/stm32ccm.rst
|
|
chip-specific/stm32nullpointer.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
/debugging/index.rst
|