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
41 lines
2 KiB
Markdown
41 lines
2 KiB
Markdown
NuttX-5.19
|
|
==========
|
|
|
|
The 66th release of NuttX, Version 5.19, was made on March 12, 2011
|
|
and is available for download from the SourceForge website. This
|
|
release includes several new features in various states of integration
|
|
and maturity:
|
|
|
|
* 486SX QEMU port. This port supports the Intel 486SX architecture
|
|
using the QEMU simulator. Initial functionality is in place a
|
|
partially tested. There are still some outstanding issues with
|
|
timer interrupts.
|
|
* Platform specific application support. A new apps/ directory
|
|
appears in this port. This apps/ directory provides a mechanism
|
|
for applications using NuttX to have a highly customized
|
|
initialization process. It supports a set of end-user applications
|
|
than can be executed (1) standalone so you can have a fully
|
|
customized application startup, or (2) on top of NSH. Think
|
|
of it this way: In a buckled-up embedded application, your
|
|
end-user programs will probably have their own dedicated start-up
|
|
logic. But, during development, you might want to have you
|
|
applications available and executable from the NSH command line.
|
|
This apps/ add-on (and NSH hooks) was contributed by Uros to
|
|
accomplish just that.
|
|
* NSH was also extended to support application specific ROMFS
|
|
/etc/init.d/rcS start-up scripts. This feature, as well, as
|
|
all of the above-mentioned apps/ directory support was contributed
|
|
by Uros Platise
|
|
* Additional NSH improvements and bug fixes. See the Changelog
|
|
for details.
|
|
* This release also provides a new SLIP network driver. This
|
|
driver should support point-to-point network communications to
|
|
a host using TCP/IP or UDP. This driver is code complete, but
|
|
not tested in this release.
|
|
* New RAMTRON FRAM driver (contributed by Uros Platise)
|
|
* New generic 16550 UART driver.
|
|
* Cortex-M3 Power improvements: Waits for Interrupt (WFI) in idle
|
|
loop for reduced power consumption (LPC17xx and STM32 only -
|
|
contributed by Uros Platise))
|
|
* New waitpid() system interface.
|
|
* Additional bugfixes: pipes, stdint.h, STM32 SDIO and SPI drivers
|