src/BUILDING - diff

Return to BUILDING CVS log

Up to [cvs.NetBSD.org] / src

Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.

Diff for /src/BUILDING between version 1.5 and 1.17

version 1.5, 2001/11/15 16:20:37

version 1.17, 2002/11/25 19:18:44

Line 13 STATUS

plementation are noted specially, as with the note below:

Note: This document applies only to platforms which use the new toolchain

as indicated by the default setting of USE_NEW_TOOLCHAIN in <bsd.own.mk>.

as indicated by the default setting of TOOLCHAIN_MISSING in <bsd.own.mk>.

Platforms which have not yet been switched to the new toolchain should

continue building traditionally, using the notes specified in the file

UPDATING.

Line 38 REQUIREMENTS

FILES

Source tree layout

BUILDING.mdoc This document (in -mdoc troff format; the original copy).

doc/BUILDING.mdoc

This document (in -mdoc troff format; the original copy).

BUILDING This document (in plaintext).

Line 88 FILES

Line 89 FILES

described in release(7).

CONFIGURATION

Environment variables

Several environment variables control the behaviour of NetBSD builds.

MACHINE Machine type.

MACHINE_ARCH Machine architecture.

MAKE Path name to invoke make(1) as.

MAKEFLAGS Flags to invoke make(1) with.

MAKEOBJDIR Directory to use as the .OBJDIR for the current direc-

tory. Used only if MAKEOBJDIRPREFIX is not defined.

MAKEOBJDIR can only be provided in the environment.

MAKEOBJDIRPREFIX Top level directory of the object directory tree. If

this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used

as the .OBJDIR for the current directory. The current

directory may be read only. MAKEOBJDIRPREFIX can only

be provided in the environment.

"make" variables

Several variables control the behavior of NetBSD builds. Unless other-

wise specified, these variables may be set in either the process environ-

ment or the make(1) configuration file specified by MAKECONF.

BUILDID Identifier for the build. The identifier will be appended to

object directory names, and can be consulted in the make(1)

configuration file in order to set additional build parame-

ters, such as compiler flags.

DESTDIR Directory to contain the built NetBSD system. If set, spe-

cial options are passed to the compilation tools to prevent

their default use of the host system's /usr/include,

/usr/lib, and so forth. This pathname should not end with a

slash (/) character (for installation into the system's root

directory, set DESTDIR to an empty string).

directory, set DESTDIR to an empty string). The directory

must reside on a file system which supports long file names

and hard links.

Default: Empty string if USETOOLS is ``yes''; unset other-

wise.

Line 209 CONFIGURATION

Line 238 CONFIGURATION

Default: Unset.

UNPRIVED If set, then an unprivileged install will occur. The user,

group, permissions, and file flags, will not be set on the

installed item; instead the information will be appended to a

file called METALOG in DESTDIR. The contents of METALOG is

used during the generation of the distribution tar files to

ensure that the appropriate file ownership is stored.

Default: Unset.

UPDATE If set, then all install operations intended to write to

DESTDIR will compare file timestamps before installing, and

skip the install phase if the destination files are up-to-

Line 241 CONFIGURATION

Line 279 CONFIGURATION

clude files).

"make" variables for full builds

These variables only affect the top level ``Makefile'' and do not manual-

These variables only affect the top level ``Makefile'' and do not affect

ly building subtrees of the NetBSD source code.

manually building subtrees of the NetBSD source code.

MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether object

directories will be created automatically (via a ``make

Line 250 CONFIGURATION

Line 288 CONFIGURATION

Default: ``yes''

NBUILDJOBS If set, specifies the number of parallel make(1) processes

NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see be-

that should be run simultaneously. This can speed up

low)

builds on SMP machines, or machines with much more CPU

power than I/O availability. This should be used instead

of the make(1) option -j, in order to ensure proper order-

ing of build components.

Default: Unset.

Line 297 BUILDING

Line 331 BUILDING

This is only a summary of options available to make(1); only the options

used most frequently with NetBSD builds are listed here.

-j njob Run up to njob make(1) subjobs in parallel. Makefiles should

use .WAIT or have explicit dependancies as necessary to en-

force build ordering. If you see build failures with -j,

please save complete build logs so the failures can be ana-

lyzed.

-m dir Specify the default directory for searching for system Make-

file segments, mainly the <bsd.*.mk> files. When building any

full NetBSD source tree, this should be set to the

