mirror of
https://github.com/apache/nuttx.git
synced 2026-10-19 12:48:48 +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
63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
NuttX-6.14
|
|
==========
|
|
|
|
The 81st release of NuttX, Version 6.14, was made on January 15, 2012,
|
|
and is available for download from the SourceForge website. Note
|
|
that release consists of two tarballs: nuttx-6.14.tar.gz and
|
|
apps-6.14.tar.gz. Both may be needed (see the top-level nuttx/README.txt
|
|
file for build information).
|
|
|
|
This release corresponds with SVN release number: r4301
|
|
|
|
New features in this release include:
|
|
|
|
* Drivers. The upper-half PWM driver will now support a pulse count (as
|
|
would be needed to control a stepper motor).
|
|
|
|
* STM32. The CAN driver has been verified in loopback mode. ADC driver
|
|
support for the STM32 F4. Add support for UART4-5 and USART6
|
|
(Contributed by Mike Smith). The PWM driver now supports a pulse
|
|
count for TIM1 and TIM8. Timer driver now supports the F4's 32-bit
|
|
timers (Contributed by Mikhail Bychek)
|
|
|
|
* STM32F4Discovery. Support for the STM32F4-Discovery board contributed
|
|
by Mike Smith.
|
|
|
|
* STM3240G-EVAL. Add support for user control of LEDs.
|
|
|
|
* LPC17xx. Add support for loopback mode to CAN driver. CAN TX done
|
|
perations are now interrupt driver. Now supports configurable CAN bit
|
|
rate.
|
|
|
|
* LPC1766-STK. Add support for on-board buttons. Add support for user
|
|
control of LEDs.
|
|
|
|
* LM3S. Add support for the LM3S6432S2E on the TI RDK-S2E (Contributed
|
|
by Mike Smith)
|
|
|
|
* PIC32MX. USB device-side driver (needs further testing). A partial
|
|
Ethernet driver is also in place.
|
|
|
|
* Library. Support added for fixed floating point fieldwidths in output
|
|
formatting (Contributed by Mikhail Bychek)
|
|
|
|
* Build. New targets apps_clean and apps_distclean to simplify working
|
|
with application directories.
|
|
|
|
Bugfixes include:
|
|
|
|
* Drivers. Fixed a buffer-full test in the upper-half CAN driver.
|
|
|
|
* STM32. GPIO initialize logic (submitted by Mike Smith). Fix the
|
|
debug logic that dumps the GPIO configuration.
|
|
|
|
* LPC17xxx. Correct an integer overflow in GPIO interrupt setup
|
|
(prevented pins > 15 from being used as interrupt sources). Correct
|
|
a value used in GPIO interrupt number range test.
|
|
|
|
* FAT. Now returns the correct error value when it is unable to
|
|
recognize the file system.
|
|
|
|
* Build. macOS build fixes (submitted by Mike Smith)
|
|
|
|
And several others. See the ChangeLog for more details.
|