From nobody Sun Jan 02 07:31:33 2022 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 818CB1916FF4; Sun, 2 Jan 2022 07:31:34 +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 4JRVtZ14Xsz3L9h; Sun, 2 Jan 2022 07:31:34 +0000 (UTC) (envelope-from git@FreeBSD.org) 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 0515461B1; Sun, 2 Jan 2022 07:31:34 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 2027VXq4032882; Sun, 2 Jan 2022 07:31:33 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2027VXkX032881; Sun, 2 Jan 2022 07:31:33 GMT (envelope-from git) Date: Sun, 2 Jan 2022 07:31:33 GMT Message-Id: <202201020731.2027VXkX032881@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Warner Losh Subject: git: e0281204cce3 - main - Add clarifying comments 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: imp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e0281204cce3d309b9aa390c0bcb2b1ab7bf2606 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1641108694; 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=UWW5EAAeKAdpPwwvySZRENq5iNsKhpORQFkDGGsGa/A=; b=rzvAf8Xn7sbN3ROhHYBDCVN1WTeVeTiPaOW268O6e3oBKNib8lMNEXY8wkFBiLfeyuuYBe 7LpMe3Z4zG0P1vBRdmC3CZf5aDgGYhpUSidbb61NLY5ZhkYqBu8IR+BXOEKz302PCxARGv 10zHLWg537YrBpMonmyr5L8lvhrSkMW0X3uokeuUYClql+ouTKc8GFWxFgj4EqEo0JhIge SPMi71C4KpiBrAUVNtWoREmkCMqBAT95cm04XrlnjYIOLeVbxN753f5DyM5ahTiKgZhv16 B3wS2vPEF78Han3bZJodyMODSdK4B4Ck84Yz+UOxg/ey+ykg++wM69B1Oa72NQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1641108694; a=rsa-sha256; cv=none; b=lTucJ5ubpnexKSB/Y/rBDrTLKGjZv/iCTk4sgF334bEpSkXBzsWLOABZQsSNIQ4K4wF1vZ aOxG4QGxz10TWisNO0us7ZP32xLINxwpQ9QhbB9ukswzjiq+NIaAyhMvalXruU4L48F5wT QG7JW9SioXAiUcQ7wOxLGHVmktJRxxgBqn8miX8YkxnnzgDIDxfvW3FxaIUcwsKSTrEqnZ KmrDQIIjXz8GfuuZALCJhhGXVva6hGT4+KwG1uCBW06FLbE+QUtt3VF1mS6KOWqKJRNH8z dWvwqHJya/YTaxcgXy0jRIadCy3amEflb+IgQ1Gl0s0/I0XG0MdusoIC/vmf1A== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=e0281204cce3d309b9aa390c0bcb2b1ab7bf2606 commit e0281204cce3d309b9aa390c0bcb2b1ab7bf2606 Author: Warner Losh AuthorDate: 2022-01-02 07:30:37 +0000 Commit: Warner Losh 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