mirror of
https://github.com/apache/nuttx.git
synced 2026-10-11 08:10:21 +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
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
NuttX-5.1
|
|
=========
|
|
|
|
This is the 48th release of NuttX. This release adds support for
|
|
two new MCU architectures in various states of development:
|
|
|
|
* AT91SAM3U (http://www.atmel.com/products/at91/sam3landing.asp?family_id=605)
|
|
|
|
This release adds support for the SAM3U-EK development board with
|
|
the AT91SAM3U4E MCU
|
|
(http://www.atmel.com/dyn/products/product_card_mcu.asp?part_id=4562).
|
|
As with most NuttX architecture releases, the release will be
|
|
rolled out in two parts: A basic port and an extended port.
|
|
|
|
NuttX-5.1 includes the basic port for the SAM3U-EK board. This
|
|
release passes the NuttX OS test and is proven to have a valid
|
|
OS implementation. It supports the basic boot-up, serial console
|
|
and timer interrupts. A configuration to support the NuttShell
|
|
is also included.
|
|
|
|
The extended port will also include support for SDIO-based SD
|
|
cards and USB device (and possible LCD support). These extensions
|
|
may or may not happen by the NuttX 5.2 release as my plate is
|
|
kind of full now.
|
|
|
|
* LPC3131 (http://ics.nxp.com/products/lpc3000/lpc313x.lpc314x.lpc315x/)
|
|
|
|
This release also adds the complete implementation of the basic
|
|
port for the NXP LPC3131 MCU on the Embedded Artists EA3131 board
|
|
(http://www.embeddedartists.com/products/kits/lpc3131_kit.php).
|
|
That port, unfortunately has stalled due to tools issues. Those
|
|
tool issues have been resolved and I am confident that the verified
|
|
basic port will be available in NuttX-5.2.
|
|
|
|
The extended release will follow and should include SDIO-based
|
|
SD card support and device USB.
|
|
|
|
A few additional features and bugfixes of a minor nature were also
|
|
incorporated as detailed in the ChangeLog.
|