mirror of
https://github.com/apache/nuttx.git
synced 2026-10-11 16:20: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
69 lines
2.6 KiB
Markdown
69 lines
2.6 KiB
Markdown
NuttX-6.9
|
|
=========
|
|
|
|
The 76th release of NuttX, Version 6.9, was made on September 11, 2011
|
|
and is available for download from the SourceForge website. Note
|
|
that release consists of two tarballs: nuttx-6.9.tar.gz and
|
|
apps-6.9.tar.gz. Both may be needed (see the top-level nuttx/README.txt
|
|
file for build information).
|
|
|
|
This release includes a few new features and several important bug fixes.
|
|
The new features (some still incomplete) include:
|
|
|
|
* Analog Support/ NXP LPC17xx: New DAC sub-system including ADC and DAC
|
|
drivers for the LPC17xx. Extensions to the ADS1255 driver.
|
|
(Contributed by Li Zhuoyi (Lzyy))
|
|
|
|
* Power Management: Added a new NuttX power management sub-system for
|
|
controlling and coordinating reduced power states. At present, only
|
|
verified in a simulation environment.
|
|
|
|
* I2C Test Tool: A new application was added that can be used to
|
|
verify and debug I2C interfaces from the NuttShell (NSH) command
|
|
line.
|
|
|
|
* NuttShell (NSH): In addition to the I2C test tool, a date command
|
|
is now supported (if CONFIG_RTC is defined) that can be used to
|
|
read and set the RTC.
|
|
|
|
* NXP LPC17xx: I2C and DAC driver for the NXP LPC17xx family submitted by Li Zhuoyi
|
|
(Lzyy)
|
|
|
|
* Kinetis Cortex-M4: Added a SDHC driver for the Kinetis parts.
|
|
Complete debug of the Kinetis SDHC driver was not completed, however,
|
|
do to some higher priority tasks that forced me to stop work.
|
|
|
|
* Other new drivers: Driver for I2C-based at24cxx EEPROM submitted by
|
|
Li Zhuoyi (Lzyy); Driver for the LM-75 temperature sensor. Support
|
|
for the LM-75 temperature sensor integrated into the SM3210E-EVAL
|
|
development board.
|
|
|
|
* NuttX Graphics (NX): Added new NX interfaces for drawing circles,
|
|
both circle outlines and filled circles.
|
|
|
|
* FLASH: Added a function that accepts the path to a block driver and
|
|
then erases the underlying FLASH memory
|
|
|
|
* Build System: The Make export logic now also tries to track down all
|
|
architecture-specific header files and include these in the NuttX
|
|
export bundle as well. Various changes and modifications so that
|
|
NuttX will build on FreeBSD using the ASH shell (submitted by Kurt Lidl).
|
|
|
|
Bugfixes, order roughly on decreasing criticality include:
|
|
|
|
* STM32 I2C Driver: Add resets, timeout, and other fixes to work
|
|
reliably with the I2C tool. Corrected a major error introduced in
|
|
NuttX 6.8.
|
|
|
|
* BCH Driver. Several important bugs (noted by Li Zhuoyi (Lzyy))
|
|
were fixed.
|
|
|
|
* C Library: Fixed errors in gmtime() and gmtime_r() that could lead to
|
|
errors in date calculations.
|
|
|
|
* Timing: Correct an error in the tv_nsec calculation that happens
|
|
only config CONFIG_RTC is enabled
|
|
|
|
* Build System: Use of -print-libgcc-file-name to get path to
|
|
libgcc.a might select the wrong libgcc.a if a multilib toolchain
|
|
is used
|