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.7 KiB

Raw Blame History

NuttX-6.23

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

This release corresponds with SVN release number: r5313

Note that all SVN information has been stripped from the tarballs. If you need the SVN configuration, you should check out directly from SVN. Revision r5313 should equivalent to release 6.23 of NuttX 6.23:

svn checkout -r5313 svn://svn.code.sf.net/p/nuttx/code/trunk nuttx-code

svn checkout -r5313 http://svn.code.sf.net/p/nuttx/code/trunk nuttx-code

Additional new features and extended functionality:

RTOS: If both atexit() and on_exit() are enabled, use on_exit() to implement atexit(). Updates for RGMP 4.0.
Binfmt: Add support for loading and executing ELF binary modules from a file system.
Drivers: Maxim MAX11802 touchscreen controller (Petteri Aimonen)
STM32 Driver: Implementation of /dev/random using the STM32 Random Number Generator (RNG).
STM32 Boards: ADC support for the Shenzhou IV board. Relay support for the Shenzhou IV board.
C Library: Support is now included for the add-on uClibc++ C++ standard library support. This includes support for iostreams, strings, STL, RTTI, exceptions -- the complete C++ environment. (uClibc++ is provided as a separate add-on package due to licensing issues).

Optimized generic and ARM-specific memcpy() function. Optimized memset() function.

Add support for ferror(), feof(), and clearerror(). Add support for __cxa_atexit().

Math Library: Port of the math library from Rhombus OS by Nick Johnson (Darcy Gong).

Applications: New NSH commands: ifup, ifdown, urlencode, urldecode, base64enc, bas64dec, md5 (Darcy Gong). Add support for NSH telnet login (Darcy Gong). Enancements to NSH ping command to support pinging hosts with very long round-trip times. Extensions to the ifconfig command Darcy Gong),

Many extensions to the webclient/wget and DNS resolver logic from Darcy Gong. JSON, Base64, URL encoding, and MD5 libraries contributed by Darcy Gong.

New examples: ELF loader, JSON, wgetjson, cxxtest, relays.

Bugfixes (see the change log for details). Some of these are very important (marked critical):

Drivers: W25 SPI FLASH
STM32 Drivers: ADC reset
Graphics: Missing implementation of the blocked method (critical, Petteri Aimonen).
C Library: Floating point numbers in printf and related formatting functions (Mike Smith), cf[get|set]speed() (Mike Smith)

As well as other, less critical bugs (see the ChangeLog for details)

2.7 KiB Raw Blame History

NuttX-6.23

2.7 KiB

Raw Blame History