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
40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
NuttX-5.13
|
|
==========
|
|
|
|
This is the 60th release of NuttX. Headlines for this release
|
|
include:
|
|
|
|
* AVR32, www.mcuzone.com AVR32DEV1
|
|
|
|
The port for the www.mcuzone.com AVRDEV1 board based on the
|
|
Atmel AT32UC3B0256 MCU was (almost) fully integrated. The port
|
|
now successfully passes the NuttX OS test (examples/ostest).
|
|
A NuttShell (NSH) configuration is in place (see the NSH User
|
|
Guide at https://nuttx.apache.org/docs/latest/components/nsh/index.html).
|
|
Testing of that NSH configuration, however, has been postponed
|
|
(because it got bumped by the Olimex LPC1766-STK port -- see below)
|
|
|
|
Current Status: I think I have a hardware problem with my serial
|
|
port setup. There is a good chance that the NSH port is complete
|
|
and functional, but I am not yet able to demonstrate that. At
|
|
present, I get nothing coming in the serial RXD line (probably
|
|
because the pins are configured wrong or I have the MAX232
|
|
connected wrong).
|
|
|
|
A complete port will include drivers for additional AVR32 UC3
|
|
devices -- like SPI and USB --- and will be available in a
|
|
later release, time permitting.
|
|
|
|
* LPC1766, Olimex LPC1766-STK
|
|
|
|
Support for the Olimex-LPC1766 is newly added to NuttX and is
|
|
still undergoing development, test, and integration. Verified
|
|
configurations for the NuttX OS test and for the NuttShell (NSH,
|
|
see the NSH User Guide at
|
|
https://nuttx.apache.org/docs/latest/components/nsh/index.html .
|
|
Additional USB configurations are in the release as well, but
|
|
they have not yet been verified. Goals for NuttX-5.14 include:
|
|
(1) An Ethernet driver, (2) Verified USB support, and (3) SD
|
|
card support.
|
|
|
|
* Additional changes and bugfixes as detailed in the ChangeLog.
|