d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improvements for the src.conf(5) and build(7) man pages

Browse Source 
PR:		203863 (based on)
Submitted by:	Russell Haley <russ dot haley at gmail dot com>
Reviewed by:	bcr, imp
Approved by:	imp
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D26343
This commit is contained in:
Gordon Bergling 2020-09-11 18:09:49 +00:00
parent c71c2b76aa
commit e6ca69017c
3 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
share/man/man5/src.conf.5
View File

@ -1,6 +1,6 @@
.\" DO NOT EDIT-- this file is @generated by tools/build/options/makeman.
.\" $FreeBSD$
.Dd September 8, 2020
.Dd September 11, 2020
.Dt SRC.CONF 5
.Os
.Sh NAME
@ -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 .

27
share/man/man7/build.7
View File

@ -24,12 +24,12 @@
.\"
.\" $FreeBSD$
.\"
.Dd August 5, 2020
.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
@ -66,10 +66,11 @@ command is used in each of these directories to build and install the
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
@ -93,6 +94,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"
@ -583,6 +592,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

3
tools/build/options/makeman
View File

@ -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 .