diff --git a/README.md b/README.md index 31939e2b0fff..63f4b47f1a84 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,41 @@ FreeBSD Source: --------------- This is the top level of the FreeBSD source directory. FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms. A large community has continually developed it for more than thirty years. Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices. For copyright information, please see [the file COPYRIGHT](COPYRIGHT) in this directory. Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information. The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree. See build(7), config(8), [FreeBSD handbook on building userland](https://docs.freebsd.org/en/books/handbook/cutting-edge/#makeworld), and [Handbook for kernels](https://docs.freebsd.org/en/books/handbook/kernelconfig/) for more information, including setting make(1) variables. Source Roadmap: --------------- | Directory | Description | | --------- | ----------- | | bin | System/user commands. | | cddl | Various commands and libraries under the Common Development and Distribution License. | | contrib | Packages contributed by 3rd parties. | | crypto | Cryptography stuff (see [crypto/README](crypto/README)). | | etc | Template files for /etc. | | gnu | Commands and libraries under the GNU General Public License (GPL) or Lesser General Public License (LGPL). Please see [gnu/COPYING](gnu/COPYING) and [gnu/COPYING.LIB](gnu/COPYING.LIB) for more information. | | include | System include files. | | kerberos5 | Kerberos5 (Heimdal) package. | | lib | System libraries. | | libexec | System daemons. | | release | Release building Makefile & associated tools. | | rescue | Build system for statically linked /rescue utilities. | | sbin | System commands. | | secure | Cryptographic libraries and commands. | | share | Shared resources. | | stand | Boot loader 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. | | usr.bin | User commands. | | usr.sbin | System administration commands. | For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see [FreeBSD Handbook](https://docs.freebsd.org/en/books/handbook/cutting-edge/#current-stable). diff --git a/sys/README.md b/sys/README.md index edd30f39d313..ad7ff9efa578 100644 --- a/sys/README.md +++ b/sys/README.md @@ -1,44 +1,49 @@ 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. +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. + Source Roadmap: --------------- | Directory | Description | | --------- | ----------- | | 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 | | dev | device drivers | | gdb | kernel remote GDB stub - `gdb(4)` | | geom | GEOM framework - `geom(4)` | | i386 | i386 (32-bit x86) architecture support | | kern | main part of the kernel | | 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)` | | sys | kernel headers | | tests | kernel unit tests | | ufs | Unix File System - `ffs(7)` | | vm | virtual memory system | | x86 | code shared by AMD64 and i386 architectures |