Module Name: src
Committed By: lukem
Date: Sat Jul 22 18:50:04 UTC 2023
Modified Files:
src: BUILDING
src/doc: BUILDING.mdoc
Log Message:
BUILDING: list known mk.conf vars. tweak section headers
List known supported and obsolete mk.conf(5) variables,
so that searches in this document at least find them.
This partially reverts my revision 1.144 on 2023-06-12
which completely removed the duplication with mk.conf(5).
Remove quote characters from some section headings;
it makes it harder to search for a section by known name
when rendering in markup variations that use smart quotes.
To generate a diff of this commit:
cvs rdiff -u -r1.159 -r1.160 src/BUILDING
cvs rdiff -u -r1.148 -r1.149 src/doc/BUILDING.mdoc
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/BUILDING
diff -u src/BUILDING:1.159 src/BUILDING:1.160
--- src/BUILDING:1.159 Fri Jul 21 22:07:59 2023
+++ src/BUILDING Sat Jul 22 18:50:04 2023
@@ -169,7 +169,7 @@ CONFIGURATION
Default: "make".
- MAKECONF The name of the make(1) configuration file. See "make"
+ MAKECONF The name of the make(1) configuration file. See make
variables and mk.conf(5).
Note: Only settable in the process environment.
@@ -229,7 +229,7 @@ CONFIGURATION
Default: "/tmp".
- "make" variables
+ make variables
Variables that control the behavior of NetBSD builds are documented in
mk.conf(5) (whose mdoc(7) source is in share/man/man5/mk.conf.5).
@@ -246,8 +246,46 @@ CONFIGURATION
MAKEVERBOSE?=1
+ The supported mk.conf(5) make variables are:
+
+ BSDOBJDIR, BSDSRCDIR, BUILD, BUILDID, BUILDINFO, BUILDSEED,
+ CDEXTRA, CONFIGOPTS, COPTS, CPUFLAGS, DESTDIR, EXTERNAL_TOOLCHAIN,
+ INSTALLBOOT_BOARDS, INSTALLWORLDDIR, KERNARCHDIR, KERNCONFDIR,
+ KERNEL_DIR, KERNOBJDIR, KERNSRCDIR, LOCALTIME, MAKEVERBOSE,
+ MKAMDGPUFIRMWARE, MKARGON2, MKARZERO, MKATF, MKBINUTILS, MKBSDGREP,
+ MKBSDTAR, MKCATPAGES, MKCLEANSRC, MKCLEANVERIFY, MKCOMPAT,
+ MKCOMPATMODULES, MKCOMPATTESTS, MKCOMPATX11, MKCOMPLEX, MKCROSSGDB,
+ MKCTF, MKCVS, MKCXX, MKDEBUG, MKDEBUGKERNEL, MKDEBUGLIB,
+ MKDEBUGTOOLS, MKDEPINCLUDES, MKDOC, MKDTB, MKDTC, MKDTRACE,
+ MKDYNAMICROOT, MKFIRMWARE, MKGCC, MKGCCCMDS, MKGDB, MKGROFF,
+ MKGROFFHTMLDOC, MKHESIOD, MKHOSTOBJ, MKHTML, MKIEEEFP, MKINET6,
+ MKINFO, MKIPFILTER, MKISCSI, MKKERBEROS, MKKMOD, MKKYUA, MKLDAP,
+ MKLIBCSANITIZER, MKLIBCXX, MKLIBSTDCXX, MKLINKLIB, MKLINT, MKLLVM,
+ MKLLVMRT, MKLVM, MKMAKEMANDB, MKMAN, MKMANDOC, MKMANZ, MKMDNS,
+ MKNLS, MKNOUVEAUFIRMWARE, MKNPF, MKNSD, MKOBJ, MKOBJDIRS, MKPAM,
+ MKPCC, MKPF, MKPIC, MKPICINSTALL, MKPICLIB, MKPIE, MKPIGZGZIP,
+ MKPOSTFIX, MKPROFILE, MKRADEONFIRMWARE, MKRELRO, MKREPRO,
+ MKREPRO_TIMESTAMP, MKRUMP, MKSANITIZER, MKSHARE, MKSKEY, MKSLJIT,
+ MKSOFTFLOAT, MKSTATICLIB, MKSTATICPIE, MKSTRIPIDENT, MKSTRIPSYM,
+ MKTEGRAFIRMWARE, MKTPM, MKUNBOUND, MKUNPRIVED, MKUPDATE, MKX11,
+ MKX11FONTS, MKX11MOTIF, MKXORG_SERVER, MKYP, MKZFS, NETBSDSRCDIR,
+ NETBSD_OFFICIAL_RELEASE, NOCLEANDIR, NODISTRIBDIRS, NOINCLUDES,
+ OBJMACHINE, RELEASEDIR, RUMPUSER_THREADS, RUMP_CURLWP, RUMP_DEBUG,
+ RUMP_DIAGNOSTIC, RUMP_KTRACE, RUMP_LOCKDEBUG, RUMP_LOCKS_UP,
+ RUMP_NBCOMPAT, RUMP_VIRTIF, RUMP_VNODE_LOCKDEBUG,
+ TOOLCHAIN_MISSING, TOOLDIR, USETOOLS, USE_FORT, USE_HESIOD,
+ USE_INET6, USE_JEMALLOC, USE_KERBEROS, USE_LDAP, USE_LIBCSANITIZER,
+ USE_PAM, USE_PIGZGZIP, USE_SANITIZER, USE_SKEY, USE_SSP,
+ USE_XZ_SETS, USE_YP, X11MOTIFPATH, X11SRCDIR.
+
+ The obsolete mk.conf(5) make variables are:
+
+ EXTSRCSRCDIR, MKBFD, MKCRYPTO, MKEXTSRC, MKKDEBUG, MKKERBEROS4,
+ MKLLD, MKLLDB, MKMCLINKER, MKPERFUSE, MKTOOLSDEBUG, NBUILDJOBS,
+ SHAREDSTRINGS, USE_COMBINE, USE_NEW_TOOLCHAIN.
+
BUILDING
- "make" command line options
+ make command line options
This is not a summary of all the options available to make(1); only the
options used most frequently with NetBSD builds are listed here.
@@ -273,7 +311,7 @@ BUILDING
specified by the process environment, the MAKECONF
configuration file, or the system Makefile segments.
- "make" targets
+ make targets
These default targets may be built by running make(1) in any subtree of
the NetBSD source code. It is recommended that none of these be used
from the top level Makefile; as a specific exception, "make obj" and
@@ -315,7 +353,7 @@ BUILDING
tags Create ctags(1) searchable function lists usable by the ex(1)
and vi(1) text editors.
- "make" targets for the top level
+ make targets for the top level
Additional make(1) targets are usable specifically from the top source
level to facilitate building the entire NetBSD source tree.
@@ -467,7 +505,7 @@ BUILDING
target should probably run those as well but currently does
not.
- The "build.sh" script
+ The build.sh script
This script file is a shell script designed to build the entire NetBSD
system on any host with a suitable modern shell and some common
utilities. The required shell features are described under the HOST_SH
@@ -781,7 +819,7 @@ BUILDING
-? Show a help message, and exit.
- The "nbmake-MACHINE" wrapper script
+ The nbmake-MACHINE wrapper script
If using the build.sh script to build NetBSD, a nbmake-MACHINE wrapper
script will be created in TOOLDIR/bin upon the first build to assist in
building subtrees on a cross-compile host.
@@ -791,8 +829,8 @@ BUILDING
TOOLDIR/bin with several key variables pre-set, including MACHINE,
MACHINE_ARCH, and TOOLDIR. nbmake-MACHINE will also set variables
specified with -V, and unset variables specified with -Z. Note that by
- default these variables will not override mk.conf(5); see "make"
- variables for more details.
+ default these variables will not override mk.conf(5); see make variables
+ for more details.
This wrapper script can be symlinked into a directory listed in PATH, or
called with an absolute path.
Index: src/doc/BUILDING.mdoc
diff -u src/doc/BUILDING.mdoc:1.148 src/doc/BUILDING.mdoc:1.149
--- src/doc/BUILDING.mdoc:1.148 Fri Jul 21 22:07:59 2023
+++ src/doc/BUILDING.mdoc Sat Jul 22 18:50:04 2023
@@ -1,4 +1,4 @@
-.\" $NetBSD: BUILDING.mdoc,v 1.148 2023/07/21 22:07:59 lukem Exp $
+.\" $NetBSD: BUILDING.mdoc,v 1.149 2023/07/22 18:50:04 lukem Exp $
.\"
.\" Copyright (c) 2001-2023 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -397,7 +397,7 @@ The name of the
.Xr make 1
configuration file.
See
-.Sx \*qmake\*q variables
+.Sx make variables
and
.Xr mk.conf 5 .
.Pp
@@ -517,7 +517,7 @@ option.
.
.El
.
-.Ss \*qmake\*q variables
+.Ss make variables
.
Variables that control the behavior of
.Nx
@@ -556,10 +556,197 @@ For example,
.Bd -unfilled -offset indent
.Li MAKEVERBOSE?=1
.Ed
+.Pp
+The supported
+.Xr mk.conf 5
+make variables are:
+.\" Keep in sync with share/man/man5/mk.conf.5 section NETBSD SYSTEM VARIABLES
+.Bd -ragged -offset indent
+.Sy BSDOBJDIR ,
+.Sy BSDSRCDIR ,
+.Sy BUILD ,
+.Sy BUILDID ,
+.Sy BUILDINFO ,
+.Sy BUILDSEED ,
+.Sy CDEXTRA ,
+.Sy CONFIGOPTS ,
+.Sy COPTS ,
+.Sy CPUFLAGS ,
+.Sy DESTDIR ,
+.Sy EXTERNAL_TOOLCHAIN ,
+.Sy INSTALLBOOT_BOARDS ,
+.Sy INSTALLWORLDDIR ,
+.Sy KERNARCHDIR ,
+.Sy KERNCONFDIR ,
+.Sy KERNEL_DIR ,
+.Sy KERNOBJDIR ,
+.Sy KERNSRCDIR ,
+.Sy LOCALTIME ,
+.Sy MAKEVERBOSE ,
+.Sy MKAMDGPUFIRMWARE ,
+.Sy MKARGON2 ,
+.Sy MKARZERO ,
+.Sy MKATF ,
+.Sy MKBINUTILS ,
+.Sy MKBSDGREP ,
+.Sy MKBSDTAR ,
+.Sy MKCATPAGES ,
+.Sy MKCLEANSRC ,
+.Sy MKCLEANVERIFY ,
+.Sy MKCOMPAT ,
+.Sy MKCOMPATMODULES ,
+.Sy MKCOMPATTESTS ,
+.Sy MKCOMPATX11 ,
+.Sy MKCOMPLEX ,
+.Sy MKCROSSGDB ,
+.Sy MKCTF ,
+.Sy MKCVS ,
+.Sy MKCXX ,
+.Sy MKDEBUG ,
+.Sy MKDEBUGKERNEL ,
+.Sy MKDEBUGLIB ,
+.Sy MKDEBUGTOOLS ,
+.Sy MKDEPINCLUDES ,
+.Sy MKDOC ,
+.Sy MKDTB ,
+.Sy MKDTC ,
+.Sy MKDTRACE ,
+.Sy MKDYNAMICROOT ,
+.Sy MKFIRMWARE ,
+.Sy MKGCC ,
+.Sy MKGCCCMDS ,
+.Sy MKGDB ,
+.Sy MKGROFF ,
+.Sy MKGROFFHTMLDOC ,
+.Sy MKHESIOD ,
+.Sy MKHOSTOBJ ,
+.Sy MKHTML ,
+.Sy MKIEEEFP ,
+.Sy MKINET6 ,
+.Sy MKINFO ,
+.Sy MKIPFILTER ,
+.Sy MKISCSI ,
+.Sy MKKERBEROS ,
+.Sy MKKMOD ,
+.Sy MKKYUA ,
+.Sy MKLDAP ,
+.Sy MKLIBCSANITIZER ,
+.Sy MKLIBCXX ,
+.Sy MKLIBSTDCXX ,
+.Sy MKLINKLIB ,
+.Sy MKLINT ,
+.Sy MKLLVM ,
+.Sy MKLLVMRT ,
+.Sy MKLVM ,
+.Sy MKMAKEMANDB ,
+.Sy MKMAN ,
+.Sy MKMANDOC ,
+.Sy MKMANZ ,
+.Sy MKMDNS ,
+.Sy MKNLS ,
+.Sy MKNOUVEAUFIRMWARE ,
+.Sy MKNPF ,
+.Sy MKNSD ,
+.Sy MKOBJ ,
+.Sy MKOBJDIRS ,
+.Sy MKPAM ,
+.Sy MKPCC ,
+.Sy MKPF ,
+.Sy MKPIC ,
+.Sy MKPICINSTALL ,
+.Sy MKPICLIB ,
+.Sy MKPIE ,
+.Sy MKPIGZGZIP ,
+.Sy MKPOSTFIX ,
+.Sy MKPROFILE ,
+.Sy MKRADEONFIRMWARE ,
+.Sy MKRELRO ,
+.Sy MKREPRO ,
+.Sy MKREPRO_TIMESTAMP ,
+.Sy MKRUMP ,
+.Sy MKSANITIZER ,
+.Sy MKSHARE ,
+.Sy MKSKEY ,
+.Sy MKSLJIT ,
+.Sy MKSOFTFLOAT ,
+.Sy MKSTATICLIB ,
+.Sy MKSTATICPIE ,
+.Sy MKSTRIPIDENT ,
+.Sy MKSTRIPSYM ,
+.Sy MKTEGRAFIRMWARE ,
+.Sy MKTPM ,
+.Sy MKUNBOUND ,
+.Sy MKUNPRIVED ,
+.Sy MKUPDATE ,
+.Sy MKX11 ,
+.Sy MKX11FONTS ,
+.Sy MKX11MOTIF ,
+.Sy MKXORG_SERVER ,
+.Sy MKYP ,
+.Sy MKZFS ,
+.Sy NETBSDSRCDIR ,
+.Sy NETBSD_OFFICIAL_RELEASE ,
+.Sy NOCLEANDIR ,
+.Sy NODISTRIBDIRS ,
+.Sy NOINCLUDES ,
+.Sy OBJMACHINE ,
+.Sy RELEASEDIR ,
+.Sy RUMPUSER_THREADS ,
+.Sy RUMP_CURLWP ,
+.Sy RUMP_DEBUG ,
+.Sy RUMP_DIAGNOSTIC ,
+.Sy RUMP_KTRACE ,
+.Sy RUMP_LOCKDEBUG ,
+.Sy RUMP_LOCKS_UP ,
+.Sy RUMP_NBCOMPAT ,
+.Sy RUMP_VIRTIF ,
+.Sy RUMP_VNODE_LOCKDEBUG ,
+.Sy TOOLCHAIN_MISSING ,
+.Sy TOOLDIR ,
+.Sy USETOOLS ,
+.Sy USE_FORT ,
+.Sy USE_HESIOD ,
+.Sy USE_INET6 ,
+.Sy USE_JEMALLOC ,
+.Sy USE_KERBEROS ,
+.Sy USE_LDAP ,
+.Sy USE_LIBCSANITIZER ,
+.Sy USE_PAM ,
+.Sy USE_PIGZGZIP ,
+.Sy USE_SANITIZER ,
+.Sy USE_SKEY ,
+.Sy USE_SSP ,
+.Sy USE_XZ_SETS ,
+.Sy USE_YP ,
+.Sy X11MOTIFPATH ,
+.Sy X11SRCDIR .
+.Ed
+.Pp
+The obsolete
+.Xr mk.conf 5
+make variables are:
+.\" Keep in sync with share/man/man5/mk.conf.5 section OBSOLETE VARIABLES
+.Bd -ragged -offset indent
+.Sy EXTSRCSRCDIR ,
+.Sy MKBFD ,
+.Sy MKCRYPTO ,
+.Sy MKEXTSRC ,
+.Sy MKKDEBUG ,
+.Sy MKKERBEROS4 ,
+.Sy MKLLD ,
+.Sy MKLLDB ,
+.Sy MKMCLINKER ,
+.Sy MKPERFUSE ,
+.Sy MKTOOLSDEBUG ,
+.Sy NBUILDJOBS ,
+.Sy SHAREDSTRINGS ,
+.Sy USE_COMBINE ,
+.Sy USE_NEW_TOOLCHAIN .
+.Ed
.
.Sh BUILDING
.
-.Ss \*qmake\*q command line options
+.Ss make command line options
This is not a summary of all the options available to
.Xr make 1 ;
only the options used most frequently with
@@ -612,7 +799,7 @@ configuration file, or the system Makefi
.
.El
.
-.Ss \*qmake\*q targets
+.Ss make targets
.
These default targets may be built by running
.Xr make 1
@@ -696,7 +883,7 @@ text editors.
.
.El
.
-.Ss \*qmake\*q targets for the top level
+.Ss make targets for the top level
.
Additional
.Xr make 1
@@ -980,7 +1167,7 @@ this target should probably run those as
.
.El
.
-.Ss The \*qbuild.sh\*q script
+.Ss The build.sh script
.
This script file is a shell script designed to build the
entire
@@ -1658,7 +1845,7 @@ Show a help message, and exit.
.
.El
.
-.Ss The \*q\*[toolprefix]make-MACHINE\*q wrapper script
+.Ss The \*[toolprefix]make-MACHINE wrapper script
.
If using the
.Sy build.sh
@@ -1691,7 +1878,7 @@ and unset variables specified with
Note that by default these variables will not override
.Xr mk.conf 5 ;
see
-.Sx \*qmake\*q variables
+.Sx make variables
for more details.
.Pp
This wrapper script can be symlinked into a directory listed in
