Skip to content

Commit d1087fe

Browse files
committed
Create sys/README.md
Add this primarily to document the sys/ subdirectories of the source tree. This is a straight copy from the contents of hier(7). Improvements will follow in other changes. Reviewed by: imp, emaste MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D37132
1 parent 6547498 commit d1087fe

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Source Roadmap:
3232
| secure | Cryptographic libraries and commands. |
3333
| share | Shared resources. |
3434
| stand | Boot loader sources. |
35-
| sys | Kernel sources. |
35+
| sys | Kernel sources (see [sys/README.md](sys/README.md)). |
3636
| sys/`arch`/conf | Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries. |
3737
| tests | Regression tests which can be run by Kyua. See [tests/README](tests/README) for additional information. |
3838
| tools | Utilities for regression testing and miscellaneous tasks. |

sys/README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
FreeBSD Kernel Source:
2+
----------------------
3+
4+
This directory contains the source files and build glue that make up the FreeBSD
5+
kernel and its modules, including both original and contributed software.
6+
7+
Source Roadmap:
8+
---------------
9+
| Directory | Description |
10+
| --------- | ----------- |
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 |
18+
| dev | device drivers |
19+
| geom | `geom(4)` |
20+
| i386 | i386 (32 bit) architecture support |
21+
| 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)` |
32+
| sys | kernel headers |
33+
| ufs | Unix File System |
34+
| x86 | code shared by AMD64 and i386 architectures |

0 commit comments

Comments
 (0)