Date: Mon, 5 Dec 2022 16:47:31 GMT From: Mitchell Horne <mhorne@FreeBSD.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org Subject: git: b548d985de15 - stable/13 - Create sys/README.md Message-ID: <202212051647.2B5GlVXa053786@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch stable/13 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=b548d985de157c03dbdb311b672af13df9ee405b commit b548d985de157c03dbdb311b672af13df9ee405b Author: Mitchell Horne <mhorne@FreeBSD.org> AuthorDate: 2022-11-01 15:12:14 +0000 Commit: Mitchell Horne <mhorne@FreeBSD.org> CommitDate: 2022-12-05 16:32:19 +0000 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 (cherry picked from commit d1087fe8436dbe369b218854fffe901ccc7602c1) --- README.md | 2 +- sys/README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e4c56babb448..cfb292ad9242 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Source Roadmap: | secure | Cryptographic libraries and commands. | | share | Shared resources. | | stand | Boot loader sources. | -| sys | Kernel sources. | +| sys | Kernel sources (see [sys/README.md](sys/README.md)). | | sys/`arch`/conf | Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries. | | tests | Regression tests which can be run by Kyua. See [tests/README](tests/README) for additional information. | | tools | Utilities for regression testing and miscellaneous tasks. | diff --git a/sys/README.md b/sys/README.md new file mode 100644 index 000000000000..398281752cab --- /dev/null +++ b/sys/README.md @@ -0,0 +1,34 @@ +FreeBSD Kernel Source: +---------------------- + +This directory contains the source files and build glue that make up the FreeBSD +kernel and its modules, including both original and contributed software. + +Source Roadmap: +--------------- +| Directory | Description | +| --------- | ----------- | +| amd64 | AMD64 architecture support | +| arm | ARM architecture support | +| arm64 | ARMv8 architecture support | +| cam | `cam(4)` and `ctl(4)` | +| cddl | CDDL-licensed optional sources, including ZFS and DTrace | +| ddb | `ddb(4)` | +| fs | most filesystems | +| dev | device drivers | +| geom | `geom(4)` | +| i386 | i386 (32 bit) architecture support | +| kern | main part of the kernel | +| net80211 | `net80211(4)` | +| netgraph | `netgraph(4)` | +| netinet | `inet(4)` | +| netinet6 | `inet6(4)` | +| netipsec | `ipsec(4)` | +| netpfil | `ipfw(4)` and `pf(4)` | +| opencrypto | `crypto(7)` | +| powerpc | PowerPC/POWER architecture support | +| riscv | RISC-V architecture support | +| security | `audit(4)` and `mac(4)` | +| sys | kernel headers | +| ufs | Unix File System | +| x86 | code shared by AMD64 and i386 architectures |
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202212051647.2B5GlVXa053786>