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
3.2 KiB
NuttX-6.18
The 85th release of NuttX, Version 6.18, was made on May 19, 2012, and is available for download from the SourceForge website. Note that release consists of two tarballs: nuttx-6.18.tar.gz and apps-6.18.tar.gz. Both may be needed (see the top-level nuttx/README.txt file for build information).
The majority of changes in this release are focused on supporting the synchronized release of NxWM, the NuttX tiny window manager. That window manager is released as part of the NxWidgets package, but depends upon many of the changes in this NuttX release.
This release corresponds with SVN release number: r4751
New features and extended functionality:
-
Drivers. Added a watchdog timer driver infrastructure. Add general support for STMicro STMPE811 I/O Expander/touchscreen device.
-
STM32. Add support for the STM32 IWDG and WWDG watchodog timers. DMA now supports circular buffer mode; serial driver now uses circular DMA to improve Rx performance (Contributed by Mike Smith).
-
STM3240G-EVAL Board. Add support for the LCD and for the STMPE811 I/O Expander as a touchscreen controller.
-
PIC32 Boards. Board support for the Mikroelektronika PIC32MX7 Multimedia Board (MMB) and for the Sparkfun UBW32 PIC32 board.
-
NX. Framed windows are now draw in three colors instead of just two. Numerous other extensions needed to support NxWM (see the ChangeLog for details).
-
Library. Add prctl() command that can be used to setting and getting the names of threads. This (plus several other improvements and bug fixes) are part of a larger effort to improve task monitoring capabilities.
Work in progress. This release includes some partially completed work that is still not ready for prime time.
-
NFS Client. Work is progressing on support for an NFS client file system. This is a port of the BSD NFS client file system that is being done by Jose Pablo Rojas V.
-
Automated Configuration. Automated configuration based on the kconfig-frontends tool is being incorporated into the build system. The configuration is still not complete enough for general use in this release.
-
STM32 Drivers. Added files that will (eventually) hold an STM32 OTG FS host driver. This is still a work in progress.
Bugfixes (see the change log for details) :
-
sched_setscheduler() return value (Contributed by Richard Cochran).
-
stdio. Ignore CONFIG_STDIO_LINEBUFFER if the file was opened in binary mode.
-
fopen(). Correct an error in parsing open mode string.
-
serial driver. Improved performance be reducing the amount of time that Rx interrupts are disabled.
-
recvfrom(). Fix a compilation problem.
-
CDC/ACM device driver. Fix an infinite loop that occurs when the serial device is unregistered.
-
STM32 OTG FS device driver. Numerous fixes and the driver is partially functional but there are still some issues that become apparent when debug output is disabled.
-
fcntl(). Always returned zero on success; however, some fcntl commands need to return non-zero values on success.
-
graphics: Many multi-use mode fixes added to support NxWM (see the ChangeLog for details). Auto-raise is temporarily disabled in multi- user mode because it causes some problems with NxWM.
-
on_exit(): Fix compilation errors if CONFIG_SCHED_ONEXIT is enabled.