Line 336 BUILDING

Line 376 BUILDING

dependency changes.

dependall Does a ``make depend'' immediately followed by a ``make all''.

This combined target recurses as an atomic unit, so that the

This improves cache locality of the build since both passes

``make depend'' phase can participate in make -j parallelism.

read the source files in their entirety.

includes Build and install system header files. Typically needed be-

fore any system libraries or programs can be built.

install Install programs, libraries, and documentation into DESTDIR.

Few files will be installed to /dev, /etc, /root or /var in

order to prevent user supplied configuration data from being

overwritten.

lint Run lint(1) against the C source code, where appropriate, and

generate system-installed lint libraries.

Line 392 BUILDING

Line 435 BUILDING

-a arch Set the value of MACHINE_ARCH to arch.

-B buildid

Set the value of BUILDID to buildid. This will also append the

build idenfitier to the name of the ``make'' wrapper script so

that the resulting name is of the form ``nbmake-MACHINE-

BUILDID''.

-b Bootstrap ``make'' and create a nbmake-MACHINE script (see be-

low).

-j njob Set the value of NBUILDJOBS to njob. This provides similar

-d Build a full distribution. This differs from a default build

functionality to the familiar ``make -j'', but preserves the

in that files will also be installed to /dev, /etc, /root and

ordering of the top level ``make build''.

/var. Note this does not build a ``release''; no release sets

are placed in ${RELEASEDIR}. -d is implied by -R.

-j njob Passed through to make(1). Makefiles should use .WAIT or have

explicit dependancies as necessary to enforce build ordering.

If you see build failures with -j, please save complete build

logs so the failures can be analyzed.

-k kernel

Build a new kernel. The kernel argument is the name of a con-

figuration file suitable for use by config(8). If kernel does

not contain any `/' characters, the configuration file is ex-

pected to be found in the KERNCONFDIR directory, which is typi-

cally sys/arch/MACHINE/conf. The new kernel will be built in a

subdirectory of KERNOBJDIR, which is typically

sys/arch/MACHINE/compile or an associated object directory. In

order to ensure that the kernel is built using up-to-date

tools, it is strongly recommended that the tools be rebuilt

(using the -t option) in a separate invocation of build.sh pri-

or to using the -k option, or that the -t and -k options be

used together in a single invocation of build.sh.

-m mach Set the value of MACHINE to mach. This will also override any

value of MACHINE_ARCH in the process environment with a value

Line 428 BUILDING

Line 497 BUILDING

-D dest Set the value of DESTDIR to dest.

-M obj Set MAKEOBJDIRPREFIX to obj.

-O obj Create an appropriate transform macro for MAKEOBJDIR that will

place the built object files under obj. For instance, a set-

ting of /usr/obj will place build-time files files under

ting of /usr/obj will place build-time files under

/usr/obj/bin, /usr/obj/lib, and so forth.

-R rel Set the value of RELEASEDIR to rel. Setting this option will

Line 441 BUILDING

Line 512 BUILDING

``make'' will only be rebuilt as needed (when the source files

for make(1) change).

-U Set the UNPRIVED variable.

The "nbmake-MACHINE" wrapper script

If using the build.sh script to build NetBSD, a nbmake-MACHINE script

will be created in TOOLDIR/bin upon the first build to assist in building

Line 452 BUILDING

Line 525 BUILDING

This script can be symlinked into a directory listed in PATH, or called

with an absolute path.

EXAMPLES

./build.sh -t

Build a new toolchain.

cd ${KERNCONFDIR} ; ${TOOLDIR}/bin/nbconfig GENERIC

Use the new version of config(8) to prepare to build a new

GENERIC kernel.

cd ${KERNOBJDIR}/GENERIC ; ${TOOLDIR}/bin/nbmake-${MACHINE} dependall

Use the new toolchain to build a new GENERIC kernel.

./build.sh -t -k GENERIC

Build a new toolchain, and use the new toolchain to configure

and build a new GENERIC kernel.

./build.sh -U -d

Using unprivileged mode, build a complete distribution in

DESTDIR.

./build.sh -U -R /some/dir/RELEASE

Using unprivileged mode, build a complete release in the speci-

fied release directory.

OBSOLETE VARIABLES

NBUILDJOBS Use the make(1) option -j, instead.

USE_NEW_TOOLCHAIN

The new toolchain is now the default. To disable, use

TOOLCHAIN_MISSING=yes.