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
45 lines
2.1 KiB
Markdown
45 lines
2.1 KiB
Markdown
NuttX-5.14
|
|
==========
|
|
|
|
The 61st release of NuttX, NuttX-5.14, was made on November 27,
|
|
2010. This release includes multiple, important bugfixes as well
|
|
as a new driver for the NXP LPC1766.
|
|
|
|
This release corresponds with SVN release number: r3137
|
|
|
|
Important bugfixes include:
|
|
|
|
* Cortex-M3 Hard Fault. Fixed a hard fault problem that can occur
|
|
if certain types of interrupts are pending at the time another
|
|
interrupt returns. This problem has only been observed on the
|
|
LPC1766 (returning from a SYSTICK interrupt with a pending
|
|
Ethernet interrupt). However, it is assumed that all Cortex-M3
|
|
ports could have this as a latent bug.
|
|
|
|
* TCP/IP Sequence Number Bug. Corrected errors some important
|
|
logic in the way that sequence numbers are managed when send()
|
|
sends out packets before a previous packet has been acknowledged.
|
|
Some of that send() logic was incompatible with logic in the
|
|
uIP layer. Errors seen include: (1) The final final packet in
|
|
a sequence of packets might be too large! In the THTTPD example,
|
|
this might leave some garbage at the bottom of the display. Or
|
|
(2) send() might hang with outstanding, unacknowledged data
|
|
(and with no re-transmission requests). This was due to
|
|
differences in sequence number handling in send() and in
|
|
uip_tcpinput.c; uip_tcpinput.c thought (incorrectly) that all
|
|
of the bytes were acknowledged; send.c knew that they were not.
|
|
|
|
* One-Shot POSIX Timer Bug. Fixed an error in set-up of a one-shot
|
|
POSIX timer. It was using the repetitive timer value (which
|
|
is zero in the one-shot case), always resulting in a 10Ms timer!
|
|
Found and fixed by Wilton Tong.
|
|
|
|
Additional support has been included for the Olimex-LPC1766. Support
|
|
for that board was added to NuttX 5.13. This release extends that
|
|
support with an Ethernet driver. Verified configurations are now
|
|
available for the NuttX OS test, for the NuttShell (NSH, see
|
|
https://nuttx.apache.org/docs/latest/components/nsh/index.html),
|
|
for the NuttX network test, and for the THTTPD webserver.
|
|
(Additional USB configurations are in the release as well, but those
|
|
have not yet been verified. Goals for NuttX-5.15 (and beyond) include:
|
|
(1) Verified USB support, (2) SD card support, and (3) LCD support.
|