diff options
| author | Mitchell Horne <mhorne@FreeBSD.org> | 2023-08-03 13:48:17 +0000 |
|---|---|---|
| committer | Mitchell Horne <mhorne@FreeBSD.org> | 2023-08-03 14:07:41 +0000 |
| commit | 32e47f62724e6cce2df0bc69d6ceba2d058d3585 (patch) | |
| tree | 05432fa4d8ad2f352ccc5143fd6e71825d563972 /sys/README.md | |
| parent | 84f9f2c5cf7841fffc03ccb1833814892ae15132 (diff) | |
| download | src-32e47f62724e6cce2df0bc69d6ceba2d058d3585.tar.gz src-32e47f62724e6cce2df0bc69d6ceba2d058d3585.zip | |
Diffstat (limited to 'sys/README.md')
| -rw-r--r-- | sys/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/sys/README.md b/sys/README.md index 77db5026eff3..10c9f183f7e1 100644 --- a/sys/README.md +++ b/sys/README.md @@ -9,6 +9,17 @@ 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. +Documentation: +-------------- + +Source code documentation is maintained in a set of man pages, under section 9. +These pages are located in [`share/man/man9`](../share/man/man9), from the +top-level of the src tree. Consult [`intro(9)`](https://man.freebsd.org/intro/9) +for an overview of existing pages. + +Some additional high-level documentation of the kernel is maintained in the +[Architecture Handbook](https://docs.freebsd.org/en/books/arch-handbook/). + Source Roadmap: --------------- | Directory | Description | |