mirror of
https://github.com/apache/nuttx.git
synced 2026-10-12 00:30:23 +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
50 lines
2.2 KiB
Markdown
50 lines
2.2 KiB
Markdown
NuttX-6.1
|
|
=========
|
|
|
|
The 68th release of NuttX, Version 6.1, was made on April 10, 2011
|
|
and is available for download from the SourceForge website. The
|
|
6.0 release introduced a detach-able application environment to
|
|
build applications outside of the NuttX source tree. The primary
|
|
purpose of this release is to correct numerous build problems
|
|
introduced by that architectural change:
|
|
|
|
* In many newer environments, NuttX produced strange Makefile
|
|
errors but built correctly in older environments. A fix provided
|
|
by Rafael Noronha was incorporated and is reported to fix those
|
|
build problems.
|
|
* The apps/ directory build system would not handle Windows-native
|
|
toolchains due to obscure path formatting issues.
|
|
* And other problems as detailed in the Changelog.
|
|
|
|
Many additional changes were made in the 6.1 release for another
|
|
major architectural change: NuttX will now build as a separately
|
|
linked microkernel. In this build option the RTOS builds as a
|
|
kernel, applications build separately and interface with kernel via
|
|
system calls. Applications run in user mode and kernel logic users
|
|
in kernel-mode. This provides a secure environment for NuttX. This
|
|
feature is fully coded in NuttX-6.1, but has not been tested due
|
|
to higher priority tasks that have arisen.
|
|
|
|
Related to this change, support for the Cortex-M3 memory protection
|
|
unit (MPU) has been integrated with the NuttX kernel build to provide
|
|
an even higher level of security.
|
|
|
|
NOTE: This kernel build is an option; the default build configuration
|
|
is still the standard, flat, unsecured RTOS as in previous releases.
|
|
|
|
Additional new features in this release:
|
|
|
|
* Support for LPC17xx GPIO interrupts (with much support from
|
|
Decio Renno).
|
|
* Basic timer support for STM32 (Contributed by Uros Platise)
|
|
* A binfs file system. This is a tiny pseudo file system that
|
|
lets named applications to be viewed and accessed in NSH under
|
|
the /bin directory.
|
|
* An I2C-based driver for the LIS331DL MEMS motion sensor.
|
|
(Contributed by Uros Platise.)
|
|
* A configuration for the Embedded Artists LPCXpresso LPC1768 board.
|
|
* The user_initialize() interface has been removed.
|
|
|
|
And several bugfix associated with SD drivers, opendir(), signed
|
|
8-bit types (int8_t), and USB serial device. See the ChangeLog for
|
|
details.
|