system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-10-04 15:40:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

sys/README.md: Add a section for documentation

Browse source 
Add web links to intro(9) and the Architecture Handbook.

Reviewed by:	lwhsu, emaste
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D41253
This commit is contained in:
Mitchell Horne 2023-08-03 10:48:17 -03:00
parent 84f9f2c5cf
commit 32e47f6272
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
sys/README.md
View file

@ -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 |