mirror of
https://github.com/apache/nuttx.git
synced 2026-10-11 00:00:24 +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
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
NuttX-6.0
|
|
=========
|
|
|
|
The 67th release of NuttX, Version 6.0, was made on March 21, 2011
|
|
and is available for download from the SourceForge website. The
|
|
version number of this release was bumped from 5.19 to 6.0. A
|
|
change in the major revision number is used to reflect an incompatibility
|
|
with previous versions. In this release, the NuttX core OS
|
|
functionality has been separated from NuttX application-related
|
|
functionality. These are provided as separate tarballs:
|
|
|
|
* nuttx-6.0.tar.gz, and
|
|
* apps-6.0.tar.gz
|
|
|
|
The purpose of this separation is both to better organize and
|
|
modularize the NuttX source tree, but also to provide better support
|
|
for incorporation of end-user applications with NuttX.
|
|
|
|
The incompatibility results from the changes to the board configuration
|
|
logic needed to supported the separable application. The major
|
|
changes to the configuration include:
|
|
|
|
* CONFIG_APPS_DIR - This should not be set. The default is
|
|
../apps. This should only be set if you have a custom,
|
|
product-specific application directory in some different location.
|
|
|
|
* appconfig - Each board configuration now requires a new file
|
|
called 'appconfig.' As its name suggests, this file provides
|
|
new configuration information needed by the logic in ../apps.
|
|
|
|
In addition to this major reorganization in the directory structure,
|
|
this release also includes some important extensions to existing
|
|
features and some important bugfixes. These include:
|
|
|
|
* The SLIP driver was been well debugged and significantly
|
|
re-designed. Now you can have an Ethernet connection to you
|
|
board even if you have no Ethernet hardware. How cool is that?
|
|
|
|
* The QEMU i486 port is now functional. It has also been reported
|
|
to work on the Bifferboard (see http://bifferos.bizhat.com/).
|
|
|
|
* And extensions to the uIP driver interface, and
|
|
|
|
* Bug fixes to fopen() and STM32 GPIO configuration
|
|
|
|
Please see the ChangeLog for details.
|