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

1.5 KiB

Raw Blame History

NuttX-5.8

This is the 55th release of NuttX. This includes several important bugfixes:

Corrects some interrupt vectoring for the TI/Stellarix LM3S port
Correct initialization logic for NXP LPC17xxx NuttX ports: Power was not being provided to the GPIO module!
Corrected (but did not verify) implementation of the optional interrupt stack feature (all Cortex M3 architectures).
Correct a HardFault in the LPC17xx SSP driver.

Additional minor fixes are also included as detailed in the ChangeLog.

Several new features have been fully developed and included in this release, but full verification of most of these new features has been blocked for a variety of issues:

Added microSD support for the NuttShell (NSH) configuration in the Nucleus2G LPC1768 port. For reasons that have not yet been determined, I have not successfully accessed the microSD card as of this writing.
Two USB configurations were also added for the Nucleus2G board: One to support the USB serial device and one for the USB mass storage device. Some testing of the USB driver was performed, but full verification is stalled for an OTG style USB cable.
LEDs now work correctly on the Nucleus2G LPC1768 board.
The NuttX/uIP networking subsystem now supports IGMPv2 client. IGMP (Internet Group Multicast Protocol) network "appliances" to join into multicast groups. Outbound traffic to enter and leave multicast groups has been verified, but full verification will require a switch capable of multicast. Issues associated with the receipt of multicast packets are likely.

1.5 KiB Raw Blame History

NuttX-5.8

1.5 KiB

Raw Blame History