tech-toolchain archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[patch] update share/man/man5/mk.conf.5



Hello,

The attached patch adds documentation for the following build knobs to
the mk.conf(5) manual page: EXTSRCSRCDIR, MKARZERO, MKBSDTAR,
MKCLEANSRC, MKCLEANVERIFY, MKCOMPAT, MKDTRACE, MKEXTSRC, MKLVM,
MKMANDOC, MKNPF, MKPIGZGZIP, MKREPRO, MKRUMP, MKX11FONTS and MKZFS.

Could you please review?

-- Joseph Koshy <jkoshy%NetBSD.org@localhost>
Document build knobs EXTSRCSRCDIR, MKARZERO, MKBSDTAR, MKCLEANSRC,
MKCLEANVERIFY, MKCOMPAT, MKDTRACE, MKEXTSRC, MKLVM, MKMANDOC, MKNPF,
MKPIGZGZIP, MKREPRO, MKRUMP, MKX11FONTS and MKZFS.

diff --git a/share/man/man5/mk.conf.5 b/share/man/man5/mk.conf.5
index ee2262a..f2b999c 100644
--- a/share/man/man5/mk.conf.5
+++ b/share/man/man5/mk.conf.5
@@ -182,6 +182,14 @@ unless run in
 .Sq expert
 mode
 .
+.It Sy EXTSRCSRCDIR
+Specifies the location of the external sources to be built if the
+.Sy MKEXTSRC
+build knob is not
+.Dq no .
+The default location is
+.Pa /usr/extsrc .
+.
 .It Sy MAKEVERBOSE
 Level of verbosity of status messages.
 Supported values:
@@ -219,6 +227,16 @@ flag.
 .DFLT
 2
 .
+.It Sy MKARZERO
+.YorN
+Indicates whether the
+.Fl D
+option should be passed to
+.Xr ar 1
+when creating archives, allowing archives from different builds to be
+bit identical.
+.DFLTn
+.
 .It Sy MKATF
 .YorN
 Indicates whether the Automated Testing Framework is built and installed.
@@ -238,12 +256,76 @@ or
 .Xr mdsetimage 8 .
 .DFLTy
 .
+.It Sy MKBSDTAR
+.YorN
+Indicates whether to use
+.Sy libarchive
+based implementations of
+.Xr cpio 1
+and
+.Xr tar 1 .
+.DFLTn
+.
 .It Sy MKCATPAGES
 .YorN
 Indicates whether preformatted plaintext manual pages will be created
 and installed.
 .DFLTy
 .
+.It Sy MKCLEANSRC
+.YorN
+Indicates whether
+.Sq "make clean"
+and
+.Sq "make cleandir"
+will delete file names in
+.Sy CLEANFILES
+or
+.Sy CLEANDIRFILES
+from both the object directory,
+.Sy .OBJDIR ,
+and the source directory,
+.Sy .SRCDIR .
+.Pp
+If
+.Dq yes ,
+then these file names will be deleted relative to both
+.Sy .OBJDIR
+and
+.Sy .CURDIR .
+If
+.Dq no ,
+then the deletion will be performed relative to
+.Sy .OBJDIR
+only.
+.DFLTy
+.
+.It Sy MKCLEANVERIFY
+.YorN
+Controls whether
+.Sq "make clean"
+and
+.Sq "make cleandir"
+will verify that files have been deleted.
+If
+.Dq yes ,
+then file deletions will be verified using
+.Xr ls 1 .
+If
+.Dq no ,
+then file deletions will not be verified.
+.DFLTy
+.
+.It Sy MKCOMPAT
+.YorN
+Indicates whether the multiple ABI support under
+.Pa src/compat
+is to be built and installed.
+.DFLTy
+on amd64 and sparc64,
+.Dq no
+on other architectures.
+.
 .It Sy MKCOMPLEX
 .YorN
 Indicates whether the
