mirror of
https://github.com/apache/nuttx.git
synced 2026-10-17 11:08:57 +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
81 lines
3.3 KiB
Markdown
81 lines
3.3 KiB
Markdown
NuttX-6.19
|
|
==========
|
|
|
|
The 86th release of NuttX, Version 6.19, was made on June 15, 2012,
|
|
and is available for download from the SourceForge website. Note
|
|
that release consists of two tarballs: nuttx-6.19.tar.gz and
|
|
apps-6.19.tar.gz. Both may be needed (see the top-level nuttx/README.txt
|
|
file for build information).
|
|
|
|
This release corresponds with SVN release number: r4847
|
|
|
|
This release features new support for a Network File System (NFS) client.
|
|
This feature allows a tiny, embedded MCU to mount a remote file system
|
|
exported by an NFS server and then to access the file system as it would
|
|
any local file system. Then the tiny MCU can effectively have terabytes
|
|
of storage!
|
|
|
|
This might be useful for data collection, for MCU configuration information,
|
|
for software updates, for providing modular, loadable code modes, controlling
|
|
a "farm" of MCUs, ... there are many possibilities and opportunities for
|
|
innovation!
|
|
|
|
The NuttShell (NSH) now supports the following command:
|
|
|
|
nfsmount <server-address> <mount-point> <remote-path>
|
|
|
|
That command will mount the remote NFS server directory <remote-path> at
|
|
<mount-point> on the target machine. <server-address> is the IP address of
|
|
the remote server.
|
|
|
|
The NFS development was the graduation project of Jose Pablo Rojas V. who
|
|
is a student at the Instituto Tecnológico de Costa Rica (ITCR, or TEC).
|
|
A lot of effort went into understanding what a tiny, embedded NFS client should
|
|
do and getting the target resource usage to a bare minimum. Only around a
|
|
kilobyte or so of memory is required to run the NFS client (and most of that
|
|
for I/O buffers). Jose Pablo has spent several months living with NFS and
|
|
should be congratulated.
|
|
|
|
Additional new features and extended functionality:
|
|
|
|
* Drivers: SSD1289 LCD driver, MIO283QT2 LCD driver
|
|
|
|
* LM3S: Additional register definition header files (contributed by Max
|
|
Neklyudov).
|
|
|
|
* STM32 Boards: The STM32F4Discovery will now support an SSD1289 LCD,
|
|
The STM3220G-EVAL board support is now equivalent to the STM3240G-EVAL
|
|
board support.
|
|
|
|
* PIC32 Boards: The Mikroelektronika PIC32MX7 MMB board port is now
|
|
functional, very complete, and stable.
|
|
|
|
* Graphics: The NxConsole will now take keyboard input from the NX graphics
|
|
subsystem. This means that if there are multiple NxConsole windows, only
|
|
the top instance that has focus will receive the keyboard input.
|
|
|
|
* apps/: Add the capability to use an arbitrary USB device as the console
|
|
(not necessarily /dev/console). Additional enhancements for USB consoles.
|
|
Added the 'mv' command.
|
|
|
|
Work in progress. This release includes some partially completed
|
|
work that is still not ready for prime time.
|
|
|
|
* Automated Configuration. Automated configuration based on the
|
|
kconfig-frontends tool is being incorporated into the build
|
|
system. The configuration is still not complete enough for
|
|
general use in this release.
|
|
|
|
* STM32 Drivers. Added files that will (eventually) hold an STM32
|
|
OTG FS host driver. This is still a work in progress.
|
|
|
|
Bugfixes (see the change log for details) :
|
|
|
|
* General: sleep() and usleep() return values, sig_timedwait() errno setting
|
|
on timeout.
|
|
* Drivers: STMPE811 touchscreen driver, USB PLC2303, USB CDC/ACM
|
|
* STM32: Several USB device controller driver fixes, F4 interrupt priorities
|
|
(contributed by Mike Smith).
|
|
* Graphics: Keyboard input, fill trapezoid bug
|
|
|
|
As well as other, less critical bugs (see the ChangeLog for details)
|