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
1.8 KiB
NuttX-0.3.18
This is the 30th release of NuttX. This release includes two partially completed ports, several new features, and a couple of important bug fixes. The two partially completed ports are:
- The STMicro STR71x processor and configuration for the Olimex STR-P711 board.
- The Hitachi SH-1 using the SH1_LCEVB1 (SH-1/US7032EVB1) board
Progress on these ports is stalled (as detailed in the ChangeLog).
The new features focus primarily on management of block devices and extensions of the NuttShell (NSH). These include:
- A loop device that converts a file into a block device.
- A block to character (BCH) driver that allow access a block device as if it were character device.
- Added strcasecmp() and strncasecmp() libc functions.
- Added the 'dd' and 'losetup' commands to NSH. These commands (along with mkfatfs and mount), give good management of filesystems on the target.
Several bugs were fixed, the most important of which are:
-
Fixed a race condition workaround delay in LPC214X SPI logic. This was also the cause of some bad MMC/SD performance on that platform.
-
Fixed a recently introduced FAT file system problem: It would mount a (invalid) FAT file system even if the medium is not formatted!
-
Corrected two other important errors in the FAT lseek() implementation: 1 - The sectors-per-cluster value was being reset to "1". 2 - Important lseek logic was omitted when the seek position was zero.
The FAT filesystem has had many bugs fixed in it and, I think, is now maturing and becoming stable.
These changes were verified only on the mcu123.com NXP LPC2148 board, the Hitachi SH1_LCEVB1 board, and the Linux simulator, all using a Linux development environment. Please report any errors to me.
This tarball contains a complete CVS snapshot from November 16, 2008.