@@ -301,6 +383,13 @@ Indicates whether system documentation destined for
 will be installed.
 .DFLTy
 .
+.It Sy MKDTRACE
+.YorN
+Indicates whether the kernel modules, utilities and libraries for
+.Xr dtrace 1
+support are to be built and installed.
+.DFLTn
+.
 .It Sy MKDYNAMICROOT
 .YorN
 Indicates whether all programs should be dynamically linked,
@@ -321,6 +410,17 @@ and
 statically.
 .DFLTy
 .
+.It Sy MKEXTSRC
+.YorN
+If not
+.Dq no ,
+.Sq "make build"
+will build the programs and libraries externally specified by the user.
+The location of the external sources may be specified by the
+.Sy EXTSRCSRCDIR
+build knob.
+.DFLTn
+.
 .It Sy MKGCC
 .YorN
 Indicates whether
@@ -472,6 +572,13 @@ installed into
 .Sy DESTDIR Ns Pa /usr/libdata/lint .
 .DFLTy
 .
+.It Sy MKLVM
+.YorN
+If not
+.Dq no ,
+build and install the logical volume manager.
+.DFLTy
+.
 .It Sy MKMAN
 .YorN
 Indicates whether manual pages will be installed.
@@ -482,6 +589,15 @@ If
 acts as
 .Sy MKCATPAGES=no MKHTML=no .
 .
+.It Sy MKMANDOC
+.YorN
+If
+.Dq yes ,
+the
+.Xr mandoc 1
+tool is used to compile catman and html pages.
+.DFLTy
+.
 .It Sy MKMANZ
 .YorN
 Indicates whether manual pages should be compressed with
@@ -501,6 +617,11 @@ Indicates whether Native Language System (NLS) locale zone 
files will be
 built and installed.
 .DFLTy
 .
+.It Sy MKNPF
+.YorN
+Indicates whether the NPF packet filter is to be built and installed.
+.DFLTy
+.
 .It Sy MKOBJ
 .YorN
 Indicates whether object directories will be created when running
@@ -591,6 +712,16 @@ Indicates whether Position Independent Executables (PIE)
 are built and installed.
 .DFLTn
 .
+.It Sy MKPIGZGZIP
+.YorN
+If
+.Dq no ,
+the
+.Xr pigz 1
+is not installed as
+.Xr gzip 1 .
+.DFLTn
+.
 .It Sy MKPOSTFIX
 .YorN
 Indicates whether Postfix is built.
@@ -607,6 +738,22 @@ however, some platforms turn off
 .Sy MKPROFILE
 by default at times due to toolchain problems with profiled code.
 .
+.It Sy MKREPRO
+.YorN
+Indicates whether builds are to be reproducible.
+If
+.Dq yes ,
+two builds from the same source tree will produce the same build
+results.
+.DFLTn
+.
+.It Sy MKRUMP
+.YorN
+Indicates whether the
+.Xr rump 3
+headers, libraries and programs are to be installed.
+.DFLTy
+.
 .It Sy MKSHARE
 .YorN
 Indicates whether files destined to reside in
@@ -682,12 +829,28 @@ depending on the value of
 .DFLTn
 .Pp
 .
+.It Sy MKX11FONTS
+.YorN
+If
+.Dq no ,
+do not build and install the X fonts.
+.DFLTy
+.
 .It Sy MKYP
 .YorN
 Indicates whether the YP (NIS) infrastructure
 (libraries and support programs) is built.
 .DFLTy
 .
+.It Sy MKZFS
+.YorN
+Indicates whether the ZFS kernel module and the utilities and
+libraries used to manage the ZFS system are to be built.
+.DFLTy
+on i386 and amd64,
+.Dq no
+on other architectures.
+.
 .It Sy OBJMACHINE
 If defined, creates objdirs of the form
 .Pa obj. Ns Sy MACHINE ,


Home | Main Index | Thread Index | Old Index