From nobody Mon Sep 11 22:44:22 2023 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Rl1x31q2vz4sZpR; Mon, 11 Sep 2023 22:44:23 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Rl1x31Q5pz4Hg6; Mon, 11 Sep 2023 22:44:23 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1694472263; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=HwYLTUD3xGsOnRCxL76+4jhI7WWRIp1dsXEu+OxnW4o=; b=harB1TQqkZ1VvS9xqjjoubaGCGw0RSEkSMdpyftymbkLxoyZcDNxyb0OWRqL0cjeKIdW3S RNGv0ZDq/aVwZSPfYDwcXraAujHdfAJlZlvX252Bgbg01f9JvvZ5wmj2pSrK9BIZinqqK3 oiYpO/2dkV3efghXscbevSjnf018ic7i2+f5ljJcGiVrTzNm6h5WAwwnyVC4mZjLBZphGb RreZT46BoxHVZScSwHcj9faiV6/qSNbl49y9rIxotWcuH1nkOjKPbIsMpe7iNm1kM0aVXY cF5UhJiE0NH7Q199xzR7HIWMzBaGMr00wTpPs9nZAryjl5wE9PalH37GasDlUQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1694472263; a=rsa-sha256; cv=none; b=VxB8AExmOu+AFHU1rekloIlqMP/EWnj1wbYas+bgIOdVrS5jhWfH/mY1JIo967mJauaZ72 qG8bE3psSWMmHSngGvFoEMZglrW/wb6Vw6Vw8zF6vVd2yBUYsyhmKRY921kJQijvy7qykN oBP1f4vLuUPNHHT/4pxeZPIJdh1PdKJ884Lo99QL3wczGL4SaOd1E3aiOh88v/xpc17uYl naa6P0VF1VFCw92gr+JMWVMJ8hO0Tn1OVRL/sJErdgL3eTMqmuGYplr1gVPcAJcCjkLxBx CoP7aBKfVJsmpfyHVb+6IPw6DWrS60zsh9HKGF/mtPCXWHCUbiMD4oUbjXSYqA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1694472263; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=HwYLTUD3xGsOnRCxL76+4jhI7WWRIp1dsXEu+OxnW4o=; b=PZhX/2yOyh6ibfh8nTcW+ItAamUTDyWmSjPYBC6cgh1hgtWX9+R1kfAqwAofsLXC+kCoW8 e81fMEqd240mRf4CFZU/5sTt84RWSzsnINrY912hevIb9YpLJ/cPgXfnuLrXv12+qMKGSP 5njKtthYV95Ik5y0rurNqVmUmDabpsAKJl5tbwv6tJlrrm1GlknBQ/DgTrFGuhvcUn2Ltp 51JgmbX/2HjPpu40lAzl/PgJY7Jg3RGSXMK8vlajQylUBebzkKa/6PpGzom/0n81h2I5PT ErVIt+E+10mQa+/u0tqKYxknl0TvDpm/WRmYVxSAmEoB4n8fLIZwa/me1ZLgCA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Rl1x30Vh1z16PL; Mon, 11 Sep 2023 22:44:23 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 38BMiMU7073848; Mon, 11 Sep 2023 22:44:22 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 38BMiMN4073845; Mon, 11 Sep 2023 22:44:22 GMT (envelope-from git) Date: Mon, 11 Sep 2023 22:44:22 GMT Message-Id: <202309112244.38BMiMN4073845@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mitchell Horne Subject: git: aa26195de58d - stable/13 - sys/README.md: Add a section for documentation List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: mhorne X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: aa26195de58d6dc8e3d989ec50f1c5934c3f0e22 Auto-Submitted: auto-generated The branch stable/13 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=aa26195de58d6dc8e3d989ec50f1c5934c3f0e22 commit aa26195de58d6dc8e3d989ec50f1c5934c3f0e22 Author: Mitchell Horne AuthorDate: 2023-08-03 13:48:17 +0000 Commit: Mitchell Horne CommitDate: 2023-09-11 22:40:33 +0000 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 (cherry picked from commit 32e47f62724e6cce2df0bc69d6ceba2d058d3585) --- sys/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/sys/README.md b/sys/README.md index ad7ff9efa578..5836ade3deaa 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 |