version 1.50, 2004/03/19 12:34:39 |
version 1.62.4.3, 2008/03/23 00:12:06 |
|
|
BUILDING(8) NetBSD System Manager's Manual BUILDING(8) |
BUILDING(8) NetBSD System Manager's Manual BUILDING(8) |
|
|
NAME |
NAME |
BUILDING - Procedure for building NetBSD from source code. |
BUILDING -- Procedure for building NetBSD from source code. |
|
|
STATUS |
|
This document is a work-in-progress. As such, the information described |
|
here may not match the reality of the build system as of this writing. |
|
Once this document is completely in sync with reality, this paragraph |
|
will be removed. |
|
|
|
Discrepancies between this documentation and the current reality of |
|
implementation 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 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. |
|
|
|
REQUIREMENTS |
REQUIREMENTS |
NetBSD is designed to be buildable on most POSIX-compliant host systems. |
NetBSD is designed to be buildable on most POSIX-compliant host systems. |
|
|
host system to create a build toolchain for the target architecture. The |
host system to create a build toolchain for the target architecture. The |
host system must have at least C and C++ compilers in order to create the |
host system must have at least C and C++ compilers in order to create the |
toolchain (make is not required); all other tools are created as part of |
toolchain (make is not required); all other tools are created as part of |
the NetBSD build process. |
the NetBSD build process. (See the environment variables section below |
|
if you need to override or manually select your compilers.) |
|
|
FILES |
FILES |
Source tree layout |
Source tree layout |
|
|
Environment variables |
Environment variables |
Several environment variables control the behaviour of NetBSD builds. |
Several environment variables control the behaviour of NetBSD builds. |
|
|
|
HOST_SH Path name to a POSIX-compliant shell. If this is not |
|
set explicitly, then the default is set using heuris- |
|
tics dependent on the host platform, or from the shell |
|
under which build.sh is executed (if that can be deter- |
|
mined), or using the first copy of sh found in PATH. |
|
If the host system's /bin/sh is not POSIX-compliant, we |
|
suggest that you build using commands like |
|
|
|
HOST_SH=/path/to/working/shell |
|
export HOST_SH |
|
${HOST_SH} build.sh [options] |
|
|
|
HOST_CC Path name to C compiler used to create the toolchain. |
|
|
|
HOST_CXX Path name to C++ compiler used to create the toolchain. |
|
|
MACHINE Machine type. |
MACHINE Machine type. |
|
|
MACHINE_ARCH Machine architecture. |
MACHINE_ARCH Machine architecture. |
|
|
MAKEFLAGS Flags to invoke make(1) with. |
MAKEFLAGS Flags to invoke make(1) with. |
|
|
MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- |
MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- |
tory. Used only if MAKEOBJDIRPREFIX is not defined. |
tory. The value is subjected to variable expansion by |
|
make(1). Used only if MAKEOBJDIRPREFIX is not defined. |
MAKEOBJDIR can only be provided in the environment or |
MAKEOBJDIR can only be provided in the environment or |
via the -O flag of build.sh. |
via the -O flag of build.sh. |
|
|
MAKEOBJDIRPREFIX Top level directory of the object directory tree. If |
MAKEOBJDIRPREFIX Top level directory of the object directory tree. If |
this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used |
specified, must be an absolute path. If this is |
as the .OBJDIR for the current directory. The current |
defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the |
directory may be read only. MAKEOBJDIRPREFIX can only |
.OBJDIR for the current directory. The current direc- |
be provided in the environment or via the -M flag of |
tory may be read only. MAKEOBJDIRPREFIX can only be |
|
provided in the environment or via the -M flag of |
build.sh. |
build.sh. |
|
|
"make" variables |
"make" variables |
|
|
DESTDIR Directory to contain the built NetBSD system. If set, spe- |
DESTDIR Directory to contain the built NetBSD system. If set, spe- |
cial options are passed to the compilation tools to prevent |
cial options are passed to the compilation tools to prevent |
their default use of the host system's /usr/include, |
their default use of the host system's /usr/include, |
/usr/lib, and so forth. This pathname should not end with a |
/usr/lib, and so forth. This pathname must be an absolute |
slash (/) character (for installation into the system's root |
path, and should not end with a slash (/) character. (For |
directory, set DESTDIR to an empty string). The directory |
installation into the system's root directory, set DESTDIR to |
must reside on a file system which supports long file names |
an empty string, not to ``/''). The directory must reside on |
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 other- |
wise. |
wise. |
|
|
|
|
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, permis- |
sions, and file flags, will not be set on the installed item; |
sions, and file flags, will not be set on the installed |
instead the information will be appended to a file called |
items; instead the information will be appended to a file |
METALOG in DESTDIR. The contents of METALOG is used during |
called METALOG in DESTDIR. The contents of METALOG are used |
the generation of the distribution tar files to ensure that |
during the generation of the distribution tar files to ensure |
the appropriate file ownership is stored. |
that the appropriate file ownership is stored. |
|
|
Default: ``no'' |
Default: ``no'' |
|
|
|
|
|
|
Default: ``no'' |
Default: ``no'' |
|
|
TOOLDIR Directory to hold the host tools, once built. This directory |
TOOLDIR Directory to hold the host tools, once built. If specified, |
should be unique to a given host system and NetBSD source |
must be an absolute path. This directory should be unique to |
tree. (However, multiple targets may share the same TOOLDIR; |
a given host system and NetBSD source tree. (However, multi- |
the target-dependent files have unique names.) If unset, a |
ple targets may share the same TOOLDIR; the target-dependent |
default based on the uname(1) information of the host plat- |
files have unique names.) If unset, a default based on the |
form will be created in the .OBJDIR of src. |
uname(1) information of the host platform will be created in |
|
the .OBJDIR of src. |
|
|
Default: Unset. |
Default: Unset. |
|
|
|
|
preserve traditional semantics of the <bsd.*.mk> make(1) |
preserve traditional semantics of the <bsd.*.mk> make(1) |
include files). |
include files). |
|
|
X11SRCDIR Directory containing the X11R6 source. The main X11R6 source |
X11SRCDIR Directory containing the X11R6 source. If specified, must be |
is found in X11SRCDIR/xfree/xc. |
an absolute path. The main X11R6 source is found in |
|
X11SRCDIR/xfree/xc. |
|
|
Default: ``/usr/xsrc'' |
Default: ``/usr/xsrc'' |
|
|
|
|
manually building subtrees of the NetBSD source code. |
manually building subtrees of the NetBSD source code. |
|
|
INSTALLWORLDDIR Location for the ``make installworld'' target to install |
INSTALLWORLDDIR Location for the ``make installworld'' target to install |
to. |
to. If specified, must be an absolute path. |
|
|
Default: ``/'' |
Default: ``/'' |
|
|
|
|
|
|
RELEASEDIR If set, specifies the directory to which a release(7) |
RELEASEDIR If set, specifies the directory to which a release(7) |
layout will be written at the end of a ``make release''. |
layout will be written at the end of a ``make release''. |
|
If specified, must be an absolute path. |
|
|
Default: Unset. |
Default: Unset. |
|
|
|
|
|
|
BUILDING |
BUILDING |
"make" command line options |
"make" command line options |
This is only a summary of options available to make(1); only the options |
This is not a summary of all the options available to make(1); only the |
used most frequently with NetBSD builds are listed here. |
options used most frequently with NetBSD builds are listed here. |
|
|
-j njob Run up to njob make(1) subjobs in parallel. Makefiles should |
-j njob Run up to njob make(1) subjobs in parallel. Makefiles should |
use .WAIT or have explicit dependancies as necessary to |
use .WAIT or have explicit dependencies as necessary to |
enforce build ordering. If you see build failures with -j, |
enforce build ordering. If you see build failures with -j, |
please save complete build logs so the failures can be ana- |
please save complete build logs so the failures can be ana- |
lyzed. |
lyzed. |
|
|
Additional make(1) targets are usable specifically from the top source |
Additional make(1) targets are usable specifically from the top source |
level to facilitate building the entire NetBSD source tree. |
level to facilitate building the entire NetBSD source tree. |
|
|
build Build the entire NetBSD system. This orders portions of |
build Build the entire NetBSD system (except the kernel). This |
the source tree such that prerequisites will be built in |
orders portions of the source tree such that prerequisites |
the proper order. |
will be built in the proper order. |
|
|
distribution Do a ``make build'', and then install a full distribution |
distribution Do a ``make build'', and then install a full distribution |
into DESTDIR, including files in DESTDIR/dev, DESTDIR/etc, |
(which does not include a kernel) into DESTDIR, including |
DESTDIR/root and DESTDIR/var. |
files in DESTDIR/dev, DESTDIR/etc, DESTDIR/root and |
|
DESTDIR/var. |
|
|
buildworld As per ``make distribution'', except that it ensures that |
buildworld As per ``make distribution'', except that it ensures that |
DESTDIR is not the root directory. |
DESTDIR is not the root directory. |
|
|
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 the not root directory if cross compil- |
INSTALLWORLDDIR is not the root directory if cross compil- |
ing. |
ing. |
|
|
Note: It is highly recommended that you upgrade your kernel |
The INSTALLSETS environment variable may be set to a list |
and reboot before performing this operation. |
of distribution sets to be installed. By default, all sets |
|
except ``etc'' and ``xetc'' are installed (so most files in |
|
INSTALLWORLDDIR/etc will not be installed or modified). |
|
|
|
Note: Before performing this operation with |
|
INSTALLWORLDDIR=/, it is highly recommended that you |
|
upgrade your kernel and reboot. After performing this |
|
operation, it is recommended that you use etcupdate(8) to |
|
update files in INSTALLWORLDDIR/etc and that you use |
|
postinstall(8) to check for inconsistencies (and possibly |
|
to fix them). |
|
|
sets Create distribution sets from DESTDIR into |
sets Create distribution sets from DESTDIR into |
RELEASEDIR/MACHINE/binary/sets. Should be run after ``make |
RELEASEDIR/RELEASEMACHINEDIR/binary/sets. Should be run |
distribution'' (as ``make build'' does not install all of |
after ``make distribution'' (as ``make build'' does not |
the required files). |
install all of the required files). |
|
|
sourcesets Create source sets of the source tree into |
sourcesets Create source sets of the source tree into |
RELEASEDIR/source/sets. |
RELEASEDIR/source/sets. |
|
|
|
syspkgs Create syspkgs from DESTDIR into |
|
RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs. Should be run |
|
after ``make distribution'' (as ``make build'' does not |
|
install all of the required files). |
|
|
release Do a ``make distribution'', build kernels, distribution |
release Do a ``make distribution'', build kernels, distribution |
media, and install sets (this as per ``make sets''), and |
media, and install sets (this as per ``make sets''), and |
then package the system into a standard release layout as |
then package the system into a standard release layout as |
described by release(7). This requires that RELEASEDIR be |
described by release(7). This requires that RELEASEDIR be |
set (see above). |
set (see above). |
|
|
|
iso-image Create a NetBSD installation CD-ROM image in the |
|
RELEASEDIR/iso directory. The CD-ROM file system will have |
|
a layout as described in release(7). |
|
|
|
For most machine types, the CD-ROM will be bootable, and |
|
will automatically run the sysinst(8) menu-based installa- |
|
tion program, which can be used to install or upgrade a |
|
NetBSD system. Bootable CD-ROMs also contain tools that |
|
may be useful in repairing a damaged NetBSD installation. |
|
|
|
Before ``make iso-image'' is attempted, RELEASEDIR must be |
|
populated by ``make release'' or equivalent. |
|
|
|
Note that other, smaller, CD-ROM images may be created in |
|
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc- |
|
tory by ``make release''. These smaller images usually |
|
contain the same tools as the larger images in |
|
RELEASEDIR/iso, but do not contain additional content such |
|
as the distribution sets. |
|
|
|
Note that the mac68k port still uses an older method of |
|
creating CD-ROM images. This requires the mkisofs(1) util- |
|
ity, which is not part of NetBSD, but which can be |
|
installed from pkgsrc/sysutils/cdrtools. |
|
|
|
iso-image-source |
|
Create a NetBSD installation CD-ROM image in the |
|
RELEASEDIR/iso directory. The CD-ROM file system will have |
|
a layout as described in release(7). It will have top |
|
level directories for the machine type and source. |
|
|
|
For most machine types, the CD-ROM will be bootable, and |
|
will automatically run the sysinst(8) menu-based installa- |
|
tion program, which can be used to install or upgrade a |
|
NetBSD system. Bootable CD-ROMs also contain tools that |
|
may be useful in repairing a damaged NetBSD installation. |
|
|
|
Before ``make iso-image-source'' is attempted, RELEASEDIR |
|
must be populated by ``make sourcesets release'' or equiva- |
|
lent. |
|
|
|
Note that other, smaller, CD-ROM images may be created in |
|
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc- |
|
tory by ``make release''. These smaller images usually |
|
contain the same tools as the larger images in |
|
RELEASEDIR/iso, but do not contain additional content such |
|
as the distribution sets. |
|
|
|
Note that the mac68k port still uses an older method of |
|
creating CD-ROM images. This requires the mkisofs(1) util- |
|
ity, which is not part of NetBSD, but which can be |
|
installed from pkgsrc/sysutils/cdrtools. |
|
|
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 the compiled regression tests |
directory ``regress''. Runs the compiled regression tests |
|
|
tools Build and install the host tools from src/tools. |
tools Build and install the host tools from src/tools. |
|
|
install=idir Install the contents of DESTDIR to idir, using ``make |
install=idir Install the contents of DESTDIR to idir, using ``make |
installworld''. |
installworld''. Note that files that are part of the |
|
``etc'' or ``xetc'' sets will not be installed. |
|
|
kernel=kconf Build a new kernel. The kconf argument is the name of a |
kernel=kconf Build a new kernel. The kconf argument is the name of a |
configuration file suitable for use by config(8). If kconf |
configuration file suitable for use by config(1). If kconf |
does not contain any `/' characters, the configuration file |
does not contain any `/' characters, the configuration file |
is expected to be found in the KERNCONFDIR directory, which |
is expected to be found in the KERNCONFDIR directory, which |
is typically sys/arch/MACHINE/conf. The new kernel will be |
is typically sys/arch/MACHINE/conf. The new kernel will be |
|
|
|
|
releasekernel=kconf |
releasekernel=kconf |
Install a gzip(1)ed copy of the kernel built by |
Install a gzip(1)ed copy of the kernel built by |
kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually |
kernel=kconf into |
as netbsd-kconf.gz, although the ``netbsd'' prefix is |
RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as |
determined from the ``config'' directives in kconf. |
netbsd-kconf.gz, although the ``netbsd'' prefix is deter- |
|
mined from the ``config'' directives in kconf. |
|
|
sets Perform ``make sets''. |
sets Perform ``make sets''. |
|
|
sourcesets Perform ``make sourcesets''. |
sourcesets Perform ``make sourcesets''. |
|
|
The following command line options alter the behaviour of the above oper- |
syspkgs Perform ``make syspkgs''. |
ations: The following command line options alter the behaviour of the |
|
build.sh operations described above: |
iso-image Perform ``make iso-image''. |
|
|
|
iso-image-source |
|
Perform ``make iso-image-source''. |
|
|
|
The following command line options alter the behaviour of the build.sh |
|
operations described above: |
|
|
-a arch Set the value of MACHINE_ARCH to arch. |
-a arch Set the value of MACHINE_ARCH to arch. |
|
|
-B buildid |
-B buildid |
Set the value of BUILDID to buildid. This will also append the |
Set the value of BUILDID to buildid. This will also append the |
build idenfitier to the name of the ``make'' wrapper script so |
build identifier to the name of the ``make'' wrapper script so |
that the resulting name is of the form |
that the resulting name is of the form |
``nbmake-MACHINE-BUILDID''. |
``nbmake-MACHINE-BUILDID''. |
|
|
-D dest Set the value of DESTDIR to dest. |
-C cdextras |
|
Set the value of CDEXTRA to cdextras which is a space-separated |
|
list of files or directories which will be added in order to |
|
the CD-ROM image when used in conjunction with ``iso-image'' or |
|
``iso-image-source''. Files will be added to the root of the |
|
CD-ROM image, whereas directories will be copied recursively. |
|
If relative paths are specified, they will be converted to |
|
absolute paths before being used. |
|
|
|
-D dest Set the value of DESTDIR to dest. If a relative path is speci- |
|
fied, it will be converted to an absolute path before 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 |
|
|
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. |
|
|
|
-h Print a help message. |
|
|
-j njob Passed through to make(1). Makefiles should use .WAIT or have |
-j njob Passed through to make(1). Makefiles should use .WAIT or have |
explicit dependancies as necessary to enforce build ordering. |
explicit dependancies as necessary to enforce build ordering. |
If you see build failures with -j, please save complete build |
If you see build failures with -j, please save complete build |
logs so the failures can be analyzed. |
logs so the failures can be analyzed. |
|
|
-M obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR. |
-M obj Set MAKEOBJDIRPREFIX to obj. If a relative path is specified, |
|
it will be converted to an absolute path before being used. |
-m mach Set the value of MACHINE to mach. This will also override any |
Unsets MAKEOBJDIR. |
value of MACHINE_ARCH in the process environment with a value |
|
deduced from mach, unless -a is specified, or mach is a special |
-m mach Set the value of MACHINE to mach, except in some special cases |
case listed below. All cross builds require -m, but if unset |
listed below. This will also override any value of |
on a NetBSD host, the host's value of MACHINE will be detected |
MACHINE_ARCH in the process environment with a value deduced |
and used automatically. |
from mach, unless -a is specified. All cross builds require |
|
-m, but if unset on a NetBSD host, the host's value of MACHINE |
Some machines support multiple values for MACHINE_ARCH. For a |
will be detected and used automatically. |
given value of mach, the following MACHINE and MACHINE_ARCH |
|
values will result: |
Some machines support multiple values for MACHINE_ARCH. The |
|
following special cases for the mach argument are defined to |
|
set the listed values of MACHINE and MACHINE_ARCH: |
|
|
mach MACHINE MACHINE_ARCH |
mach MACHINE MACHINE_ARCH |
|
evbarm evbarm (not set) |
|
evbarm-eb evbarm armeb |
|
evbarm-el evbarm arm |
evbmips evbmips (not set) |
evbmips evbmips (not set) |
evbmips-eb evbmips mipseb |
evbmips-eb evbmips mipseb |
evbmips-el evbmips mipsel |
evbmips-el evbmips mipsel |
|
|
-n''. |
-n''. |
|
|
-O obj Create an appropriate transform macro for MAKEOBJDIR that will |
-O obj Create an appropriate transform macro for MAKEOBJDIR that will |
place the built object files under obj. For instance, a set- |
place the built object files under obj. If a relative path is |
ting of /usr/obj will place build-time files under |
specified, it will be converted to an absolute path before |
/usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth. |
being used. For instance, a setting of /usr/obj will place |
Unsets MAKEOBJDIRPREFIX. |
build-time files under /usr/obj/bin, /usr/obj/lib, |
|
/usr/obj/usr.bin, and so forth. Unsets MAKEOBJDIRPREFIX. |
|
|
-o Set the value of MKOBJDIRS to ``no''. Otherwise, it will be |
-o Set the value of MKOBJDIRS to ``no''. Otherwise, it will be |
automatically set to ``yes'' (which is opposite to the default |
automatically set to ``yes'' (which is opposite to the default |
behaviour). |
behaviour). |
|
|
-R rel Set the value of RELEASEDIR to rel. |
-R rel Set the value of RELEASEDIR to rel. If a relative path is |
|
specified, it will be converted to an absolute path before |
|
being used. |
|
|
-r Remove the contents of DESTDIR and TOOLDIR before building |
-r Remove the contents of DESTDIR and TOOLDIR before building |
(provides a clean starting point). This will skip deleting |
(provides a clean starting point). This will skip deleting |
DESTDIR if building on a native system to the root directory. |
DESTDIR if building on a native system to the root directory. |
|
|
-T tools Set the value of TOOLDIR to tools. If set, the bootstrap |
-T tools Set the value of TOOLDIR to tools. If a relative path is spec- |
``make'' will only be rebuilt as needed (when the source files |
ified, it will be converted to an absolute path before being |
for make(1) change). |
used. If set, the bootstrap ``make'' will only be rebuilt as |
|
needed (when the source files for make(1) change). |
|
|
-U Set MKUNPRIVED=yes. |
-U Set MKUNPRIVED=yes. |
|
|
|
|
Create the nbmake wrapper script (see below) in a custom loca- |
Create the nbmake wrapper script (see below) in a custom loca- |
tion, specified by wrapper. This allows, for instance, to |
tion, 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. |
the full name of the file, not just a directory name. If a |
|
relative path is specified, it will be converted to an absolute |
|
path before being used. |
|
|
-X x11src |
-X x11src |
Set the value of X11SRCDIR to x11src. |
Set the value of X11SRCDIR to x11src. If a relative path is |
|
specified, it will be converted to an absolute path before |
|
being used. |
|
|
-x Set MKX11=yes. |
-x Set MKX11=yes. |
|
|
Line 693 OBSOLETE VARIABLES |
|
Line 803 OBSOLETE VARIABLES |
|
TOOLCHAIN_MISSING=yes. |
TOOLCHAIN_MISSING=yes. |
|
|
SEE ALSO |
SEE ALSO |
make(1), hier(7), release(7) |
make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8), |
|
pkgsrc/sysutils/cdrtools |
|
|
HISTORY |
HISTORY |
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 |
|
|
BUGS |
BUGS |
A few platforms are not yet using this build system. |
A few platforms are not yet using this build system. |
|
|
NetBSD February 6, 2003 NetBSD |
NetBSD March 18, 2008 NetBSD |