mirror of https://github.com/apache/nuttx.git synced 2026-10-08 06:45:19 +00:00

Vinicius May f6ecf80ebb Documentation: brand new layout for NuttX documentation.

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

2026-10-08 01:40:54 +08:00

2.2 KiB

Raw Blame History

NuttX-6.10

The 77th release of NuttX, Version 6.10, was made on October 6, 2011 and is available for download from the SourceForge website. Note that release consists of two tarballs: nuttx-6.10.tar.gz and apps-6.10.tar.gz. Both may be needed (see the top-level nuttx/README.txt file for build information).

This release corresponds with SVN release number: r4028

This release includes a few new features and several important bug fixes. The new features (some still incomplete) include:

CDC ACM serial class device-side driver
RTC: Now supports hi-res and lo-res hardware RTC. The lo-res RTC runs at 1Hz.
STM32 I2C driver. Now supports faster, polled mode of operation. Added an I2C trace capability.
ADS7843E touchscreen driver. As used on the SAM3U-EK development board.
AT91SAM3U SPI driver. To support the ADS7843E toucscreen
X11 Support on simulation target. Build errors in the X11 windows for the simulated target have been correct. Added support for a simulated touchscreen on the X11 window (based on mouse inputs).
System Timer. Added support for a 64-bit system timer.
TIFF Support. Added a TIFF library (currently used for storing LCD screen shots).
LCD Support. Added a test to verify that we read and write correct to LCD GRAM memory.
I2C tool. Extended to support to include a verify command and repetitions and auto-address increment for most commands.
USB terminal example. Line oriented serial bridge connects a host USB serial terminal to a host UART serial terminal.
Build System. apps/ Makefile will now include external directories in the application build.

Bugfixes, order roughly on decreasing criticality include:

Message Queues. Correct errors in mq_timedsend() and mq_timedreceive().
FAT. Writes that cross sector boundaries, stray write into the FAT, and a FAT long file name issue
NXFFS. Added a missed error check. Files cannot be opened for writing if they are already opened for reading.
Library: fopen() for append modse was not appending.
STM32 I2C driver. Correct another conflict between concurrent FSMC and I2C1 accesses. Fixed some bad error detection logic.
STM32 SDHC driver. Interrupts were being left disabled.

2.2 KiB Raw Blame History

NuttX-6.10

2.2 KiB

Raw Blame History