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
2.7 KiB
NuttX-6.16
The 83rd release of NuttX, Version 6.16, was made on March 10, 2012, and is available for download from the SourceForge website. Note that release consists of two tarballs: nuttx-6.16.tar.gz and apps-6.16.tar.gz. Both may be needed (see the top-level nuttx/README.txt file for build information).
This release corresponds with SVN release number: r4475
New features and extended functionality:
-
ARMv7M Support: Includes new, streamlined Cortex-M exception handling provided by Mike Smith. Context switching support for the Cortex-M4 FPU registers is now provided (in both "lazy" and "non-lazy" modes)
-
General Drivers: Added a generic "upper half" Quadrature Encoder driver. The USB CDC/ACM serial driver can now be dynamically connected or disconnected from the host (programmatically or using NSH commands).
-
STM32 Drivers: Added a "lower half" Quadrature Encoder driver. Verified the STM32 F4 DMA driver; Added F4 DMA support to the existing STM32 SDIO driver.
-
STM32 Board Support. Added support for the STM32 F2 family and for the STM3220G-EVAL board (contributed by Gary Teravskis). Support is now included for C++ static constructors (verified using the Atollic toolchain). Added support for the SRAM available on the STM3240G-EVAL board.
-
PIC32 Drivers. PIC32MX USB (device) driver is now functional. The PIC32MX Ethernet driver not yet fully verified (and an unverified SPI driver is also available).
-
Networking. Added a lower-level, thread-independent socket layer. Parts of this layer were created in 6.15 to support the FTPD controlling terminal; this support has been extended in order to support an NFS file system (not yet released).
-
NuttShell (NSH). NSH will now support a USB serial connection for the console (such as CDC/ACM). This is useful in environments where there is no physical serial port on the board.
-
Build System. Reorgnaization of networking header files.
Critical Bugfixes. The following bug fixes are considered critical:
-
Networking: Fixed a "leak" in the TCP/IP read-ahead buffering logic. Corrected an error in TCP/IP sequence numbering/ACK logic which occurred when read-ahead buffering memory is exhausted.
-
STM32 Drivers: Fixed an buffer sizing error in the STM32 Ethernet driver.
Additional Bugfixes: Other important bug fixes are listed below. See the ChangeLog of a complete, detailed list of bug fixes.
- Networking: Corrected recv()/recvfrom() return value. Added logic to monitor for loss of connection after a new connection has been established via accept() (Contributed by Max Nekludov). Add logic to select() to correctly handle POLLHUP (Contributed by Max Nekludov)
Additional bugfixes, name changes, and other differences as detailed in the ChangeLog.