mirror of
https://github.com/apache/nuttx.git
synced 2026-10-08 06:45:19 +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
1.7 KiB
1.7 KiB
NuttX-6.11
The 78th release of NuttX, Version 6.11, was made on November 12, 2011 and is available for download from the SourceForge website. Note that release consists of two tarballs: nuttx-6.11.tar.gz and apps-6.11.tar.gz. Both may be needed (see the top-level nuttx/README.txt file for build information).
This release corresponds with SVN release number: r4090
This release is a maintenance release that includes a few new features and some important bugfixes. New features include:
- NX Graphics: New interfaces to read from graphics memory
- Drivers: AT24 FLASH driver will now supports clustering of blocks to achieve a larger, more usable block size for NXFFS.
- STM32: LCD color corrections
- PIC32: Board configuration for the Microchip PIC32 Ethernet Starter kit (not yet verified), new GPIO support library, button and LED support for the Sure Electronics PIC32MX board. A lot of progress has been made on the PIC32 NuttX port, but it is still not ready for prime time.
- NXP LPC3152: Board configuration for the Embedded Artists EA3152.
Bugfixes, order roughly on decreasing criticality include:
- NXFFS: Corrected critical bugs in initialization, some full FLASH handling, and errors in certain cases where the FLASH is repacked.
- ARM EABI: Fix stack alignment required for passing floating point values.
- Build system: Fix build issues when g++ is used as the compiler.
- NX Graphics: Bitmap error handling, correct RGB color conversion macros, Error when the background window is released.
- STM32: RTC build fixes, LCD color corrections
- Simulation target: build fixes
- C Library: fclose() return value.
See the change log for more detailed information.