mirror of
https://github.com/apache/nuttx.git
synced 2026-10-11 00:00:24 +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
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
NuttX-5.5
|
|
=========
|
|
|
|
This is the 52nd release of NuttX. This release includes one new
|
|
port, some new drivers and some important bugfixes:
|
|
|
|
* NuttX was ported to the Luminary/TI LM3S6965 Ethernet Evaluation
|
|
Kit. At present, that port includes an OS test configuration
|
|
and a NuttShell (NSH) configuration with Telnet support.
|
|
|
|
MMC/SD and Networking support are provided but not thoroughly
|
|
verified in this release: Current development efforts are focused
|
|
on porting the NuttX window system (NX) to work with the
|
|
Evaluation Kits OLED display.
|
|
|
|
* A NuttX Ethernet driver for the Microchip ENC28J60 SPI Ethernet
|
|
chip is available in the source tree (but has not yet been fully
|
|
verified because I haven't properly connected it to hardware
|
|
yet).
|
|
|
|
* The Olimex STR-P711 NuttX port was extended to support the
|
|
ENC28J60 and some new networking configurations were added.
|
|
The ENC28J60 has not been tested on the STR-P711, however,
|
|
because of hardware issues (I don't think the USB powered board
|
|
provides enough power for the ENC28J60 and I don't have the
|
|
right wall wart yet).
|
|
|
|
Along the way, external interrupt support (XTI) was added to
|
|
the STMicro STR-P711 port and some important bugs were fixed
|
|
in the STR-P711 SPI driver.
|
|
|
|
* Added (optional) floating point support for printf().
|
|
(Contributed by Yolande Cates.)
|
|
|
|
* Corrected an important UDP reference counting error. It was
|
|
not a serious error, but it trigger an assertion was IS a serious
|
|
error.
|