mirror of https://github.com/apache/nuttx.git synced 2026-10-09 23:35:47 +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.5.1

What's New In This Release

Major Changes to Core OS Bug Fixes sched

#12062 sched/SMP: Fix returning uninitialized variable in nxsched_add_readytorun()

#12068 mm/kmap.h: fix typo in comments

Architectural Support Bug Fixes

#12073 all: Fix accessing uninitialized local variables

arm

#12071 arch/arm/am335x: Fix incorrect signedness of variable
#12072 arch/arm/s32k3xx: Fix incorrect check for invalid port or pin number
#12098 arch/arm/stm32h7/fdcan: fixed kconfig and debug register
#12099 arch/arm/stm32h7/stm32_i2c: fix sending large data over i2c
#12070 arch/arm/stm32h7: Serial Fix Logic error in up_dma_txavailable risc-v
#12069 arch/risc-v/esp32[c3|c6|h2]: Fix filesystem test support
#12061 arch/risc-v/espressif: Fix empty cpuint number Xtensa
#12065 arch/xtensa/esp32s3: Fix one page program span over 2 pages

Driver Support Bug Fixes

#12074 drivers/net/lan9250: Fix crash issue of sending packets by lan9250 driver
#12066 drivers/video/isx019: Fix the default_value of some parameters

Board Support Bug Fixes

#12060 boards: Fix board configs after disabling NSH_DISABLE_HELP

arm

#12063 boards/arm/rp2040: Fix build errors for nshsram configurations
#12064 boards/arm/raspberrypi-pico: Fix nshsram build error

Networking Bug Fixes

#12097 net: Fix max conn always one less than configured value

2.1 KiB Raw Blame History

NuttX-12.5.1

2.1 KiB

Raw Blame History