From nobody Thu Aug 3 14:08:11 2023 X-Original-To: dev-commits-src-main@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 4RGrKR5L4nz2ttbR; Thu, 3 Aug 2023 14:08:11 +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 4RGrKR3XQ3z4F0n; Thu, 3 Aug 2023 14:08:11 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1691071691; 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=Qlz8zHX/zKZJ7tCwweiL1Tm18mj6HhlJuFcWY64JdsA=; b=RKW5yGEi/623jkJ+j4lYfngK/lWtzN1WXlJ0zzQhF+zqp8ArYmptOtuusPAvv+Se+EZIcU or9tgwyEtHaM/9XLyRBf8V7W4lOfim8qxHj0mijEjSjgFEdhjiHQUTCqhPdjeDALn0MILk ns31ejYf5UNVHM0BbCopbwnuK0OH1b57Pb9Hs4qYI5xRdQYZMpZrKpR2LpztaYnTXjzxSU +YvdoZNvD/x5s6+UNSb0XiJ4Lku5SpgXe/JaIwoBTfjYIwGWPNrIBR5k3+L6PV+1x2qW/q 2OG0Hu9Z00YvdWSRdt1qNVaBkSb0B/2DPHaWPRQuaHjYRh7W8dxREpj54rvk9w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1691071691; 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=Qlz8zHX/zKZJ7tCwweiL1Tm18mj6HhlJuFcWY64JdsA=; b=DY2rfTvdUfoQ7NSP9D0a6ktdkWyiZ6CUVAd/YAM8hhv3PYDRNs4eTyPO6l9YbHSkrWSCGW aWZYUB9Sbc+IDd0P3YPJDfe/pYASpSccYpIZOfoEKQV75oqk40Yt0DXHbVQ1u9g8OGc24B xQ/AZGY0Qt+lMpLZWrWfXTfpIYAGSYLciTv8De3hb3/X5At0ZuHhKC+ECfiBp6I9S7kDuv PKx+75Zbh+aFzm+BvrtrIFiGHZUk3OJbGz0eneay/s8TbYAMUNp8AmbAg1t7Ikx8WibWl2 oA8Q9zocUT2VAuHJKLjcNHNbB+0tBi03iqij0UjLy2SvZ4oSBoRMHFeqqpmxvg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1691071691; a=rsa-sha256; cv=none; b=sQLvpIjk9vk/TVyJKD8S4e6b9ddlOCHUycWA4qb1uVAWd5TnOUY78uzQl8bRQHXOG+lkXU kK+ORDyVKPc2WG4JRvz85PgctZvsdtMenUAk3Q4IFth3WrXCMkpIi1StQy05pDeWmVFvAu 5vkl2gvSNDYjFJuc1r3U7JLJzyDqCp9p2ADD9/C3e4+v3o1L+VSG6skjE8b0QfZc0bogYH XXuBNhSL3S/aZyN8ovVDpDaW0HfHHk570WX8B36Twbzplp9uLWMhGOGMdE92LS8smcV2vg Y4FP4Q7jJ/YkPBZn6Mr5YnUPqkAZu2zCTHdDaqLInOjjwP/i4q/7iGDgv/JzhQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4RGrKR2fCXz7tT; Thu, 3 Aug 2023 14:08:11 +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 373E8Bc5091506; Thu, 3 Aug 2023 14:08:11 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 373E8B0R091505; Thu, 3 Aug 2023 14:08:11 GMT (envelope-from git) Date: Thu, 3 Aug 2023 14:08:11 GMT Message-Id: <202308031408.373E8B0R091505@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mitchell Horne Subject: git: 32e47f62724e - main - sys/README.md: Add a section for documentation List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@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/main X-Git-Reftype: branch X-Git-Commit: 32e47f62724e6cce2df0bc69d6ceba2d058d3585 Auto-Submitted: auto-generated The branch main has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=32e47f62724e6cce2df0bc69d6ceba2d058d3585 commit 32e47f62724e6cce2df0bc69d6ceba2d058d3585 Author: Mitchell Horne AuthorDate: 2023-08-03 13:48:17 +0000 Commit: Mitchell Horne CommitDate: 2023-08-03 14:07:41 +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 --- sys/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) 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 |