mirror of
https://github.com/apache/nuttx.git
synced 2026-10-19 12:48:48 +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
50 lines
1.6 KiB
ReStructuredText
50 lines
1.6 KiB
ReStructuredText
====
|
|
SLIP
|
|
====
|
|
|
|
SLIP Configuration
|
|
==================
|
|
|
|
#. Configure and build NuttX with SLIP enabled in the configuration. Load this
|
|
into FLASH and start the device.
|
|
|
|
#. Connect to a Linux box using a serial cable. This discussion assumes that the
|
|
serial device is ``/dev/ttyS0`` on both the target and the Linux box.
|
|
|
|
#. Reset on the target side and attach SLIP on the Linux side:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ modprobe slip
|
|
$ slattach -L -p slip -s 57600 /dev/ttyS0 &
|
|
|
|
This should create an interface with a name like sl0, or sl1, etc. Add -d to
|
|
get debug output. This will show the interface name.
|
|
|
|
NOTE: The -L option is included to suppress use of hardware flow control.
|
|
This is necessary only if you are not supporting hardware flow control on
|
|
the target.
|
|
|
|
NOTE: The Linux slip module hard-codes its MTU size to 296. So you might
|
|
as well set ``CONFIG_NET_ETH_MTU`` to 296 as well.
|
|
|
|
#. After turning over the line to the SLIP driver, you must configure the
|
|
network interface. Again, you do this using the standard ifconfig and
|
|
route commands. Assume that we have connected to a host PC with address
|
|
192.168.0.101 from your target with address 10.0.0.2. On the Linux PC
|
|
you would execute the following as root (assuming the SLIP is attached
|
|
to device sl0):
|
|
|
|
.. code-block:: bash
|
|
|
|
$ ifconfig sl0 10.0.0.1 pointopoint 10.0.0.2 up
|
|
$ route add 10.0.0.2 dev sl0
|
|
|
|
#. For monitoring/debugging traffic:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ tcpdump -n -nn -i sl0 -x -X -s 1500
|
|
|
|
NOTE: If hardware handshake is not available, then you might try the
|
|
slattach option-L which is supposed to enable "3-wire operation."
|