From 32e47f62724e6cce2df0bc69d6ceba2d058d3585 Mon Sep 17 00:00:00 2001 From: Mitchell Horne Date: Thu, 3 Aug 2023 10:48:17 -0300 Subject: [PATCH] sys/README.md: Add a section for documentation 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 --- sys/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/sys/README.md b/sys/README.md index 77db5026eff..10c9f183f7e 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 |