mirror of
https://github.com/apache/nuttx.git
synced 2026-10-13 17:20:20 +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
43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
NuttX-5.15
|
|
==========
|
|
|
|
The 62nd release of NuttX, NuttX-5.15, was made on December 12,
|
|
2010. This release includes several bugfixes as well as feature
|
|
enhancements, primarily for the Olimex LPC1766-STK board.
|
|
|
|
Important bugfixes included:
|
|
|
|
* Additional fixes needed with the TCP sequence number problem
|
|
"fixed" in NuttX-5.14.
|
|
* In the send() logic, now checks if the destination IP address
|
|
is in the ARP table before sending the packet; an ARP request
|
|
will go out instead. This improves behavior, for example, on
|
|
the first on the first GET request from a browser
|
|
* All USB class drivers need to call DEV_CONNECT() when they are
|
|
ready to be enumerated. That is, (1) initially when bound to
|
|
the USB driver, and (2) after a USB reset.
|
|
* The SPI_SETBITS macro was calling the SPI setmode method.
|
|
* And several other bug fixes of lower importance (see the
|
|
ChangeLog for details).
|
|
|
|
And feature enhancements:
|
|
|
|
* The LPC176x Ethernet driver was using all of AHB SRAM Bank0 for
|
|
Ethernet packet buffers (16K). An option was added to limit
|
|
the amount of SRAM used for packet buffering and to reuse any
|
|
extra Bank0 memory for heap.
|
|
|
|
* Enabled networking and SD/MMC card support in the Olimex
|
|
LPC1766-STK NuttShell (NSH) configuration.
|
|
|
|
* The LPC176x USB driver is now fully fully functional.
|
|
* Added an optional cmddata() method to the SPI interface. Some
|
|
devices require an additional out-of-band bit to specify if the
|
|
next word sent to the device is a command or data. The cmddata
|
|
method provides selection of command or data.
|
|
|
|
* A driver for the Nokia 6100 LCD (with either the Phillips PCF8833
|
|
LCD controller and for the Epson S1D15G10 LCD controller) and
|
|
an NX graphics configuration for the Olimex LPC1766-STK have
|
|
been added. However, neither the LCD driver nor the NX
|
|
configuration have been verified as of the this release.
|