mirror of https://github.com/apache/nuttx.git synced 2026-10-08 06:45:19 +00:00

Vinicius May f6ecf80ebb Documentation: brand new layout for NuttX documentation.

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

2026-10-08 01:40:54 +08:00

2.1 KiB

Raw Blame History

NuttX-12.2.1

What's New In This Release Changes to Core OS sched

#9723 {BP-9631} sched/pthread: fix race condition on pthread_cond_wait()

libc

#9719 {BP-9716} libc: Fix Deadloop in VFS if CONFIG_CANCELLATION_POINTS is enabled
#9730 {BP-9611} libc: Minor fix for pwd
#9733 {BP-9626} libc/aio: fix aio_error compatible bug
#9729 {BP-9664} libc/aio/lio_listio: fix the heap use-after-free bug

Changes to the Build System Improvements

#9720 {BP-9673} Revert "tools: Fix CONFIG_BASE_DEFCONFIG generation"

Architectural Support Improvements

#9732 {BP-9621} arch/arm/cxd56xx/cxd56_dmac, lcd_dev: fix null pointer dereference
#9725 {BP-9697} arch/arm/cxd56xx: Fix bug when watchdog restart
#9728 {BP-9711} arch/arm/stm32/stm32_rtcounter.c: up_rtc_initialize Possible s…
#9727 {BP-9700} arch/armv8-m/arm_secure_irq.c: fix writing to the NVIC_AIRCR register
#9722 {BP-9649} arch/arm/stm32f0l0g0: Fix gpio outputs from being configured as interrupts in stm32f0l0g0
#9721 {BP-9658} arch/xtensa/esp32s2: Fix UART1 default pins

Driver Support Improvements

#9724 {BP-9613} drivers/sensors/apds9960.c: Fix resource leak in error handling
#9726 {BP-9692} drivers/video/isx01x: Fix system clock to HV mode

Board Support Improvements

#9734 {BP-9713} boards/arm/cxd56xx/alt1250: Change power on sequence

File System Improvements

#9731 {BP-9615} fs/fat: Fix undefined behavior in signed integer overflow check

2.1 KiB Raw Blame History

NuttX-12.2.1

2.1 KiB

Raw Blame History