d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c650e19495
freebsd-dev/sys/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

50 lines
2.2 KiB
Markdown
Raw Normal View History

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
2022-11-01 15:12:14 +00:00
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.
README.md: shift description of kernel config files Document it in sys/README.md instead. Describe the purpose of LINT config files as well. Reviewed by: imp MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D37134
2022-11-01 15:14:41 +00:00
Kernel configuration files are located in the `conf/` subdirectory of each
architecture. `GENERIC` is the configuration used in release builds. `NOTES`
contains documentation of all possible entries. `LINT` is a compile-only
configuration used to maximize build coverage and detect regressions.
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
2022-11-01 15:12:14 +00:00
Source Roadmap:
---------------
| Directory | Description |
| --------- | ----------- |
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
2022-11-01 15:13:31 +00:00
| amd64 | AMD64 (64-bit x86) architecture support |
| arm | 32-bit ARM architecture support |
| arm64 | 64-bit ARM (AArch64) architecture support |
| cam | Common Access Method storage subsystem - `cam(4)` and `ctl(4)` |
| cddl | CDDL-licensed optional sources such as DTrace |
| conf | kernel build glue |
| compat | Linux compatibility layer, FreeBSD 32-bit compatibility |
| contrib | 3rd-party imported software such as OpenZFS |
| crypto | crypto drivers |
| ddb | interactive kernel debugger - `ddb(4)` |
| fs | most filesystems, excluding UFS, NFS, and ZFS |
note that some arch independent code can live in dev (e.g. SMBios)
2023-03-03 09:54:07 +00:00
| dev | device drivers and other arch independent code |
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
2022-11-01 15:13:31 +00:00
| gdb | kernel remote GDB stub - `gdb(4)` |
| geom | GEOM framework - `geom(4)` |
| i386 | i386 (32-bit x86) architecture support |
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
2022-11-01 15:12:14 +00:00
| kern | main part of the kernel |
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
2022-11-01 15:13:31 +00:00
| libkern | libc-like and other support functions for kernel use |
| modules | kernel module infrastructure |
| net | core networking code |
| net80211 | wireless networking (IEEE 802.11) - `net80211(4)` |
| netgraph | graph-based networking subsystem - `netgraph(4)` |
| netinet | IPv4 protocol implementation - `inet(4)` |
| netinet6 | IPv6 protocol implementation - `inet6(4)` |
| netipsec | IPsec protocol implementation - `ipsec(4)` |
| netpfil | packet filters - `ipfw(4)`, `pf(4)`, and `ipfilter(4)` |
| opencrypto | OpenCrypto framework - `crypto(7)` |
| powerpc | PowerPC/POWER (32 and 64-bit) architecture support |
| riscv | 64-bit RISC-V architecture support |
| security | security facilities - `audit(4)` and `mac(4)` |
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
2022-11-01 15:12:14 +00:00
| sys | kernel headers |
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
2022-11-01 15:13:31 +00:00
| tests | kernel unit tests |
| ufs | Unix File System - `ffs(7)` |
| vm | virtual memory system |
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
2022-11-01 15:12:14 +00:00
| x86 | code shared by AMD64 and i386 architectures |
Reference in New Issue Copy Permalink