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.7 KiB

Raw Blame History

NuttX-0.3.19

This is the 31st release of NuttX. This release includes the following new feature:

Add poll() and select() APIs that may be used to monitor for data availability on character devices or TCP/IP sockets.
Implemented support TCP/IP connection backlog. This allows select() to wake-up on new connections to a listener socket.
Added definition of a framebuffer driver and implement framebuffer drivers for the simulated platform and the TI DM320 (untested as of the initial check-in).
Partially developed a graphics framework based on the framebuffer drivers, however, this will not be ready for use for a few more releases. Currently this includes only a few color conversion routines and some rasterizing functions. A tiny windowing system is under development but not ready for check-in yet.
Added support for fixed precision math.
Added support for outgoing multicast packets.

Several bugs were fixed, the most important of which are:

Fixed an important bug in the TCP/IP buffering logic. When TCP/IP read-ahead is enabled and not recv() is in-place when a TCP/IP packet is received, the packet is placed into a read-ahead buffer. However, the old contents of the read-ahead buffer were not being cleared and old data would contaminate the newly received buffer.
Changed the behavior of the serial driver read. It now returns data as it is available rather than waiting for the full requested read size. This makes functions like fgetc() work much more smoothly.

These changes were verified only on the Neuros OSD (ARM9) using a Linux development environment. Please report any errors to me.

This tarball contains a complete CVS snapshot from November 26, 2008.

1.7 KiB Raw Blame History

NuttX-0.3.19

1.7 KiB

Raw Blame History