Differential D12840 Diff 34640 head/share/man/man7/build.7

Changeset View

Standalone View

head/share/man/man7/build.7

	Show All 18 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd May 11, 2017			.Dd October 26, 2017
	.Dt BUILD 7			.Dt BUILD 7
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm build			.Nm build
	.Nd information on how to build the system			.Nd information on how to build the system
	.Sh DESCRIPTION			.Sh DESCRIPTION
	The sources for the			The sources for the
	.Fx			.Fx
	▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Lines
	objects are usually built in a separate object directory hierarchy			objects are usually built in a separate object directory hierarchy
	specified by the environment variable			specified by the environment variable
	.Va MAKEOBJDIRPREFIX ,			.Va MAKEOBJDIRPREFIX ,
	or under			or under
	.Pa /usr/obj			.Pa /usr/obj
	if variable			if variable
	.Va MAKEOBJDIRPREFIX			.Va MAKEOBJDIRPREFIX
	is not set.			is not set.
	For a given source directory, its canonical object directory			The canonical object directory is described in the documentation for the
	would be
	.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
	if
	.Xr make 1
	variable
	.Va MAKEOBJDIRPREFIX
	is set, or
	.Pa /usr/obj${.CURDIR}
	if this variable is not set.
	Cross-builds set the object directory as described in the
	documentation for the
	.Cm buildworld			.Cm buildworld
	target below.			target below.
	.Pp			.Pp
	The build may be controlled by defining			The build may be controlled by defining
	.Xr make 1			.Xr make 1
	variables described in the			variables described in the
	.Sx ENVIRONMENT			.Sx ENVIRONMENT
	section below, and by the variables documented in			section below, and by the variables documented in
	▲ Show 20 Lines • Show All 91 Lines • ▼ Show 20 Lines
	and			and
	.Pa release .			.Pa release .
	The object directory can be changed from the default			The object directory can be changed from the default
	.Pa /usr/obj			.Pa /usr/obj
	by setting the			by setting the
	.Pa MAKEOBJDIRPREFIX			.Pa MAKEOBJDIRPREFIX
	.Xr make 1			.Xr make 1
	variable.			variable.
	The actual build location prefix used is			The actual build location prefix used
				depends on the
				.Va WITH_UNIFIED_OBJDIR
				option from
				.Xr src.conf 5 .
				If enabled it is
				.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}/${TARGET}.${TARGET_ARCH}
				for all builds.
				If disabled it is
	.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}			.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
	for native builds, and			for native builds, and
	.Pa ${MAKEOBJDIRPREFIX}/${TARGET}${.CURDIR}			.Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}${.CURDIR}
	for cross builds and native builds with variable			for cross builds and native builds with variable
	.Va CROSS_BUILD_TESTING			.Va CROSS_BUILD_TESTING
	set.			set.
	.It Cm cleanworld			.It Cm cleanworld
	Attempt to clean up targets built by a preceding			Attempt to clean up targets built by a preceding
	.Cm buildworld			.Cm buildworld
	step.			step.
	.It Cm distributeworld			.It Cm distributeworld
	▲ Show 20 Lines • Show All 239 Lines • ▼ Show 20 Lines
	If not set,			If not set,
	.Va DESTDIR			.Va DESTDIR
	defaults to the empty string.			defaults to the empty string.
	.It Va MAKEOBJDIRPREFIX			.It Va MAKEOBJDIRPREFIX
	Defines the prefix for directory names in the tree of built objects.			Defines the prefix for directory names in the tree of built objects.
	Defaults to			Defaults to
	.Pa /usr/obj			.Pa /usr/obj
	if not defined.			if not defined.
	This variable should only be set in the environment and not via			This variable should only be set in the environment or
				.Pa /etc/src-env.conf
				and not via
	.Pa /etc/make.conf			.Pa /etc/make.conf
				or
				.Pa /etc/src.conf
	or the command line.			or the command line.
	.It Va NO_WERROR			.It Va NO_WERROR
	If defined, compiler warnings will not cause the build to halt,			If defined, compiler warnings will not cause the build to halt,
	even if the makefile says otherwise.			even if the makefile says otherwise.
	.It Va WITH_CTF			.It Va WITH_CTF
	If defined, the build process will run the DTrace CTF conversion			If defined, the build process will run the DTrace CTF conversion
	tools on built objects.			tools on built objects.
	.El			.El
	▲ Show 20 Lines • Show All 306 Lines • Show Last 20 Lines