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
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
NuttX-4.14
|
|
==========
|
|
|
|
This is the 46th release of NuttX. The release extends the support
|
|
for the STMicro STM32 microcontroller. Minimal support for the
|
|
STM3210E-EVAL development board based around the STM32F103ZET6 MCU
|
|
was released in NuttX-0.4.12 and extended in NuttX-0.4.13 to include
|
|
initial USB support. This completes the STM32F103ZET6 and adds:
|
|
|
|
New Generic RTOS Features:
|
|
|
|
* Added generic support that can be included in any block driver
|
|
to provide read-ahead buffering and write buffering for improved
|
|
driver performance.
|
|
* Added a generic worker thread that can used to defer processing
|
|
from an interrupt to a task.
|
|
* Defined a generic SD/SDIO interface can can be bound to a MMC/SD
|
|
or SDIO driver to provide SDIO support.
|
|
* Implemented a an SDIO-based MMC/SD driver using this new SDIO
|
|
interface.
|
|
|
|
New STM32 Features:
|
|
|
|
* Add support to configure an STM32 input GPIO to generate an
|
|
EXTI interrupt.
|
|
* Added support for buttons on the STM3210E-EVAL board.
|
|
* Implemented an STM32 version of the common the SDIO interface.
|
|
* Added a configuration to exercise the STM32 with the USB mass
|
|
storage device class example.
|
|
|
|
This release also corrects some important bugs in the early STM32 release:
|
|
|
|
* Correct error handling in the mount() logic.
|
|
* Fixed several STM32 DMA-related issues. Integrated and debugged
|
|
STM32 DMA functionality that was added in 0.4.12.
|
|
* Fixed several bugs in the STM32 USB device-side driver.
|
|
|
|
NOTE: This version, 4.14, is equivalent to what would have been
|
|
called 0.4.14 to follow 0.4.13. The zero has been eliminated from
|
|
the front of the version number to avoid confusion about the state
|
|
of development: Some have interpreted the leading zero to mean
|
|
that the code is in some way unstable. That was not the intent.
|
|
Beginning in January 2010, I will switch to the 2010.nn versioning
|
|
as many others have done to avoid such confusion.
|
|
|
|
This tarball contains a complete CVS snapshot from December 2, 2009
|