Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 1 Nov 2022 15:24:55 GMT
From:      Mitchell Horne <mhorne@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org
Subject:   git: 9e0dcd0ab296 - main - README.md: shift description of kernel config files
Message-ID:  <202211011524.2A1FOtW8087931@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch main has been updated by mhorne:

URL: https://cgit.FreeBSD.org/src/commit/?id=9e0dcd0ab296ddcdee60a4952435175ae3f7bdb3

commit 9e0dcd0ab296ddcdee60a4952435175ae3f7bdb3
Author:     Mitchell Horne <mhorne@FreeBSD.org>
AuthorDate: 2022-11-01 15:14:41 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2022-11-01 15:20:55 +0000

    README.md: shift description of kernel config files
    
    Document it in sys/README.md instead. Describe the purpose of LINT
    config files as well.
    
    Reviewed by:    imp
    MFC after:      1 month
    Sponsored by:   The FreeBSD Foundation
    Differential Revision:  https://reviews.freebsd.org/D37134
---
 README.md     | 1 -
 sys/README.md | 5 +++++
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 31939e2b0fff..63f4b47f1a84 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,6 @@ Source Roadmap:
 | share | Shared resources. |
 | stand | Boot loader sources. |
 | sys | Kernel sources (see [sys/README.md](sys/README.md)). |
-| sys/`arch`/conf | Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries. |
 | tests | Regression tests which can be run by Kyua.  See [tests/README](tests/README) for additional information. |
 | tools | Utilities for regression testing and miscellaneous tasks. |
 | usr.bin | User commands. |
diff --git a/sys/README.md b/sys/README.md
index edd30f39d313..ad7ff9efa578 100644
--- a/sys/README.md
+++ b/sys/README.md
@@ -4,6 +4,11 @@ FreeBSD Kernel Source:
 This directory contains the source files and build glue that make up the FreeBSD
 kernel and its modules, including both original and contributed software.
 
+Kernel configuration files are located in the `conf/` subdirectory of each
+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.
+
 Source Roadmap:
 ---------------
 | Directory | Description |



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202211011524.2A1FOtW8087931>