mirror of
https://github.com/apache/nuttx.git
synced 2026-10-08 14:55:18 +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.5 KiB
1.5 KiB
NuttX-0.3.14
This is the 26th release of NuttX. This release includes some important bugfixes as well as a few new features. Critical bugs fixed include:
FAT FS:
- Fixed several critical bugs with regard to fat reading and writing and FAT12 accesses. Basically the FAT FS only worked with my tiny test files and test cases. A lot of stronger FAT tested is still needed!
- Fixed another FAT bug in implementation of FAT lseek(); this prohibited correct random access to large files.
Network:
- Corrected a critical bug that may prevent recvfrom from receiving packets from most remote UDP port numbers.
- Corrected an error in multi-threaded socket handling in send() and sendto(). Outgoing data could overwrite incoming data.
- Corrected IP checksum calculation in ICMP and UDP message send logic.
- Corrected an error in send() timeout logic.
New features were also added:
Network:
- Added support for application access to ICMP protocol stacks
- Added ping request logic (net/uip).
- Added basic TFTP client logic (netutils/tftpc).
NuttShell (NSH):
- New commands: 'test', '[', 'ping', 'mkrd', 'xd', and TFTP 'get' and 'put' See the new NuttShell User Guide for additional information.
Other less critical bugs were also fixed and other less important features were were added. See the ChangeLog for details.
These changes were verified only on the Neuros OSD (ARM9). Please report any errors to me.
This tarball contains a complete CVS snapshot from September 8, 2008.