Skip to content

Commit 3970133

Browse files
committed
sys/README.md: source roadmap improvements
Tweak the existing descriptions slightly. Add entries for several directories which are not yet documented, but not exhaustively. Reviewed by: imp (previous version), emaste MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D37133
1 parent d1087fe commit 3970133

File tree

1 file changed

+30
-20
lines changed

1 file changed

+30
-20
lines changed

sys/README.md

+30-20
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,37 @@ Source Roadmap:
88
---------------
99
| Directory | Description |
1010
| --------- | ----------- |
11-
| amd64 | AMD64 architecture support |
12-
| arm | ARM architecture support |
13-
| arm64 | ARMv8 architecture support |
14-
| cam | `cam(4)` and `ctl(4)` |
15-
| cddl | CDDL-licensed optional sources, including ZFS and DTrace |
16-
| ddb | `ddb(4)` |
17-
| fs | most filesystems |
11+
| amd64 | AMD64 (64-bit x86) architecture support |
12+
| arm | 32-bit ARM architecture support |
13+
| arm64 | 64-bit ARM (AArch64) architecture support |
14+
| cam | Common Access Method storage subsystem - `cam(4)` and `ctl(4)` |
15+
| cddl | CDDL-licensed optional sources such as DTrace |
16+
| conf | kernel build glue |
17+
| compat | Linux compatibility layer, FreeBSD 32-bit compatibility |
18+
| contrib | 3rd-party imported software such as OpenZFS |
19+
| crypto | crypto drivers |
20+
| ddb | interactive kernel debugger - `ddb(4)` |
21+
| fs | most filesystems, excluding UFS, NFS, and ZFS |
1822
| dev | device drivers |
19-
| geom | `geom(4)` |
20-
| i386 | i386 (32 bit) architecture support |
23+
| gdb | kernel remote GDB stub - `gdb(4)` |
24+
| geom | GEOM framework - `geom(4)` |
25+
| i386 | i386 (32-bit x86) architecture support |
2126
| kern | main part of the kernel |
22-
| net80211 | `net80211(4)` |
23-
| netgraph | `netgraph(4)` |
24-
| netinet | `inet(4)` |
25-
| netinet6 | `inet6(4)` |
26-
| netipsec | `ipsec(4)` |
27-
| netpfil | `ipfw(4)` and `pf(4)` |
28-
| opencrypto | `crypto(7)` |
29-
| powerpc | PowerPC/POWER architecture support |
30-
| riscv | RISC-V architecture support |
31-
| security | `audit(4)` and `mac(4)` |
27+
| libkern | libc-like and other support functions for kernel use |
28+
| modules | kernel module infrastructure |
29+
| net | core networking code |
30+
| net80211 | wireless networking (IEEE 802.11) - `net80211(4)` |
31+
| netgraph | graph-based networking subsystem - `netgraph(4)` |
32+
| netinet | IPv4 protocol implementation - `inet(4)` |
33+
| netinet6 | IPv6 protocol implementation - `inet6(4)` |
34+
| netipsec | IPsec protocol implementation - `ipsec(4)` |
35+
| netpfil | packet filters - `ipfw(4)`, `pf(4)`, and `ipfilter(4)` |
36+
| opencrypto | OpenCrypto framework - `crypto(7)` |
37+
| powerpc | PowerPC/POWER (32 and 64-bit) architecture support |
38+
| riscv | 64-bit RISC-V architecture support |
39+
| security | security facilities - `audit(4)` and `mac(4)` |
3240
| sys | kernel headers |
33-
| ufs | Unix File System |
41+
| tests | kernel unit tests |
42+
| ufs | Unix File System - `ffs(7)` |
43+
| vm | virtual memory system |
3444
| x86 | code shared by AMD64 and i386 architectures |

0 commit comments

Comments
 (0)