mirror of
https://github.com/apache/nuttx.git
synced 2026-10-11 00:00:24 +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
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
NuttX-5.0
|
|
=========
|
|
|
|
This is 47th release of NuttX and the successor to nuttx-4.14. This
|
|
major revision number has been incremented to indicate that an
|
|
incompatibility with previous nuttx releases has been introduced.
|
|
This version adopts standard fixed width integer names as specified
|
|
by the ANSI C99 standard. The core logic of NuttX is older than
|
|
that standard and did not conform to it.
|
|
|
|
If you have applications running on NuttX-4.14, those applications
|
|
should continue to build and execute without problem on NuttX-5.0.
|
|
However, if you have device drivers or other OS-internal logic, you
|
|
will probably have to make some minor changes to your code to use
|
|
this version. Below is a summary of those changes:
|
|
|
|
* If you include sys/types.h to get the non-standard, fixed width
|
|
integer types (uint32, uint16, ubyte, etc.), that is no longer
|
|
necessary.
|
|
* Instead, you will need to include stdint.h where the new fixed
|
|
width integer types are defined (uint32_t, uint16_t, uint8_t, etc).
|
|
* You will have to change all occurrences of the following types:
|
|
|
|
uint32 -> uint32_t
|
|
uint16 -> uint16_t
|
|
ubyte -> uint8_t
|
|
uint8 -> uint8_t
|
|
sint32 -> int32_t
|
|
sint16 -> int16_t
|
|
sint8 -> int8_t
|
|
|
|
* In addition, the non-standard type 'boolean' must replaced with
|
|
the standard type 'bool'. The type definition for 'bool' is in
|
|
stdbool.h
|
|
|
|
This change in typing caused small changes to many, many files. It
|
|
was verified that all configurations in the release still build
|
|
correctly (other than the SDCC-based configurations). Regression
|
|
testing was performed on a few configurations, but it is possible
|
|
that minor build issues still exist. (If you encounter any, please
|
|
let me know and I will help you to fix them.)
|
|
|
|
In the course of the regression testing, several important bugs
|
|
unrelated to the type changes were found and corrected.
|
|
|
|
* Fixed an important error in the RX FIFO handling logic of the
|
|
LM3S6918 Ethernet driver.
|
|
* Corrected the handling of TCP sequence numbers in the TCP stack.
|
|
* And other less important bugs as detailed in the ChangeLog.
|
|
|
|
The primary focus of this release was standards compatibility, but
|
|
a few new features were added including a (1) Flash Translation
|
|
Layer (FTL) that will support filesystems on a FLASH device and (2)
|
|
partial ports for the STM32F107VC and HCS12 C9S12NE64 MCUs. Those
|
|
ports are very incomplete as of this writing.
|
|
|
|
This tarball contains a complete CVS snapshot from December 21, 2009
|