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
81 lines
3.6 KiB
ReStructuredText
81 lines
3.6 KiB
ReStructuredText
===============
|
|
Network Support
|
|
===============
|
|
|
|
``net`` Directory Structure ::
|
|
|
|
nuttx/
|
|
|
|
|
`- net/
|
|
|
|
|
+- arp - Address resolution protocol (IPv4)
|
|
+- bluetooth - PF_BLUETOOTH socket interface
|
|
+- can - SocketCAN
|
|
+- devif - Stack/device interface layer
|
|
+- icmp - Internet Control Message Protocol (IPv4)
|
|
+- icmpv6 - Internet Control Message Protocol (IPv6)
|
|
+- ieee802154 - PF_IEEE802154 socket interface
|
|
+- igmp - IGMPv2 client
|
|
+- inet - PF_INET/PF_INET6 socket interface
|
|
+- ipforward - IP forwarding logic
|
|
+- ipfrag - Fragmentation and reassembly
|
|
+- local - Unix domain (local) sockets
|
|
+- mld - Multicast Listener Discovery (MLD)
|
|
+- nat - Network Address Translation (NAT)
|
|
+- neighbor - Neighbor Discovery Protocol (IPv6)
|
|
+- netdev - Socket network device interface
|
|
+- netfilter - Iptables Interface
|
|
+- netlink - Netlink IPC socket interface
|
|
+- pkt - "Raw" packet socket support
|
|
+- procfs - net devices PROCFS support
|
|
+- route - Routing table support
|
|
+- rpmsg - Rpmsg domain (remote) sockets
|
|
+- sixlowpan - 6LoWPAN implementation
|
|
+- socket - BSD socket interface
|
|
+- tcp - Transmission Control Protocol
|
|
+- udp - User Datagram Protocol
|
|
+- usrsock - User socket API for user-space networking stack
|
|
`- utils - Miscellaneous utility functions
|
|
|
|
+-------------------------------------------------------------------++------------------------+
|
|
| Application layer || usrsock daemon |
|
|
+-------------------------------------------------------------------++------------------------+
|
|
+-------------------------------------------------------------------++----------------+ +-----+
|
|
| Socket layer (socket/) || /dev/usrsock | | |
|
|
+-------------------------------------------------------------------++----------------+ | |
|
|
+------------++--------------------------------------------------++-------------------+ | |
|
|
| Network || Protocol stacks (arp, ipv6, icmp, pkt, tcp, udp) || usrsock/ | | |
|
|
| Device |+--------------------------------------------------++-------------------+ | |
|
|
| Interface |+------------------------------------++---------------------------------+ | |
|
|
| (netdev/) || Network Device Interface (devif/) || Utilities | | |
|
|
+------------++------------------------------------++---------------------------------+ | |
|
|
+----------------------------------------------------------------+ | |
|
|
| Network Device Drivers | | HAL |
|
|
+----------------------------------------------------------------+ +-----+
|
|
+----------------------------------------------------------------+ +--------------------------+
|
|
| Networking Hardware | | Hardware TCP/IP Stack |
|
|
+----------------------------------------------------------------+ +--------------------------+
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
sixlowpan.rst
|
|
socketcan.rst
|
|
pkt.rst
|
|
ipfilter.rst
|
|
nat.rst
|
|
netdev.rst
|
|
netdriver.rst
|
|
mdio.rst
|
|
netguardsize.rst
|
|
netlink.rst
|
|
slip.rst
|
|
wqueuedeadlocks.rst
|
|
tcp_network_perf.rst
|
|
delay_act_and_tcp_perf.rst
|
|
tcp_state_machine.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
newreno.rst
|