aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWarner Losh <imp@FreeBSD.org>2022-01-02 07:30:37 +0000
committerWarner Losh <imp@FreeBSD.org>2022-01-02 07:30:58 +0000
commite0281204cce3d309b9aa390c0bcb2b1ab7bf2606 (patch)
treec2fe70b550871776abc6766e4f291c7851229067
parenta115a4aa51ae891330c9c4404dd4df13b601556f (diff)
downloadsrc-e0281204cce3d309b9aa390c0bcb2b1ab7bf2606.tar.gz
src-e0281204cce3d309b9aa390c0bcb2b1ab7bf2606.zip
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
-rw-r--r--share/mk/bsd.opts.mk5
-rw-r--r--share/mk/src.opts.mk4
-rw-r--r--sys/conf/kern.opts.mk5
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