mirror of
https://github.com/apache/nuttx.git
synced 2026-10-08 06:45:19 +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
188 lines
3.4 KiB
ReStructuredText
188 lines
3.4 KiB
ReStructuredText
=============
|
|
Release Notes
|
|
=============
|
|
|
|
The release notes for every NuttX release, from 0.1.0 onwards, exactly as
|
|
they were written at the time of the release (with perhaps some corrected
|
|
typos).
|
|
|
|
Over the course of time NuttX has used several different repositories --
|
|
CVS, two SVN repositories and currently git -- so revision information
|
|
specific to an older repository may not be meaningful today. To make it
|
|
easier to find those older versions in the current git repository, a
|
|
lightweight tag has been applied to most releases; the tag name is the
|
|
release name (for example, release 6.27 has the tag ``nuttx-6.27``).
|
|
Tagging starts at ``nuttx-4.14``: the 46 releases from 0.1.0 to 0.4.13
|
|
predate it and have no tag.
|
|
|
|
.. note::
|
|
When cutting a release, add the new notes file here and prepend it to the
|
|
list below. Give the file a single top level heading -- the release name,
|
|
underlined with ``=`` -- and start every section inside it at ``##`` or
|
|
deeper, so that the release appears in this index as one entry rather than
|
|
one entry per section. See :doc:`/contributing/releases` for the full
|
|
release procedure.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:titlesonly:
|
|
:caption: Releases
|
|
|
|
NuttX-13.0.1
|
|
NuttX-13.0.0
|
|
NuttX-12.13.0
|
|
NuttX-12.12.0
|
|
NuttX-12.11.0
|
|
NuttX-12.10.0
|
|
NuttX-12.9.0
|
|
NuttX-12.8.0
|
|
NuttX-12.7.0
|
|
NuttX-12.6.0
|
|
NuttX-12.5.1
|
|
NuttX-12.5.0
|
|
NuttX-12.4.0
|
|
NuttX-12.3.0
|
|
NuttX-12.2.1
|
|
NuttX-12.2.0
|
|
NuttX-12.1.0
|
|
NuttX-12.0.0
|
|
NuttX-11.0.0
|
|
NuttX-10.3.0
|
|
NuttX-10.2.0
|
|
NuttX-10.1.0
|
|
NuttX-10.0.0
|
|
NuttX-9.1.0
|
|
NuttX-9.0.0
|
|
NuttX-8.2
|
|
NuttX-8.1
|
|
NuttX-7.31
|
|
NuttX-7.30
|
|
NuttX-7.29
|
|
NuttX-7.28
|
|
NuttX-7.27
|
|
NuttX-7.26
|
|
NuttX-7.25
|
|
NuttX-7.24
|
|
NuttX-7.23
|
|
NuttX-7.22
|
|
NuttX-7.21
|
|
NuttX-7.20
|
|
NuttX-7.19
|
|
NuttX-7.18
|
|
NuttX-7.17
|
|
NuttX-7.16
|
|
NuttX-7.15
|
|
NuttX-7.14
|
|
NuttX-7.13
|
|
NuttX-7.12
|
|
NuttX-7.11
|
|
NuttX-7.10
|
|
NuttX-7.9
|
|
NuttX-7.8
|
|
NuttX-7.7
|
|
NuttX-7.6
|
|
NuttX-7.5
|
|
NuttX-7.4
|
|
NuttX-7.3
|
|
NuttX-7.2
|
|
NuttX-7.1
|
|
NuttX-6.32
|
|
NuttX-6.31
|
|
NuttX-6.30
|
|
NuttX-6.29
|
|
NuttX-6.28
|
|
NuttX-6.27
|
|
NuttX-6.26
|
|
NuttX-6.25
|
|
NuttX-6.24
|
|
NuttX-6.23
|
|
NuttX-6.22
|
|
NuttX-6.21
|
|
NuttX-6.20
|
|
NuttX-6.19
|
|
NuttX-6.18
|
|
NuttX-6.17
|
|
NuttX-6.16
|
|
NuttX-6.15
|
|
NuttX-6.14
|
|
NuttX-6.13
|
|
NuttX-6.12
|
|
NuttX-6.11
|
|
NuttX-6.10
|
|
NuttX-6.9
|
|
NuttX-6.8
|
|
NuttX-6.7
|
|
NuttX-6.6
|
|
NuttX-6.5
|
|
NuttX-6.4
|
|
NuttX-6.3
|
|
NuttX-6.2
|
|
NuttX-6.1
|
|
NuttX-6.0
|
|
NuttX-5.19
|
|
NuttX-5.18
|
|
NuttX-5.17
|
|
NuttX-5.16
|
|
NuttX-5.15
|
|
NuttX-5.14
|
|
NuttX-5.13
|
|
NuttX-5.12
|
|
NuttX-5.11
|
|
NuttX-5.10
|
|
NuttX-5.9
|
|
NuttX-5.8
|
|
NuttX-5.7
|
|
NuttX-5.6
|
|
NuttX-5.5
|
|
NuttX-5.4
|
|
NuttX-5.3
|
|
NuttX-5.2
|
|
NuttX-5.1
|
|
NuttX-5.0
|
|
NuttX-4.14
|
|
NuttX-0.4.13
|
|
NuttX-0.4.12
|
|
NuttX-0.4.11
|
|
NuttX-0.4.10
|
|
NuttX-0.4.9
|
|
NuttX-0.4.8
|
|
NuttX-0.4.7
|
|
NuttX-0.4.6
|
|
NuttX-0.4.5
|
|
NuttX-0.4.4
|
|
NuttX-0.4.3
|
|
NuttX-0.4.2
|
|
NuttX-0.4.1
|
|
NuttX-0.4.0
|
|
NuttX-0.3.19
|
|
NuttX-0.3.18
|
|
NuttX-0.3.17
|
|
NuttX-0.3.16
|
|
NuttX-0.3.15
|
|
NuttX-0.3.14
|
|
NuttX-0.3.13
|
|
NuttX-0.3.12
|
|
NuttX-0.3.11
|
|
NuttX-0.3.10
|
|
NuttX-0.3.9
|
|
NuttX-0.3.8
|
|
NuttX-0.3.7
|
|
NuttX-0.3.6
|
|
NuttX-0.3.5
|
|
NuttX-0.3.4
|
|
NuttX-0.3.3
|
|
NuttX-0.3.2
|
|
NuttX-0.3.1
|
|
NuttX-0.3.0
|
|
NuttX-0.2.9
|
|
NuttX-0.2.8
|
|
NuttX-0.2.7
|
|
NuttX-0.2.6
|
|
NuttX-0.2.5
|
|
NuttX-0.2.4
|
|
NuttX-0.2.3
|
|
NuttX-0.2.2
|
|
NuttX-0.2.1
|
|
NuttX-0.1.2
|
|
NuttX-0.1.1
|
|
NuttX-0.1.0
|