version 1.42, 2003/08/19 10:00:29 |
version 1.108, 2014/08/03 09:28:43 |
|
|
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. |
|
|
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 im- |
|
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 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.) |
Note: A couple of host toolchain components are not yet available |
|
in the tools directory. Also, some tools use non-POSIX, non-ANSI C |
|
extensions and need to be standardized. As a result, cross-compil- |
|
ing from systems other than NetBSD is not currently supported. |
|
|
|
FILES |
FILES |
Source tree layout |
Source tree layout |
|
|
|
|
BUILDING This document (in plaintext). |
BUILDING This document (in plaintext). |
|
|
Makefile The main Makefile for NetBSD; should only be run for na- |
tools/compat/README |
tive builds with an appropriately up-to-date version of |
Special notes for cross-hosting a NetBSD build on non- |
|
NetBSD platforms. |
|
|
|
Makefile The main Makefile for NetBSD; should only be run for |
|
native builds with an appropriately up-to-date version of |
NetBSD make(1). (For building from out-of-date systems or |
NetBSD make(1). (For building from out-of-date systems or |
on a non-native host, see the build.sh shell script.) |
on a non-native host, see the build.sh shell script.) |
|
|
|
|
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 na- |
``reachover'' Makefile semantics when building these |
tive 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. |
|
|
regress/ Regression test harness. Can be cross-compiled, but only |
tests/, regress/ |
run natively. |
Regression test harness. Can be cross-compiled, but only |
|
run natively. tests/ uses the atf(7) test framework; |
|
regress/ contains older tests that have not yet been |
|
migrated to atf(7). |
|
|
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 |
any of these directories are missing, they will be skipped |
any of these directories are missing, they will be skipped |
during the build. |
during the build. |
|
|
|
x11/ ``Reachover'' build structure for X11R6; the source is in |
|
X11SRCDIR. |
|
|
Build tree layout |
Build tree layout |
The NetBSD build tree is described in hier(7), and the release layout is |
The NetBSD build tree is described in hier(7), and the release layout is |
described in release(7). |
described in release(7). |
|
|
Environment variables |
Environment variables |
Several environment variables control the behaviour of NetBSD builds. |
Several environment variables control the behaviour of NetBSD builds. |
|
|
MACHINE Machine type. |
HOST_SH Path name to a shell available on the host system and |
|
suitable for use during the build. The NetBSD build |
|
system requires a modern Bourne-like shell with POSIX- |
|
compliant features, and also requires support for the |
|
``local'' keyword to declare local variables in shell |
|
functions (which is a widely-implemented but non- |
|
standardised feature). |
|
|
|
Depending on the host system, a suitable shell may be |
|
/bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a |
|
variant of ksh that supports the ``local'' keyword, |
|
such as ksh88, but not ksh93), or /usr/local/bin/bash. |
|
|
|
Most parts of the build require HOST_SH to be an |
|
absolute path; however, build.sh allows it to be a |
|
simple command name, which will be converted to an |
|
absolute path by searching the PATH. |
|
|
MACHINE_ARCH Machine architecture. |
HOST_CC Path name to C compiler used to create the toolchain. |
|
|
MAKE Path name to invoke make(1) as. |
HOST_CXX Path name to C++ compiler used to create the toolchain. |
|
|
|
MACHINE Machine type, e.g., ``macppc''. |
|
|
MAKEFLAGS Flags to invoke make(1) with. |
MACHINE_ARCH Machine architecture, e.g., ``powerpc''. |
|
|
MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- |
MAKE Path name to invoke make(1) as. |
tory. Used only if MAKEOBJDIRPREFIX is not defined. |
|
MAKEOBJDIR can only be provided in the environment or |
MAKEFLAGS Flags to invoke make(1) with. Note that build.sh |
via the -O flag of build.sh. |
ignores the value of MAKEFLAGS passed in the |
|
environment, but allows MAKEFLAGS to be set via the -V |
MAKEOBJDIRPREFIX Top level directory of the object directory tree. If |
option. |
this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used |
|
as the .OBJDIR for the current directory. The current |
MAKEOBJDIR Directory to use as the .OBJDIR for the current |
directory may be read only. MAKEOBJDIRPREFIX can only |
directory. The value is subjected to variable |
be provided in the environment or via the -M flag of |
expansion by make(1). Typical usage is to set this |
build.sh. |
variable to a value involving the use of |
|
`${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the |
|
value of .OBJDIR from the value of .CURDIR. Used only |
|
if MAKEOBJDIRPREFIX is not defined. MAKEOBJDIR can be |
|
provided only in the environment or via the -O flag of |
|
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 |
|
value is subjected to variable expansion by make(1). |
|
build.sh will create the ${MAKEOBJDIRPREFIX} directory |
|
if necessary, but if make(1) is used without build.sh, |
|
then rules in <bsd.obj.mk> will abort the build if the |
|
${MAKEOBJDIRPREFIX} directory does not exist. If the |
|
value is defined and valid, then |
|
${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the .OBJDIR |
|
for the current directory. The current directory may |
|
be read only. MAKEOBJDIRPREFIX can be provided only in |
|
the environment or via the -M flag of build.sh; it |
|
cannot usefully be set inside a Makefile, including |
|
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. If set, this should be a short |
object directory names, and can be consulted in the make(1) |
string that is suitable for use as part of a file or |
configuration file in order to set additional build parame- |
directory name. The identifier will be appended to object |
ters, such as compiler flags. |
directory names, and can be consulted in the make(1) |
|
configuration file in order to set additional build |
DESTDIR Directory to contain the built NetBSD system. If set, spe- |
parameters, such as compiler flags. It will also be used as |
cial options are passed to the compilation tools to prevent |
part of the kernel version string, which can be printed by |
their default use of the host system's /usr/include, |
``uname -v''. |
/usr/lib, and so forth. This pathname should not end with a |
|
slash (/) character (for installation into the system's root |
Default: Unset. |
directory, set DESTDIR to an empty string). The directory |
|
must reside on a file system which supports long file names |
BUILDINFO This may be a multi-line string containing information about |
and hard links. |
the build. This will appear in DESTDIR/etc/release, and it |
|
will be stored in the buildinfo variable in any kernels that |
|
are built. When such kernels are booted, the sysctl(7) |
|
kern.buildinfo variable will report this value. The string |
|
may contain backslash escape sequences, such as ``\\'' |
|
(representing a backslash character) and ``\n'' (representing |
|
a newline). |
|
|
|
Default: Unset. |
|
|
|
BUILDSEED GCC uses random numbers when compiling C++ code. This |
|
variable seeds the gcc random number generator using the |
|
-frandom-seed flag with this value. By default, it is set to |
|
NetBSD-(majorversion). Using a fixed value causes C++ |
|
binaries to be the same when built from the same sources, |
|
resulting in identical (reproducible) builds. Additional |
|
information is available in the GCC documentation of |
|
-frandom-seed. |
|
|
|
DESTDIR Directory to contain the built NetBSD system. If set, |
|
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 |
|
path, and should not end with a slash (/) character. (For |
|
installation into the system's root directory, set DESTDIR to |
|
an empty string, not to ``/''). 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- |
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. |
|
|
MAKECONF The name of the make(1) configuration file. Only settable in |
MAKECONF The name of the make(1) configuration file. Only settable in |
the process environment. |
the process environment. |
|
|
Default: ``/etc/mk.conf'' |
Default: ``/etc/mk.conf'' |
|
|
MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor- |
MAKEVERBOSE |
matted plaintext manual pages will be created during a build. |
Level of verbosity of status messages. Supported values: |
|
|
Default: ``yes'' |
0 No descriptive messages or commands executed by make(1) |
|
are shown. |
|
|
|
1 Brief messages are shown describing what is being done, |
|
but the actual commands executed by make(1) are not |
|
displayed. |
|
|
|
2 Descriptive messages are shown as above (prefixed with a |
|
`#'), and ordinary commands performed by make(1) are |
|
displayed. |
|
|
|
3 In addition to the above, all commands performed by |
|
make(1) are displayed, even if they would ordinarily |
|
have been hidden through use of the ``@'' prefix in the |
|
relevant makefile. |
|
|
|
4 In addition to the above, commands executed by make(1) |
|
are traced through use of the sh(1) ``-x'' flag. |
|
|
MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto- |
Default: 2 |
graphic code will be included in a build; provided for the |
|
benefit of countries that do not allow strong cryptography. |
MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether |
Will not affect use of the standard low-security password en- |
preformatted plaintext manual pages will be created during a |
cryption system, crypt(3). |
build. |
|
|
|
Default: ``no'' |
|
|
|
MKCROSSGDB Can be set to ``yes'' or ``no''. Create a cross-gdb as a |
|
host tool. |
|
|
|
Default: ``no'' |
|
|
|
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 in- |
documentation destined for DESTDIR/usr/share/doc will be |
stalled during a build. |
installed during a build. |
|
|
|
Default: ``yes'' |
|
|
|
MKHTML Can be set to ``yes'' or ``no''. Indicates whether |
|
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 |
|
modules are built and installed. |
|
|
|
Default: ``yes'' |
|
|
MKLINT Can be set to ``yes'' or ``no''. Indicates whether lint(1) |
MKLINT Can be set to ``yes'' or ``no''. Indicates whether lint(1) |
will be run against portions of the NetBSD source code during |
will be run against portions of the NetBSD source code during |
the build, and whether lint libraries will be installed into |
the build, and whether lint libraries will be installed into |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
MKNLS Can be set to ``yes'' or ``no''. Indicates whether Native |
MKNLS Can be set to ``yes'' or ``no''. Indicates whether Native |
Language System locale zone files will be compiled and in- |
Language System locale zone files will be compiled and |
stalled during a build. |
installed during a build. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
|
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
Note that setting MKOBJ to ``no'' is not recommended and may |
|
cause problems when updating the tree with cvs(1). |
|
|
MKPIC Can be set to ``yes'' or ``no''. Indicates whether shared |
MKPIC Can be set to ``yes'' or ``no''. Indicates whether shared |
objects and libraries will be created and installed during a |
objects and libraries will be created and installed during a |
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) |
format libraries (lib*_pic.a), used to generate shared li- |
format libraries (lib*_pic.a), used to generate shared |
braries, are installed during a build. |
libraries, are installed during a build. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
|
by default at times due to toolchain problems with profiled |
by default at times due to toolchain problems with profiled |
code. |
code. |
|
|
|
MKREPRO Can be set to ``yes'' or ``no''. Create reproducable builds. |
|
This enables different switches to make two builds from the |
|
same source tree result in the same build results. |
|
|
|
Default: ``no'' |
|
|
MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files |
MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files |
destined to reside in DESTDIR/usr/share will be built and in- |
destined to reside in DESTDIR/usr/share will be built and |
stalled during a build. If set to ``no'', then all of |
installed during a build. If set to ``no'', then all of |
MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to |
MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to |
``no'' unconditionally. |
``no'' unconditionally. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an un- |
MKSTRIPIDENT |
privileged install will occur. The user, group, permissions, |
Can be set to ``yes'' or ``no''. Indicates whether RCS IDs, |
and file flags, will not be set on the installed item; in- |
for use with ident(1), should be stripped from program |
stead the information will be appended to a file called |
binaries and shared libraries. |
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: ``no'' |
Default: ``no'' |
|
|
MKUPDATE Can be set to ``yes'' or ``no''. Indicates whether all in- |
MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an |
stall operations intended to write to DESTDIR will compare |
unprivileged install will occur. The user, group, |
|
permissions, and file flags, will not be set on the installed |
|
items; instead the information will be appended to a file |
|
called METALOG in DESTDIR. The contents of METALOG are used |
|
during the generation of the distribution tar files to ensure |
|
that the appropriate file ownership is stored. |
|
|
|
Default: ``no'' |
|
|
|
MKUPDATE Can be set to ``yes'' or ``no''. Indicates whether all |
|
install operations intended to write to DESTDIR will compare |
file timestamps before installing, and skip the install phase |
file timestamps before installing, and skip the install phase |
if the destination files are up-to-date. This also has im- |
if the destination files are up-to-date. This also has |
plications on full builds (see next subsection). |
implications on full builds (see next subsection). |
|
|
Default: ``no'' |
Default: ``no'' |
|
|
TOOLDIR Directory to hold the host tools, once built. This directory |
MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11 is |
should be unique to a given host system and NetBSD source |
built from X11SRCDIR. |
tree. (However, multiple targets may share the same TOOLDIR; |
|
the target-dependent files have unique names.) If unset, a |
Default: ``no'' |
default based on the uname(1) information of the host plat- |
|
form will be created in the .OBJDIR of src. |
TOOLDIR Directory to hold the host tools, once built. If specified, |
|
must be an absolute path. This directory should be unique to |
|
a given host system and NetBSD source tree. (However, |
|
multiple targets may share the same TOOLDIR; the target- |
|
dependent files have unique names.) If unset, a default |
|
based on the uname(1) information of the host platform will |
|
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'' if building all or part of a whole NetBSD |
Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''. |
source tree (detected automatically); ``no'' otherwise (to |
|
preserve traditional semantics of the <bsd.*.mk> make(1) in- |
USETOOLS is also set to ``no'' when using <bsd.*.mk> outside |
clude files). |
the NetBSD source tree. |
|
|
|
X11SRCDIR Directory containing the X11R6 source. If specified, must be |
|
an absolute path. The main X11R6 source is found in |
|
X11SRCDIR/xfree/xc. |
|
|
|
Default: NETBSDRCDIR/../xsrc, if that exists; otherwise |
|
/usr/xsrc. |
|
|
|
X11FLAVOUR The style of X11 cross-built, set to either ``Xorg'' or |
|
``XFree86''. |
|
|
|
Default: ``Xorg'' on amd64, i386, macppc, shark and sparc64 |
|
platforms, ``XFree86'' on everything else. |
|
|
"make" variables for full builds |
"make" variables for full builds |
These variables only affect the top level ``Makefile'' and do not affect |
These variables only affect the top level ``Makefile'' and do not affect |
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: ``/'' |
|
|
MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether ob- |
MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether |
ject directories will be created automatically (via a |
object directories will be created automatically (via a |
``make obj'' pass) at the start of a build. |
``make obj'' pass) at the start of a build. |
|
|
Default: ``no'' |
Default: ``no'' |
|
|
MKUPDATE Can be set to ``yes'' or ``no''. If set, then in addi- |
If using build.sh, the default is ``yes''. This may be |
tion to the effects described for MKUPDATE=yes above, |
set back to ``no'' by giving build.sh the -o option. |
this implies the effects of NOCLEANDIR (i.e., ``make |
|
cleandir'' is avoided). |
MKUPDATE Can be set to ``yes'' or ``no''. If set, then in |
|
addition to the effects described for MKUPDATE=yes |
|
above, this implies the effects of NOCLEANDIR (i.e., |
|
``make cleandir'' is avoided). |
|
|
Default: ``no'' |
Default: ``no'' |
|
|
NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see |
If using build.sh, this may be set by giving the -u |
below) |
option. |
|
|
|
NBUILDJOBS Now obsolete. Use the make(1) option -j, instead. See |
|
below. |
|
|
Default: Unset. |
Default: Unset. |
|
|
|
|
|
|
Default: Unset. |
Default: Unset. |
|
|
|
See also MKUPDATE. |
|
|
NODISTRIBDIRS If set, avoids the ``make distrib-dirs'' phase of a full |
NODISTRIBDIRS If set, avoids the ``make distrib-dirs'' phase of a full |
build. This skips running mtree(8) on DESTDIR, useful |
build. This skips running mtree(8) on DESTDIR, useful |
on systems where building as an unprivileged user, or |
on systems where building as an unprivileged user, or |
|
|
|
|
NOINCLUDES If set, avoids the ``make includes'' phase of a full |
NOINCLUDES If set, avoids the ``make includes'' phase of a full |
build. This has the effect of preventing make(1) from |
build. This has the effect of preventing make(1) from |
thinking that some programs are out-of-date simply be- |
thinking that some programs are out-of-date simply |
cause the system include files have changed. However, |
because the system include files have changed. However, |
this option should not be used when updating the entire |
this option should not be used when updating the entire |
NetBSD source tree arbitrarily; it is suggested to use |
NetBSD source tree arbitrarily; it is suggested to use |
MKUPDATE=yes in that case. |
MKUPDATE=yes instead in that case. |
|
|
Default: Unset. |
Default: Unset. |
|
|
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. |
|
|
Note: build.sh will provide a default of releasedir (in |
Note: build.sh will provide a default of releasedir (in |
the top-level .OBJDIR) unless run in `expert' mode |
the top-level .OBJDIR) unless run in `expert' mode. |
|
|
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 en- |
use .WAIT or have explicit dependencies as necessary to |
force build ordering. If you see build failures with -j, |
enforce build ordering. |
please save complete build logs so the failures can be ana- |
|
lyzed. |
-m dir Specify the default directory for searching for system |
|
Makefile segments, mainly the <bsd.*.mk> files. When building |
-m dir Specify the default directory for searching for system Make- |
any full NetBSD source tree, this should be set to the |
file segments, mainly the <bsd.*.mk> files. When building any |
``share/mk'' directory in the source tree. This is set |
full NetBSD source tree, this should be set to the |
automatically when building from the top level, or when using |
``share/mk'' directory in the source tree. (This is set auto- |
build.sh. |
matically when building from the top level.) |
|
|
|
-n Display the commands that would have been executed, but do not |
-n Display the commands that would have been executed, but do not |
actually execute them. This will still cause recursion to |
actually execute them. This will still cause recursion to |
take place. |
take place. |
|
|
-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 |
|
|
|
|
clean Remove program and library object code files. |
clean Remove program and library object code files. |
|
|
cleandir Same as clean, but also remove preformatted documentation, de- |
cleandir Same as clean, but also remove preformatted documentation, |
pendency files generated by ``make depend'', and any other |
dependency files generated by ``make depend'', and any other |
files known to be created at build time. ``make distclean'' |
files known to be created at build time. |
may be used as a synonym, for familiarity with a similar well- |
|
known convention. |
|
|
|
depend Create dependency files (.depend) containing more detailed in- |
depend Create dependency files (.depend) containing more detailed |
formation about the dependencies of source code on header |
information about the dependencies of source code on header |
files. Allows programs to be recompiled automatically when a |
files. Allows programs to be recompiled automatically when a |
dependency changes. |
dependency changes. |
|
|
|
|
This improves cache locality of the build since both passes |
This improves cache locality of the build since both passes |
read the source files in their entirety. |
read the source files in their entirety. |
|
|
includes Build and install system header files. Typically needed be- |
distclean Synonym for cleandir. |
fore any system libraries or programs can be built. |
|
|
includes Build and install system header files. Typically needed |
|
before any system libraries or programs can be built. |
|
|
install Install programs, libraries, and documentation into DESTDIR. |
install Install programs, libraries, and documentation into DESTDIR. |
Few files will be installed to DESTDIR/dev, DESTDIR/etc, |
Few files will be installed to DESTDIR/dev, DESTDIR/etc, |
|
|
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 |
ing. |
compiling. |
|
|
Note: It is highly recommended that you upgrade your kernel |
The INSTALLSETS environment variable may be set to a space- |
and reboot before performing this operation. |
separated list 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 postinstall(8) to |
|
check for or fix inconsistencies. |
|
|
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'' alone does |
the required files). |
not 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. |
|
|
release Do a ``make distribution'', build kernels, distribution me- |
syspkgs Create syspkgs from DESTDIR into |
dia, and install sets (this as per ``make sets''), and then |
RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs. Should be run |
package the system into a standard release layout as de- |
after ``make distribution'', as ``make build'' alone does |
scribed by release(7). This requires that RELEASEDIR be |
not install all of the required files. |
|
|
|
release Do a ``make distribution'', build kernels, distribution |
|
media, and install sets (this as per ``make sets''), and |
|
then package the system into a standard release layout as |
|
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 |
|
installation 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 |
|
directory 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) |
|
utility, 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 |
|
installation 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 |
|
equivalent. |
|
|
|
Note that other, smaller, CD-ROM images may be created in |
|
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom |
|
directory 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) |
|
utility, which is not part of NetBSD, but which can be |
|
installed from pkgsrc/sysutils/cdrtools. |
|
|
|
install-image |
|
Create a bootable NetBSD installation disk image in the |
|
RELEASEDIR/RELEASEMACHINEDIR/installation/installimage |
|
directory. The installation disk image is suitable for |
|
copying to bootable USB flash memory sticks, etc., for |
|
machines which are able to boot from such devices. The |
|
file system in the bootable disk image will have a layout |
|
as described in release(7). |
|
|
|
The installation image is bootable, and will automatically |
|
run the sysinst(8) menu-based installation program, which |
|
can be used to install or upgrade a NetBSD system. The |
|
image also contains tools that may be useful in repairing a |
|
damaged NetBSD installation. |
|
|
|
Before ``make install-image'' is attempted, RELEASEDIR must |
|
be populated by ``make release'' or equivalent. The build |
|
must have been performed with MKUNPRIVED=yes because ``make |
|
install-image'' relies on information in DESTDIR/METALOG. |
|
|
|
live-image Create NetBSD live images in the |
|
RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage |
|
directory. The live image contains all necessary files to |
|
boot NetBSD up to multi-user mode, including all files |
|
which should be extracted during installation, NetBSD |
|
disklabel, bootloaders, etc. |
|
|
|
The live image is suitable for use as a disk image in |
|
virtual machine environments such as QEMU, and also useful |
|
to boot NetBSD from a USB flash memory stick on a real |
|
machine, without the need for installation. |
|
|
|
Before ``make live-image'' is attempted, RELEASEDIR must be |
|
populated by ``make release'' or equivalent. The build |
|
must have been performed with MKUNPRIVED=yes because ``make |
|
install-image'' relies on information in DESTDIR/METALOG. |
|
|
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 those compiled regression |
on the local host. |
tests on the local host. Note that most tests are now |
|
managed instead using atf(7); this target should probably |
|
run those as well but currently does not. |
|
|
The "build.sh" script |
The "build.sh" script |
This script file is a Bourne shell script designed to build the entire |
This script file is a shell script designed to build the entire NetBSD |
NetBSD system on any host with a Bourne shell in /bin/sh, including many |
system on any host with a suitable modern shell and some common |
that are not POSIX compliant. Note that if a host system's /bin/sh is |
utilities. The required shell features are described under the HOST_SH |
unusually old and broken, the Korn Shell (/bin/ksh), if available, may be |
variable. |
a usable alternative. |
|
|
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 |
|
like |
|
|
|
/path/to/suitable/shell build.sh [options] |
|
|
|
The above command will usually enable build.sh to automatically set |
|
HOST_SH=/path/to/suitable/shell, but if that fails, then the following |
|
set of commands may be used instead: |
|
|
|
HOST_SH=/path/to/suitable/shell |
|
export HOST_SH |
|
${HOST_SH} build.sh [options] |
|
|
|
If build.sh detects that it is being executed under an unsuitable shell, |
|
it attempts to exec a suitable shell instead, or prints an error message. |
|
If HOST_SH is not set explicitly, then build.sh sets a default using |
|
heuristics dependent on the host platform, or from the shell under which |
|
build.sh is executed (if that can be determined), or using the first copy |
|
of sh found in PATH. |
|
|
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 |
|
|
|
|
The following operations are supported by build.sh: |
The following operations are supported by build.sh: |
|
|
build Build the system as per ``make build''. This option im- |
build Build the system as per ``make build''. Before the main |
plies the obj and tools operations. |
part of the build commences, this command runs the obj |
|
operation (unless the -o option is given), ``make |
|
cleandir'' (unless the -u option is given), and the tools |
|
operation. |
|
|
distribution Build a full distribution as per ``make distribution''. |
distribution Build a full distribution as per ``make distribution''. |
This option implies the build operation. |
This command first runs the build operation. |
|
|
release Build a full release as per ``make release''. This option |
release Build a full release as per ``make release''. This command |
implies 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''. |
|
|
obj Perform ``make obj''. |
obj Perform ``make obj''. |
|
|
tools Build and install the host tools from src/tools. |
tools Build and install the host tools from src/tools. This |
|
command will first run ``make obj'' and ``make cleandir'' |
|
in the tools subdirectory unless the -o or -u options |
|
(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''. |
installworld''. Note that files that are part of the |
|
``etc'' or ``xetc'' sets will not be installed, unless |
|
overridden by the INSTALLSETS environment variable. |
|
|
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 |
built in a subdirectory of KERNOBJDIR, which is typically |
built in a subdirectory of KERNOBJDIR, which is typically |
sys/arch/MACHINE/compile or an associated object directory. |
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 |
This command does not imply the tools command; run the |
rebuilt (using the tools operation). |
tools command first unless it is certain that the tools |
|
already exist and are up to date. |
|
|
|
This command will run ``make cleandir'' on the kernel in |
|
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 |
|
into DESTDIR. |
|
|
releasekernel=kconf |
releasekernel=kconf |
Install a gzip(1)ed copy of the kernel built by |
Install a gzip(1)ed copy of the kernel previously built by |
kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually |
kernel=kconf into |
as netbsd-kconf.gz, although the ``netbsd'' prefix is de- |
RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as |
termined from the ``config'' directives in kconf. |
netbsd-kconf.gz, although the ``netbsd'' prefix is |
|
determined 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''. |
|
|
|
install-image |
|
Perform ``make install-image''. |
|
|
|
live-image Perform ``make live-image''. |
|
|
|
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 |
|
Append cdextras to the CDEXTRA variable, which is a space- |
|
separated list of files or directories that will be added to |
|
the CD-ROM image that may be create by the ``iso-image'' or |
|
``iso-image-source'' operations. 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. Multiple paths |
|
may be specified via multiple -C options, or via a single |
|
option whose argument contains multiple space-separated paths. |
|
|
|
-D dest Set the value of DESTDIR to dest. If a relative path is |
|
specified, 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 |
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 Passed through to make(1). Makefiles should use .WAIT or have |
-h Print a help message. |
explicit dependancies as necessary to enforce build ordering. |
|
If you see build failures with -j, please save complete build |
-j njob Run up to njob make(1) subjobs in parallel; passed through to |
logs so the failures can be analyzed. |
make(1). If you see failures for reasons other than running |
|
out of memory while using build.sh with -j, please save |
-M obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR. |
complete build logs so the failures can be analyzed. |
|
|
-m mach Set the value of MACHINE to mach. This will also override any |
To achieve the fastest builds, -j values between (1 + the |
value of MACHINE_ARCH in the process environment with a value |
number of CPUs) and (2 * the number of CPUs) are recommended. |
deduced from mach, unless -a is specified, or mach is a special |
Use lower values on machines with limited memory or I/O |
case listed below. All cross builds require -m, but if unset |
bandwidth. |
on a NetBSD host, the host's value of MACHINE will be detected |
|
and used automatically. |
-M obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR. See ``-O |
|
obj'' for more information. |
Some machines support multiple values for MACHINE_ARCH. For a |
|
given value of mach, the following MACHINE and MACHINE_ARCH |
For instance, if the source directory is /usr/src, a setting of |
values will result: |
``-M /usr/obj'' will place build-time files under |
|
/usr/obj/usr/src/bin, /usr/obj/usr/src/lib, |
|
/usr/obj/usr/src/usr.bin, and so forth. |
|
|
|
If a relative path is specified, it will be converted to an |
|
absolute path before being used. build.sh imposes the |
|
restriction that the argument to the -M option must not begin |
|
with a ``$'' (dollar sign) character; otherwise it would be too |
|
difficult to determine whether the value is an absolute or a |
|
relative path. If the directory does not already exist, |
|
build.sh will create it. |
|
|
|
-m mach Set the value of MACHINE to mach, except in some special cases |
|
listed below. This will also override any value of |
|
MACHINE_ARCH in the process environment with a value deduced |
|
from mach, unless -a is specified. All cross builds require |
|
-m, but if unset on a NetBSD host, the host's value of MACHINE |
|
will be detected and used automatically. |
|
|
|
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 |
|
|
sbmips-eb sbmips mipseb |
sbmips-eb sbmips mipseb |
sbmips-el sbmips mipsel |
sbmips-el sbmips mipsel |
|
|
|
-N noiselevel |
|
Set the ``noisyness'' level of the build, by setting |
|
MAKEVERBOSE to noiselevel. |
|
|
-n Show the commands that would be executed by build.sh, but do |
-n Show the commands that would be executed by build.sh, but do |
not make any changes. This is similar in concept to ``make |
not make any changes. This is similar in concept to ``make |
-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. Unsets |
ting of /usr/obj will place build-time files under |
MAKEOBJDIRPREFIX. |
/usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth. |
|
Unsets MAKEOBJDIRPREFIX. |
For instance, a setting of ``-O /usr/obj'' will place build- |
|
time files under /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, |
|
and so forth. |
|
|
|
If a relative path is specified, it will be converted to an |
|
absolute path before being used. build.sh imposes the |
|
restriction that the argument to the -O option must not contain |
|
a ``$'' (dollar sign) character. If the directory does not |
|
already exist, build.sh will create it. |
|
|
|
In normal use, exactly one of the -M or -O options should be |
|
specified. If neither -M nor -O is specified, then a default |
|
object directory will be chosen according to rules in |
|
<bsd.obj.mk>. Relying on this default is not recommended |
|
because it is determined by complex rules that are influenced |
|
by the values of several variables and by the location of the |
|
source directory. |
|
|
-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''. This default is opposite to the |
behaviour). |
behaviour when not using build.sh. |
|
|
-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 |
-S seed Change the value of BUILDSEED to seed. This should rarely be |
``make'' will only be rebuilt as needed (when the source files |
necessary. |
for make(1) change). |
|
|
-T tools Set the value of TOOLDIR to tools. If a relative path is |
|
specified, it will be converted to an absolute path before |
|
being used. If set, the bootstrap ``make'' will only be |
|
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. |
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 |
|
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. |
|
|
-Z var Unset ("zap") the environment variable var. This is propagated |
-Z var Unset ("zap") the environment variable var. This is propagated |
to the nbmake wrapper. |
to the nbmake wrapper. |
|
|
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 |
build.sh will also set variables specified with -V, and unset variables |
TOOLDIR. nbmake-MACHINE will also set variables specified with -V, and |
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. |
|
|
EXAMPLES |
EXAMPLES |
1. ./build.sh tools kernel=GENERIC |
1. % ./build.sh [options] tools kernel=GENERIC |
|
|
Build a new toolchain, and use the new toolchain to configure and |
Build a new toolchain, and use the new toolchain to configure and |
build a new GENERIC kernel. |
build a new GENERIC kernel. |
|
|
2. ./build.sh -U distribution |
2. % ./build.sh [options] -U distribution |
|
|
Using unprivileged mode, build a complete distribution to a DESTDIR |
Using unprivileged mode, build a complete distribution to a DESTDIR |
directory that build.sh selects (and will display). |
directory that build.sh selects (and will display). |
|
|
3. ./build.sh -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 -U -u release |
4. % ./build.sh [options] -U -u release |
|
|
Using unprivileged mode, build a complete release to DESTDIR and |
Using unprivileged mode, build a complete release to DESTDIR and |
RELEASEDIR directories that build.sh selects (and will display). |
RELEASEDIR directories that build.sh selects (and will display). |
|
|
of the release build. |
of the release build. |
|
|
OBSOLETE VARIABLES |
OBSOLETE VARIABLES |
NBUILDJOBS Use the make(1) option -j, instead. |
NBUILDJOBS Use the make(1) option -j instead. |
|
|
USE_NEW_TOOLCHAIN |
USE_NEW_TOOLCHAIN |
The new toolchain is now the default. To disable, use |
The new toolchain is now the default. To disable, use |
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 |
USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. |
USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. |
|
|
BUGS |
NetBSD August 3, 2014 NetBSD |
A few platforms are not yet using this build system. |
|
|
|
NetBSD August 7, 2003 NetBSD |
|