svn commit: r366399 - in stable/12: share/man/man5 share/man/man7 tools/build/options

[Gordon Bergling]

Author: gbe (doc committer)
Date: Sat Oct  3 14:45:17 2020
New Revision: 366399
URL: https://svnweb.freebsd.org/changeset/base/366399

Log:
  MFC r365640: Improvements for the src.conf(5) and build(7) man pages
  
  PR:	203863 (based on)
  Submitted by:	Russell Haley <russ dot haley at gmail dot com>
  Reviewed by:	bcr, imp
  Approved by:	imp
  Differential Revision:	https://reviews.freebsd.org/D26343

Modified:
  stable/12/share/man/man5/src.conf.5
  stable/12/share/man/man7/build.7
  stable/12/tools/build/options/makeman
Directory Properties:
  stable/12/   (props changed)

Modified: stable/12/share/man/man5/src.conf.5
==============================================================================
--- stable/12/share/man/man5/src.conf.5	Sat Oct  3 14:37:54 2020	(r366398)
+++ stable/12/share/man/man5/src.conf.5	Sat Oct  3 14:45:17 2020	(r366399)
@@ -9,7 +9,8 @@
 .Sh DESCRIPTION
 The
 .Nm
-file contains settings that will apply to every build involving the
+file contains variables that control what components will be generated during
+the build process of the
 .Fx
 source tree; see
 .Xr build 7 .

Modified: stable/12/share/man/man7/build.7
==============================================================================
--- stable/12/share/man/man7/build.7	Sat Oct  3 14:37:54 2020	(r366398)
+++ stable/12/share/man/man7/build.7	Sat Oct  3 14:45:17 2020	(r366399)
@@ -24,12 +24,12 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 10, 2018
+.Dd September 11, 2020
 .Dt BUILD 7
 .Os
 .Sh NAME
 .Nm build
-.Nd information on how to build the system
+.Nd General instructions on how to build the system
 .Sh DESCRIPTION
 The sources for the
 .Fx
@@ -68,10 +68,11 @@ command is used in each of these directories to build 
 things in that directory.
 Issuing the
 .Xr make 1
-command in any directory or
-subdirectory of those directories has the same effect as issuing the
-same command in all subdirectories of that directory.
-With no target specified, the things in that directory are just built.
+command in any directory issues the
+.Xr make 1
+command recursively in all subdirectories.
+With no target specified, the items in the directories are built
+and no further action is taken.
 .Pp
 A source tree is allowed to be read-only.
 As described in
@@ -95,6 +96,14 @@ variables described in the
 section below, and by the variables documented in
 .Xr make.conf 5 .
 .Pp
+The default components included in the build are specified in the file
+.Pa /etc/src.conf
+in the source tree.
+To override the default file, include the SRCCONF option in the make steps,
+pointing to a custom src.conf file.
+For more information see
+.Xr src.conf 5 .
+.Pp
 The following list provides the names and actions for the targets
 supported by the build system:
 .Bl -tag -width ".Cm cleandepend"
@@ -573,6 +582,12 @@ process.
 .Bd -literal -offset indent
 make PORTS_MODULES=emulators/kqemu-kmod kernel
 .Ed
+.It Va SRCCONF
+Specify a file to override the default
+.Pa /etc/src.conf .
+The src.conf file controls the components to build.
+See
+.Xr src.conf 5
 .It Va STRIPBIN
 Command to use at install time when stripping binaries.
 Be sure to add any additional tools required to run

Modified: stable/12/tools/build/options/makeman
==============================================================================
--- stable/12/tools/build/options/makeman	Sat Oct  3 14:37:54 2020	(r366398)
+++ stable/12/tools/build/options/makeman	Sat Oct  3 14:45:17 2020	(r366399)
@@ -154,7 +154,8 @@ main()
 .Sh DESCRIPTION
 The
 .Nm
-file contains settings that will apply to every build involving the
+file contains variables that control what components will be generated during
+the build process of the
 .Fx
 source tree; see
 .Xr build 7 .