version 1.102, 2012/09/19 23:40:03 |
version 1.106, 2014/05/21 13:12:19 |
|
|
BUILDING(8) NetBSD System Manager's Manual BUILDING(8) |
BUILDING(8) System Manager's Manual BUILDING(8) |
|
|
NAME |
NAME |
BUILDING -- Procedure for building NetBSD from source code. |
BUILDING -- Procedure for building NetBSD from source code. |
|
|
recompiled regularly. |
recompiled regularly. |
|
|
crypto/dist/, dist/, gnu/dist/ |
crypto/dist/, dist/, gnu/dist/ |
Sources imported verbatim from third parties, without man- |
Sources imported verbatim from third parties, without |
gling the existing build structure. Other source trees in |
mangling the existing build structure. Other source trees |
bin through usr.sbin use the NetBSD make(1) ``reachover'' |
in bin through usr.sbin use the NetBSD make(1) |
Makefile semantics when building these programs for a |
``reachover'' Makefile semantics when building these |
native host. |
programs for a native host. |
|
|
|
external, sys/external |
|
Sources and build infrastructure for components imported |
|
(mostly) unchanged from upstream maintainers, sorted by |
|
applicable license. This is (slowly) replacing the |
|
crypto/dist, dist, and gnu/dist directories. |
|
|
distrib/, etc/ |
distrib/, etc/ |
Sources for items used when making a full release snap- |
Sources for items used when making a full release |
shot, such as files installed in DESTDIR/etc on the desti- |
snapshot, such as files installed in DESTDIR/etc on the |
nation system, boot media, and release notes. |
destination system, boot media, and release notes. |
|
|
tests/, regress/ |
tests/, regress/ |
Regression test harness. Can be cross-compiled, but only |
Regression test harness. Can be cross-compiled, but only |
|
|
sys/ NetBSD kernel sources. |
sys/ NetBSD kernel sources. |
|
|
tools/ ``Reachover'' build structure for the host build tools. |
tools/ ``Reachover'' build structure for the host build tools. |
This has a special method of determining out-of-date sta- |
This has a special method of determining out-of-date |
tus. |
status. |
|
|
bin/ ... usr.sbin/ |
bin/ ... usr.sbin/ |
Sources to the NetBSD userland (non-kernel) programs. If |
Sources to the NetBSD userland (non-kernel) programs. If |
|
|
system requires a modern Bourne-like shell with POSIX- |
system requires a modern Bourne-like shell with POSIX- |
compliant features, and also requires support for the |
compliant features, and also requires support for the |
``local'' keyword to declare local variables in shell |
``local'' keyword to declare local variables in shell |
functions (which is a widely-implemented but non-stan- |
functions (which is a widely-implemented but non- |
dardised feature). |
standardised feature). |
|
|
Depending on the host system, a suitable shell may be |
Depending on the host system, a suitable shell may be |
/bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a |
/bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a |
variant of ksh that supports the ``local'' keyword, |
variant of ksh that supports the ``local'' keyword, |
such as ksh88, but not ksh93), or /usr/local/bin/bash. |
such as ksh88, but not ksh93), or /usr/local/bin/bash. |
|
|
Most parts of the build require HOST_SH to be an abso- |
Most parts of the build require HOST_SH to be an |
lute path; however, build.sh allows it to be a simple |
absolute path; however, build.sh allows it to be a |
command name, which will be converted to an absolute |
simple command name, which will be converted to an |
path by searching the PATH. |
absolute path by searching the PATH. |
|
|
HOST_CC Path name to C compiler used to create the toolchain. |
HOST_CC Path name to C compiler used to create the toolchain. |
|
|
|
|
MAKE Path name to invoke make(1) as. |
MAKE Path name to invoke make(1) as. |
|
|
MAKEFLAGS Flags to invoke make(1) with. Note that build.sh |
MAKEFLAGS Flags to invoke make(1) with. Note that build.sh |
ignores the value of MAKEFLAGS passed in the environ- |
ignores the value of MAKEFLAGS passed in the |
ment, but allows MAKEFLAGS to be set via the -V option. |
environment, but allows MAKEFLAGS to be set via the -V |
|
option. |
MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- |
|
tory. The value is subjected to variable expansion by |
MAKEOBJDIR Directory to use as the .OBJDIR for the current |
make(1). Typical usage is to set this variable to a |
directory. The value is subjected to variable |
value involving the use of `${.CURDIR:S...}' or |
expansion by make(1). Typical usage is to set this |
`${.CURDIR:C...}', to derive the value of .OBJDIR from |
variable to a value involving the use of |
the value of .CURDIR. Used only if MAKEOBJDIRPREFIX is |
`${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the |
not defined. MAKEOBJDIR can be provided only in the |
value of .OBJDIR from the value of .CURDIR. Used only |
environment or via the -O flag of build.sh; it cannot |
if MAKEOBJDIRPREFIX is not defined. MAKEOBJDIR can be |
usefully be set inside a Makefile, including mk.conf or |
provided only in the environment or via the -O flag of |
${MAKECONF}. |
build.sh; it cannot usefully be set inside a Makefile, |
|
including mk.conf or ${MAKECONF}. |
|
|
MAKEOBJDIRPREFIX Top level directory of the object directory tree. The |
MAKEOBJDIRPREFIX Top level directory of the object directory tree. The |
value is subjected to variable expansion by make(1). |
value is subjected to variable expansion by make(1). |
|
|
if necessary, but if make(1) is used without build.sh, |
if necessary, but if make(1) is used without build.sh, |
then rules in <bsd.obj.mk> will abort the build if the |
then rules in <bsd.obj.mk> will abort the build if the |
${MAKEOBJDIRPREFIX} directory does not exist. If the |
${MAKEOBJDIRPREFIX} directory does not exist. If the |
value is defined and valid, then ${MAKEOBJDIRPRE- |
value is defined and valid, then |
FIX}/${.CURDIR} is used as the .OBJDIR for the current |
${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the .OBJDIR |
directory. The current directory may be read only. |
for the current directory. The current directory may |
MAKEOBJDIRPREFIX can be provided only in the environ- |
be read only. MAKEOBJDIRPREFIX can be provided only in |
ment or via the -M flag of build.sh; it cannot usefully |
the environment or via the -M flag of build.sh; it |
be set inside a Makefile, including mk.conf or |
cannot usefully be set inside a Makefile, including |
${MAKECONF}. |
mk.conf or ${MAKECONF}. |
|
|
"make" variables |
"make" variables |
Several variables control the behavior of NetBSD builds. Unless other- |
Several variables control the behavior of NetBSD builds. Unless |
wise specified, these variables may be set in either the process environ- |
otherwise specified, these variables may be set in either the process |
ment or the make(1) configuration file specified by MAKECONF. |
environment or the make(1) configuration file specified by MAKECONF. |
|
|
BUILDID Identifier for the build. The identifier will be appended to |
BUILDID Identifier for the build. The identifier will be appended to |
object directory names, and can be consulted in the make(1) |
object directory names, and can be consulted in the make(1) |
configuration file in order to set additional build parame- |
configuration file in order to set additional build |
ters, such as compiler flags. |
parameters, such as compiler flags. |
|
|
BUILDSEED GCC uses random numbers when compiling C++ code. This vari- |
BUILDSEED GCC uses random numbers when compiling C++ code. This |
able seeds the gcc random number generator using the -fran- |
variable seeds the gcc random number generator using the |
dom-seed flag with this value. By default, it is set to |
-frandom-seed flag with this value. By default, it is set to |
NetBSD-(majorversion). Using a fixed value causes C++ bina- |
NetBSD-(majorversion). Using a fixed value causes C++ |
ries to be the same when built from the same sources, result- |
binaries to be the same when built from the same sources, |
ing in identical (reproducible) builds. Additional informa- |
resulting in identical (reproducible) builds. Additional |
tion is available in the GCC documentation of -frandom-seed. |
information is available in the GCC documentation of |
|
-frandom-seed. |
DESTDIR Directory to contain the built NetBSD system. If set, spe- |
|
cial options are passed to the compilation tools to prevent |
DESTDIR Directory to contain the built NetBSD system. If set, |
their default use of the host system's /usr/include, |
special 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 must be an absolute |
/usr/lib, and so forth. This pathname must be an absolute |
path, and should not end with a slash (/) character. (For |
path, and should not end with a slash (/) character. (For |
installation into the system's root directory, set DESTDIR to |
installation into the system's root directory, set DESTDIR to |
an empty string, not to ``/''). The directory must reside on |
an empty string, not to ``/''). The directory must reside on |
a file system which supports long file names and hard links. |
a file system which supports long file names and hard links. |
|
|
Default: Empty string if USETOOLS is ``yes''; unset other- |
Default: Empty string if USETOOLS is ``yes''; unset |
wise. |
otherwise. |
|
|
Note: build.sh will provide a default of destdir.MACHINE (in |
Note: build.sh will provide a default of destdir.MACHINE (in |
the top-level .OBJDIR) unless run in `expert' mode. |
the top-level .OBJDIR) unless run in `expert' mode. |
|
|
are shown. |
are shown. |
|
|
1 Brief messages are shown describing what is being done, |
1 Brief messages are shown describing what is being done, |
but the actual commands executed by make(1) are not dis- |
but the actual commands executed by make(1) are not |
played. |
displayed. |
|
|
2 Descriptive messages are shown as above (prefixed with a |
2 Descriptive messages are shown as above (prefixed with a |
`#'), and ordinary commands performed by make(1) are |
`#'), and ordinary commands performed by make(1) are |
|
|
|
|
Default: 2 |
Default: 2 |
|
|
MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor- |
MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether |
matted plaintext manual pages will be created during a build. |
preformatted plaintext manual pages will be created during a |
|
build. |
|
|
Default: ``yes'' |
Default: ``no'' |
|
|
MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto- |
MKCROSSGDB Can be set to ``yes'' or ``no''. Create a cross-gdb as a |
graphic code will be included in a build; provided for the |
host tool. |
benefit of countries that do not allow strong cryptography. |
|
Will not affect use of the standard low-security password |
Default: ``no'' |
encryption system, crypt(3). |
|
|
MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether |
|
cryptographic code will be included in a build; provided for |
|
the benefit of countries that do not allow strong |
|
cryptography. Will not affect use of the standard low- |
|
security password encryption system, crypt(3). |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
MKDEBUG Can be set to ``yes'' or ``no''. Indicates whether debug |
|
information should be generated for all userland binaries |
|
compiled. The result is collected as an additional debug.tgz |
|
and xdebug.tgz set and installed in /usr/libdata/debug. |
|
|
|
Default: ``no'' |
|
|
|
MKDEBUGLIB Can be set to ``yes'' or ``no''. Indicates whether debug |
|
information (see MKDEBUG) should also be generated for all |
|
libraries build. |
|
|
|
Default: ``no'' |
|
|
MKDOC Can be set to ``yes'' or ``no''. Indicates whether system |
MKDOC Can be set to ``yes'' or ``no''. Indicates whether system |
documentation destined for DESTDIR/usr/share/doc will be |
documentation destined for DESTDIR/usr/share/doc will be |
installed during a build. |
installed during a build. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
MKHTML Can be set to ``yes'' or ``no''. Indicates whether prefor- |
MKHTML Can be set to ``yes'' or ``no''. Indicates whether |
matted HTML manual pages will be built and installed |
preformatted HTML manual pages will be built and installed |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
|
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
MKKDEBUG Can be set to ``yes'' or ``no''. Force generation of full- |
|
debug symbol versions of all kernels compiled. Alongside of |
|
the netbsd kernel file, an unstripped version netbsd.gdb is |
|
created. This is useful if a cross-gdb is built as well (see |
|
MKCROSSGDB). |
|
|
|
Default: ``no'' |
|
|
MKKMOD Can be set to ``yes'' or ``no''. Indicates whether kernel |
MKKMOD Can be set to ``yes'' or ``no''. Indicates whether kernel |
modules are built and installed. |
modules are built and installed. |
|
|
|
|
build. If set to ``no'', the entire built system will be |
build. If set to ``no'', the entire built system will be |
statically linked. |
statically linked. |
|
|
Default: Platform dependent. As of this writing, all plat- |
Default: Platform dependent. As of this writing, all |
forms except sh3 default to ``yes''. |
platforms except sh3 default to ``yes''. |
|
|
MKPICINSTALL |
MKPICINSTALL |
Can be set to ``yes'' or ``no''. Indicates whether the ar(1) |
Can be set to ``yes'' or ``no''. Indicates whether the ar(1) |
|
|
|
|
MKSTRIPIDENT |
MKSTRIPIDENT |
Can be set to ``yes'' or ``no''. Indicates whether RCS IDs, |
Can be set to ``yes'' or ``no''. Indicates whether RCS IDs, |
for use with ident(1), should be stripped from program bina- |
for use with ident(1), should be stripped from program |
ries and shared libraries. |
binaries and shared libraries. |
|
|
Default: ``no'' |
Default: ``no'' |
|
|
MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an |
MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an |
unprivileged install will occur. The user, group, permis- |
unprivileged install will occur. The user, group, |
sions, and file flags, will not be set on the installed |
permissions, and file flags, will not be set on the installed |
items; instead the information will be appended to a file |
items; instead the information will be appended to a file |
called METALOG in DESTDIR. The contents of METALOG are used |
called METALOG in DESTDIR. The contents of METALOG are used |
during the generation of the distribution tar files to ensure |
during the generation of the distribution tar files to ensure |
|
|
|
|
TOOLDIR Directory to hold the host tools, once built. If specified, |
TOOLDIR Directory to hold the host tools, once built. If specified, |
must be an absolute path. This directory should be unique to |
must be an absolute path. This directory should be unique to |
a given host system and NetBSD source tree. (However, multi- |
a given host system and NetBSD source tree. (However, |
ple targets may share the same TOOLDIR; the target-dependent |
multiple targets may share the same TOOLDIR; the target- |
files have unique names.) If unset, a default based on the |
dependent files have unique names.) If unset, a default |
uname(1) information of the host platform will be created in |
based on the uname(1) information of the host platform will |
the .OBJDIR of src. |
be created in the .OBJDIR of src. |
|
|
Default: Unset. |
Default: Unset. |
|
|
|
|
specific for that tool. |
specific for that tool. |
|
|
never Do not use the tools from TOOLDIR, even when building |
never Do not use the tools from TOOLDIR, even when building |
native tool components. This is similar to the tradi- |
native tool components. This is similar to the |
tional NetBSD build method, but does not verify that |
traditional NetBSD build method, but does not verify |
the compilation tools in use are up-to-date enough in |
that the compilation tools in use are up-to-date |
order to build the tree successfully. This may cause |
enough in order to build the tree successfully. This |
build or runtime problems when building the whole |
may cause build or runtime problems when building the |
NetBSD source tree. |
whole NetBSD source tree. |
|
|
Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''. |
Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''. |
|
|
|
|
If using build.sh, the default is ``yes''. This may be |
If using build.sh, the default is ``yes''. This may be |
set back to ``no'' by giving build.sh the -o option. |
set back to ``no'' by giving build.sh the -o option. |
|
|
MKUPDATE Can be set to ``yes'' or ``no''. If set, then in addi- |
MKUPDATE Can be set to ``yes'' or ``no''. If set, then in |
tion to the effects described for MKUPDATE=yes above, |
addition to the effects described for MKUPDATE=yes |
this implies the effects of NOCLEANDIR (i.e., ``make |
above, this implies the effects of NOCLEANDIR (i.e., |
cleandir'' is avoided). |
``make cleandir'' is avoided). |
|
|
Default: ``no'' |
Default: ``no'' |
|
|
|
|
use .WAIT or have explicit dependencies as necessary to |
use .WAIT or have explicit dependencies as necessary to |
enforce build ordering. |
enforce build ordering. |
|
|
-m dir Specify the default directory for searching for system Make- |
-m dir Specify the default directory for searching for system |
file segments, mainly the <bsd.*.mk> files. When building any |
Makefile segments, mainly the <bsd.*.mk> files. When building |
full NetBSD source tree, this should be set to the |
any full NetBSD source tree, this should be set to the |
``share/mk'' directory in the source tree. This is set auto- |
``share/mk'' directory in the source tree. This is set |
matically when building from the top level, or when using |
automatically when building from the top level, or when using |
build.sh. |
build.sh. |
|
|
-n Display the commands that would have been executed, but do not |
-n Display the commands that would have been executed, but do not |
|
|
-V var Print make(1)'s idea of the value of var. Does not build any |
-V var Print make(1)'s idea of the value of var. Does not build any |
targets. |
targets. |
|
|
var=value Set the variable var to value, overriding any setting speci- |
var=value Set the variable var to value, overriding any setting |
fied by the process environment, the MAKECONF configuration |
specified by the process environment, the MAKECONF |
file, or the system Makefile segments. |
configuration file, or the system Makefile segments. |
|
|
"make" targets |
"make" targets |
These default targets may be built by running make(1) in any subtree of |
These default targets may be built by running make(1) in any subtree of |
|
|
|
|
installworld Install the distribution from DESTDIR to INSTALLWORLDDIR, |
installworld Install the distribution from DESTDIR to INSTALLWORLDDIR, |
which defaults to the root directory. Ensures that |
which defaults to the root directory. Ensures that |
INSTALLWORLDDIR is not the root directory if cross compil- |
INSTALLWORLDDIR is not the root directory if cross |
ing. |
compiling. |
|
|
The INSTALLSETS environment variable may be set to a space- |
The INSTALLSETS environment variable may be set to a space- |
separated list of distribution sets to be installed. By |
separated list of distribution sets to be installed. By |
|
|
a layout as described in release(7). |
a layout as described in release(7). |
|
|
For most machine types, the CD-ROM will be bootable, and |
For most machine types, the CD-ROM will be bootable, and |
will automatically run the sysinst(8) menu-based installa- |
will automatically run the sysinst(8) menu-based |
tion program, which can be used to install or upgrade a |
installation program, which can be used to install or |
NetBSD system. Bootable CD-ROMs also contain tools that |
upgrade a NetBSD system. Bootable CD-ROMs also contain |
may be useful in repairing a damaged NetBSD installation. |
tools that may be useful in repairing a damaged NetBSD |
|
installation. |
|
|
Before ``make iso-image'' is attempted, RELEASEDIR must be |
Before ``make iso-image'' is attempted, RELEASEDIR must be |
populated by ``make release'' or equivalent. |
populated by ``make release'' or equivalent. |
|
|
Note that other, smaller, CD-ROM images may be created in |
Note that other, smaller, CD-ROM images may be created in |
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc- |
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom |
tory by ``make release''. These smaller images usually |
directory by ``make release''. These smaller images |
contain the same tools as the larger images in |
usually contain the same tools as the larger images in |
RELEASEDIR/iso, but do not contain additional content such |
RELEASEDIR/iso, but do not contain additional content such |
as the distribution sets. |
as the distribution sets. |
|
|
Note that the mac68k port still uses an older method of |
Note that the mac68k port still uses an older method of |
creating CD-ROM images. This requires the mkisofs(1) util- |
creating CD-ROM images. This requires the mkisofs(1) |
ity, which is not part of NetBSD, but which can be |
utility, which is not part of NetBSD, but which can be |
installed from pkgsrc/sysutils/cdrtools. |
installed from pkgsrc/sysutils/cdrtools. |
|
|
iso-image-source |
iso-image-source |
|
|
level directories for the machine type and source. |
level directories for the machine type and source. |
|
|
For most machine types, the CD-ROM will be bootable, and |
For most machine types, the CD-ROM will be bootable, and |
will automatically run the sysinst(8) menu-based installa- |
will automatically run the sysinst(8) menu-based |
tion program, which can be used to install or upgrade a |
installation program, which can be used to install or |
NetBSD system. Bootable CD-ROMs also contain tools that |
upgrade a NetBSD system. Bootable CD-ROMs also contain |
may be useful in repairing a damaged NetBSD installation. |
tools that may be useful in repairing a damaged NetBSD |
|
installation. |
|
|
Before ``make iso-image-source'' is attempted, RELEASEDIR |
Before ``make iso-image-source'' is attempted, RELEASEDIR |
must be populated by ``make sourcesets release'' or equiva- |
must be populated by ``make sourcesets release'' or |
lent. |
equivalent. |
|
|
Note that other, smaller, CD-ROM images may be created in |
Note that other, smaller, CD-ROM images may be created in |
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc- |
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom |
tory by ``make release''. These smaller images usually |
directory by ``make release''. These smaller images |
contain the same tools as the larger images in |
usually contain the same tools as the larger images in |
RELEASEDIR/iso, but do not contain additional content such |
RELEASEDIR/iso, but do not contain additional content such |
as the distribution sets. |
as the distribution sets. |
|
|
Note that the mac68k port still uses an older method of |
Note that the mac68k port still uses an older method of |
creating CD-ROM images. This requires the mkisofs(1) util- |
creating CD-ROM images. This requires the mkisofs(1) |
ity, which is not part of NetBSD, but which can be |
utility, which is not part of NetBSD, but which can be |
installed from pkgsrc/sysutils/cdrtools. |
installed from pkgsrc/sysutils/cdrtools. |
|
|
install-image |
install-image |
|
|
install-image'' relies on information in DESTDIR/METALOG. |
install-image'' relies on information in DESTDIR/METALOG. |
|
|
live-image Create NetBSD live images in the |
live-image Create NetBSD live images in the |
RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage direc- |
RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage |
tory. The live image contains all necessary files to boot |
directory. The live image contains all necessary files to |
NetBSD up to multi-user mode, including all files which |
boot NetBSD up to multi-user mode, including all files |
should be extracted during installation, NetBSD disklabel, |
which should be extracted during installation, NetBSD |
bootloaders, etc. |
disklabel, bootloaders, etc. |
|
|
The live image is suitable for use as a disk image in vir- |
The live image is suitable for use as a disk image in |
tual machine environments such as QEMU, and also useful to |
virtual machine environments such as QEMU, and also useful |
boot NetBSD from a USB flash memory stick on a real |
to boot NetBSD from a USB flash memory stick on a real |
machine, without the need for installation. |
machine, without the need for installation. |
|
|
Before ``make live-image'' is attempted, RELEASEDIR must be |
Before ``make live-image'' is attempted, RELEASEDIR must be |
|
|
regression-tests |
regression-tests |
Can only be run after building the regression tests in the |
Can only be run after building the regression tests in the |
directory ``regress''. Runs those compiled regression |
directory ``regress''. Runs those compiled regression |
tests on the local host. Note that most tests are now man- |
tests on the local host. Note that most tests are now |
aged instead using atf(7); this target should probably run |
managed instead using atf(7); this target should probably |
those as well but currently does not. |
run those as well but currently does not. |
|
|
The "build.sh" script |
The "build.sh" script |
This script file is a shell script designed to build the entire NetBSD |
This script file is a shell script designed to build the entire NetBSD |
system on any host with a suitable modern shell and some common utili- |
system on any host with a suitable modern shell and some common |
ties. The required shell features are described under the HOST_SH vari- |
utilities. The required shell features are described under the HOST_SH |
able. |
variable. |
|
|
If a host system's default shell does support the required features, then |
If a host system's default shell does support the required features, then |
we suggest that you explicitly specify a suitable shell using a command |
we suggest that you explicitly specify a suitable shell using a command |
|
|
|
|
All cross-compile builds, and most native builds, of the entire system |
All cross-compile builds, and most native builds, of the entire system |
should make use of build.sh rather than just running ``make''. This way, |
should make use of build.sh rather than just running ``make''. This way, |
the make(1) program will be bootstrapped properly, in case the host sys- |
the make(1) program will be bootstrapped properly, in case the host |
tem has an older or incompatible ``make'' program. |
system has an older or incompatible ``make'' program. |
|
|
When compiling the entire system via build.sh, many make(1) variables are |
When compiling the entire system via build.sh, many make(1) variables are |
set for you in order to help encapsulate the build process. In the list |
set for you in order to help encapsulate the build process. In the list |
|
|
release Build a full release as per ``make release''. This command |
release Build a full release as per ``make release''. This command |
first runs the distribution operation. |
first runs the distribution operation. |
|
|
makewrapper Create the nbmake-MACHINE wrapper. This operation is auto- |
makewrapper Create the nbmake-MACHINE wrapper. This operation is |
matically performed for any of the other operations. |
automatically performed for any of the other operations. |
|
|
cleandir Perform ``make cleandir''. |
cleandir Perform ``make cleandir''. |
|
|
obj Perform ``make obj''. |
obj Perform ``make obj''. |
|
|
tools Build and install the host tools from src/tools. This com- |
tools Build and install the host tools from src/tools. This |
mand will first run ``make obj'' and ``make cleandir'' in |
command will first run ``make obj'' and ``make cleandir'' |
the tools subdirectory unless the -o or -u options (respec- |
in the tools subdirectory unless the -o or -u options |
tively) are given. |
(respectively) are given. |
|
|
install=idir Install the contents of DESTDIR to idir, using ``make |
install=idir Install the contents of DESTDIR to idir, using ``make |
installworld''. Note that files that are part of the |
installworld''. Note that files that are part of the |
|
|
This command will run ``make cleandir'' on the kernel in |
This command will run ``make cleandir'' on the kernel in |
question first unless the -u option is given. |
question first unless the -u option is given. |
|
|
|
kernel.gdb=kconf |
|
Build a new kernel with debug information. Similar to the |
|
above kernel=kconf operation, but creates a netbsd.gdb file |
|
alongside of the kernel netbsd, which contains a full |
|
symbol table and can be used for debugging (for example |
|
with a cross-gdb built by MKCROSSGDB). |
|
|
modules This command will build kernel modules and install them |
modules This command will build kernel modules and install them |
into DESTDIR. |
into DESTDIR. |
|
|
|
|
Install a gzip(1)ed copy of the kernel previously built by |
Install a gzip(1)ed copy of the kernel previously built by |
kernel=kconf into |
kernel=kconf into |
RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as |
RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as |
netbsd-kconf.gz, although the ``netbsd'' prefix is deter- |
netbsd-kconf.gz, although the ``netbsd'' prefix is |
mined from the ``config'' directives in kconf. |
determined from the ``config'' directives in kconf. |
|
|
sets Perform ``make sets''. |
sets Perform ``make sets''. |
|
|
|
|
``nbmake-MACHINE-BUILDID''. |
``nbmake-MACHINE-BUILDID''. |
|
|
-C cdextras |
-C cdextras |
Append cdextras to the CDEXTRA variable, which is a space-sepa- |
Append cdextras to the CDEXTRA variable, which is a space- |
rated list of files or directories that will be added to the |
separated list of files or directories that will be added to |
CD-ROM image that may be create by the ``iso-image'' or |
the CD-ROM image that may be create by the ``iso-image'' or |
``iso-image-source'' operations. Files will be added to the |
``iso-image-source'' operations. Files will be added to the |
root of the CD-ROM image, whereas directories will be copied |
root of the CD-ROM image, whereas directories will be copied |
recursively. If relative paths are specified, they will be |
recursively. If relative paths are specified, they will be |
|
|
may be specified via multiple -C options, or via a single |
may be specified via multiple -C options, or via a single |
option whose argument contains multiple space-separated paths. |
option whose argument contains multiple space-separated paths. |
|
|
-D dest Set the value of DESTDIR to dest. If a relative path is speci- |
-D dest Set the value of DESTDIR to dest. If a relative path is |
fied, it will be converted to an absolute path before being |
specified, it will be converted to an absolute path before |
used. |
being used. |
|
|
-E Set `expert' mode. This overrides various sanity checks, and |
-E Set `expert' mode. This overrides various sanity checks, and |
allows: DESTDIR does not have to be set to a non-root path for |
allows: DESTDIR does not have to be set to a non-root path for |
builds, and MKUNPRIVED=yes does not have to be set when build- |
builds, and MKUNPRIVED=yes does not have to be set when |
ing as a non-root user. |
building as a non-root user. |
|
|
Note: It is highly recommended that you know what you are doing |
Note: It is highly recommended that you know what you are doing |
when you use this option. |
when you use this option. |
|
|
|
|
-j njob Run up to njob make(1) subjobs in parallel; passed through to |
-j njob Run up to njob make(1) subjobs in parallel; passed through to |
make(1). If you see failures for reasons other than running |
make(1). If you see failures for reasons other than running |
out of memory while using build.sh with -j, please save com- |
out of memory while using build.sh with -j, please save |
plete build logs so the failures can be analyzed. |
complete build logs so the failures can be analyzed. |
|
|
To achieve the fastest builds, -j values between (1 + the num- |
To achieve the fastest builds, -j values between (1 + the |
ber of CPUs) and (2 * the number of CPUs) are recommended. Use |
number of CPUs) and (2 * the number of CPUs) are recommended. |
lower values on machines with limited memory or I/O bandwidth. |
Use lower values on machines with limited memory or I/O |
|
bandwidth. |
|
|
-M obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR. See ``-O |
-M obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR. See ``-O |
-obj'' for more information. |
obj'' for more information. |
|
|
For instance, if the source directory is /usr/src, a setting of |
For instance, if the source directory is /usr/src, a setting of |
``-M /usr/obj'' will place build-time files under |
``-M /usr/obj'' will place build-time files under |
|
|
/usr/obj/usr/src/usr.bin, and so forth. |
/usr/obj/usr/src/usr.bin, and so forth. |
|
|
If a relative path is specified, it will be converted to an |
If a relative path is specified, it will be converted to an |
absolute path before being used. build.sh imposes the restric- |
absolute path before being used. build.sh imposes the |
tion that the argument to the -M option must not begin with a |
restriction that the argument to the -M option must not begin |
``$'' (dollar sign) character; otherwise it would be too diffi- |
with a ``$'' (dollar sign) character; otherwise it would be too |
cult to determine whether the value is an absolute or a rela- |
difficult to determine whether the value is an absolute or a |
tive path. If the directory does not already exist, build.sh |
relative path. If the directory does not already exist, |
will create it. |
build.sh will create it. |
|
|
-m mach Set the value of MACHINE to mach, except in some special cases |
-m mach Set the value of MACHINE to mach, except in some special cases |
listed below. This will also override any value of |
listed below. This will also override any value of |
|
|
and so forth. |
and so forth. |
|
|
If a relative path is specified, it will be converted to an |
If a relative path is specified, it will be converted to an |
absolute path before being used. build.sh imposes the restric- |
absolute path before being used. build.sh imposes the |
tion that the argument to the -O option must not contain a |
restriction that the argument to the -O option must not contain |
``$'' (dollar sign) character. If the directory does not |
a ``$'' (dollar sign) character. If the directory does not |
already exist, build.sh will create it. |
already exist, build.sh will create it. |
|
|
In normal use, exactly one of the -M or -O options should be |
In normal use, exactly one of the -M or -O options should be |
|
|
-S seed Change the value of BUILDSEED to seed. This should rarely be |
-S seed Change the value of BUILDSEED to seed. This should rarely be |
necessary. |
necessary. |
|
|
-T tools Set the value of TOOLDIR to tools. If a relative path is spec- |
-T tools Set the value of TOOLDIR to tools. If a relative path is |
ified, it will be converted to an absolute path before being |
specified, it will be converted to an absolute path before |
used. If set, the bootstrap ``make'' will only be rebuilt if |
being used. If set, the bootstrap ``make'' will only be |
the source files for make(1) have changed. |
rebuilt if the source files for make(1) have changed. |
|
|
-U Set MKUNPRIVED=yes. |
-U Set MKUNPRIVED=yes. |
|
|
|
|
propagated to the nbmake wrapper. |
propagated to the nbmake wrapper. |
|
|
-w wrapper |
-w wrapper |
Create the nbmake wrapper script (see below) in a custom loca- |
Create the nbmake wrapper script (see below) in a custom |
tion, specified by wrapper. This allows, for instance, to |
location, specified by wrapper. This allows, for instance, to |
place the wrapper in PATH automatically. Note that wrapper is |
place the wrapper in PATH automatically. Note that wrapper is |
the full name of the file, not just a directory name. If a |
the full name of the file, not just a directory name. If a |
relative path is specified, it will be converted to an absolute |
relative path is specified, it will be converted to an absolute |
|
|
subtrees on a cross-compile host. |
subtrees on a cross-compile host. |
|
|
nbmake-MACHINE can be invoked in lieu of make(1), and will instead call |
nbmake-MACHINE can be invoked in lieu of make(1), and will instead call |
the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with sev- |
the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with |
eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR. |
several key variables pre-set, including MACHINE, MACHINE_ARCH, and |
nbmake-MACHINE will also set variables specified with -V, and unset vari- |
TOOLDIR. nbmake-MACHINE will also set variables specified with -V, and |
ables specified with -Z. |
unset variables specified with -Z. |
|
|
This script can be symlinked into a directory listed in PATH, or called |
This script can be symlinked into a directory listed in PATH, or called |
with an absolute path. |
with an absolute path. |
|
|
3. # ./build.sh [options] -U install=/ |
3. # ./build.sh [options] -U install=/ |
|
|
As root, install to / the distribution that was built by example 2. |
As root, install to / the distribution that was built by example 2. |
Even though this is run as root, -U is required so that the permis- |
Even though this is run as root, -U is required so that the |
sions stored in DESTDIR/METALOG are correctly applied to the files |
permissions stored in DESTDIR/METALOG are correctly applied to the |
as they're copied to /. |
files as they're copied to /. |
|
|
4. % ./build.sh [options] -U -u release |
4. % ./build.sh [options] -U -u release |
|
|
|
|
The build.sh based build scheme was introduced for NetBSD 1.6 as |
The build.sh based build scheme was introduced for NetBSD 1.6 as |
USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. |
USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. |
|
|
NetBSD September 19, 2012 NetBSD |
NetBSD November 8, 2012 NetBSD |