git: e0281204cce3 - main - Add clarifying comments

From: Warner Losh <imp_at_FreeBSD.org>
Date: Sun, 02 Jan 2022 07:31:33 UTC
The branch main has been updated by imp:

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

commit e0281204cce3d309b9aa390c0bcb2b1ab7bf2606
Author:     Warner Losh <imp@FreeBSD.org>
AuthorDate: 2022-01-02 07:30:37 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2022-01-02 07:30:58 +0000

    Add clarifying comments
    
    Expand on the terse comments for where each of these files is used.
    
    Reviewed by:            emaste
    Sponsored by:           Netflix
    Differential Revision:  https://reviews.freebsd.org/D33716
---
 share/mk/bsd.opts.mk  | 5 ++++-
 share/mk/src.opts.mk  | 4 +++-
 sys/conf/kern.opts.mk | 5 ++++-
 3 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/share/mk/bsd.opts.mk b/share/mk/bsd.opts.mk
index 2504e5038d6e..68de435ef358 100644
--- a/share/mk/bsd.opts.mk
+++ b/share/mk/bsd.opts.mk
@@ -1,6 +1,9 @@
 # $FreeBSD$
 #
-# Option file for src builds.
+# Option file for bmake builds. These options are available to all users of
+# bmake (including the source tree userland and kernel builds). They generally
+# control how binaries are made, shared vs dynamic, etc and some general options
+# relevant for all build environments.
 #
 # Users define WITH_FOO and WITHOUT_FOO on the command line or in /etc/src.conf
 # and /etc/make.conf files. These translate in the build system to MK_FOO={yes,no}
diff --git a/share/mk/src.opts.mk b/share/mk/src.opts.mk
index 806b2a4a9768..02515f8ff66f 100644
--- a/share/mk/src.opts.mk
+++ b/share/mk/src.opts.mk
@@ -1,6 +1,8 @@
 # $FreeBSD$
 #
-# Option file for FreeBSD /usr/src builds.
+# Option file for FreeBSD /usr/src builds, at least the userland and boot loader
+# portions of the tree. These options generally chose what parts of the tree to
+# include or omit and are FreeBSD source tree specific.
 #
 # Users define WITH_FOO and WITHOUT_FOO on the command line or in /etc/src.conf
 # and /etc/make.conf files. These translate in the build system to MK_FOO={yes,no}
diff --git a/sys/conf/kern.opts.mk b/sys/conf/kern.opts.mk
index 20c6b4153d11..532c282edc34 100644
--- a/sys/conf/kern.opts.mk
+++ b/sys/conf/kern.opts.mk
@@ -1,6 +1,9 @@
 # $FreeBSD$
 
-# Options set in the build system that affect the kernel somehow.
+# Options set in the build system which affect the building of kernel
+# modules. These select which parts to compile in or out (eg INET) or which
+# parts to omit (eg CDDL or SOURCELESS_HOST). Some of these will cause
+# config.mk to define symbols in various opt_*.h files.
 
 #
 # Define MK_* variables (which are either "yes" or "no") for users