version 1.104, 2013/05/29 14:47:22 |
version 1.129, 2017/10/21 23:49:28 |
|
|
BUILDING(8) System Manager's Manual BUILDING(8) |
BUILDING(8) System Manager's Manual BUILDING(8) |
|
|
NNAAMMEE |
NAME |
BBUUIILLDDIINNGG -- Procedure for building NetBSD from source code. |
BUILDING - Procedure for building NetBSD from source code. |
|
|
RREEQQUUIIRREEMMEENNTTSS |
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. |
The basic build procedure is the same whether compiling _n_a_t_i_v_e_l_y (on the |
The basic build procedure is the same whether compiling natively (on the |
same NetBSD architecture) or _c_r_o_s_s _c_o_m_p_i_l_i_n_g (on another architecture or |
same NetBSD architecture) or cross compiling (on another architecture or |
OS). |
OS). |
|
|
This source tree contains a special subtree, ``tools'', which uses the |
This source tree contains a special subtree, "tools", which uses the host |
host system to create a build toolchain for the target architecture. The |
system to create a build toolchain for the target architecture. The host |
host system must have at least C and C++ compilers in order to create the |
system must have at least C and C++ compilers in order to create the |
toolchain (mmaakkee 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. (See the environment variables section below |
the NetBSD build process. (See the environment variables section below |
if you need to override or manually select your compilers.) |
if you need to override or manually select your compilers.) |
|
|
FFIILLEESS |
FILES |
SSoouurrccee ttrreeee llaayyoouutt |
Source tree layout |
ddoocc//BBUUIILLDDIINNGG..mmddoocc |
doc/BUILDING.mdoc |
This document (in -mdoc troff format; the original copy). |
This document (in -mdoc troff format; the original copy). |
|
|
BBUUIILLDDIINNGG This document (in plaintext). |
BUILDING This document (in plaintext). |
|
|
ttoooollss//ccoommppaatt//RREEAADDMMEE |
tools/compat/README |
Special notes for cross-hosting a NetBSD build on non- |
Special notes for cross-hosting a NetBSD build on non- |
NetBSD platforms. |
NetBSD platforms. |
|
|
MMaakkeeffiillee The main Makefile for NetBSD; should only be run for |
Makefile The main Makefile for NetBSD; should only be run for |
native builds with an appropriately up-to-date version of |
native builds with an appropriately up-to-date version of |
NetBSD make(1). (For building from out-of-date systems or |
NetBSD make(1). Intended for expert use with knowlege of |
on a non-native host, see the bbuuiilldd..sshh shell script.) |
its shortcomings, it has been superseded by the build.sh |
|
shell script as the recommended means for building NetBSD. |
|
|
UUPPDDAATTIINNGG Special notes for updating from an earlier revision of |
UPDATING Special notes for updating from an earlier revision of |
NetBSD. It is important to read this file before every |
NetBSD. It is important to read this file before every |
build of an updated source tree. |
build of an updated source tree. |
|
|
bbuuiilldd..sshh Bourne-compatible shell script used for building the host |
build.sh Bourne-compatible shell script used for building the host |
build tools and the NetBSD system from scratch. Can be |
build tools and the NetBSD system from scratch. Can be |
used for both native and cross builds, and should be used |
used for both native and cross builds, and should be used |
instead of make(1) for any source tree that is updated and |
instead of make(1) as it performs additional checks to |
recompiled regularly. |
prevent common issues going undetected, such as building |
|
with an outdated version of make(1). |
|
|
ccrryyppttoo//ddiisstt//, ddiisstt//, ggnnuu//ddiisstt// |
crypto/dist/, dist/, gnu/dist/ |
Sources imported verbatim from third parties, without |
Sources imported verbatim from third parties, without |
mangling the existing build structure. Other source trees |
mangling the existing build structure. Other source trees |
in bbiinn through uussrr..ssbbiinn use the NetBSD make(1) |
in bin through usr.sbin use the NetBSD make(1) "reachover" |
``reachover'' Makefile semantics when building these |
Makefile semantics when building these programs for a |
programs for a native host. |
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. |
|
|
ddiissttrriibb//, eettcc// |
distrib/, etc/ |
Sources for items used when making a full release |
Sources for items used when making a full release |
snapshot, such as files installed in DDEESSTTDDIIRR_/_e_t_c on the |
snapshot, such as files installed in DESTDIR/etc on the |
destination system, boot media, and release notes. |
destination system, boot media, and release notes. |
|
|
tteessttss//, rreeggrreessss// |
tests/, regress/ |
Regression test harness. Can be cross-compiled, but only |
Regression test harness. Can be cross-compiled, but only |
run natively. _t_e_s_t_s_/ uses the atf(7) test framework; |
run natively. tests/ uses the atf(7) test framework; |
_r_e_g_r_e_s_s_/ contains older tests that have not yet been |
regress/ contains older tests that have not yet been |
migrated to atf(7). |
migrated to atf(7). |
|
|
ssyyss// NetBSD kernel sources. |
sys/ NetBSD kernel sources. |
|
|
ttoooollss// ``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 |
This has a special method of determining out-of-date |
status. |
status. |
|
|
bbiinn// ...... uussrr..ssbbiinn// |
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. |
|
|
xx1111// ``Reachover'' build structure for X11R6; the source is in |
external/mit/xorg/ |
XX1111SSRRCCDDIIRR. |
"Reachover" build structure for modular Xorg; the source |
|
is in X11SRCDIR. |
|
|
BBuuiilldd ttrreeee llaayyoouutt |
extsrc/ "Reachover" build structure for externally added programs |
|
and libraries; the source is in EXTSRCSRCDIR. |
|
|
|
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). |
|
|
CCOONNFFIIGGUURRAATTIIOONN |
CONFIGURATION |
EEnnvviirroonnmmeenntt vvaarriiaabblleess |
Environment variables |
Several environment variables control the behaviour of NetBSD builds. |
Several environment variables control the behaviour of NetBSD builds. |
|
|
HHOOSSTT__SSHH Path name to a shell available on the host system and |
HOST_SH Path name to a shell available on the host system and |
suitable for use during the build. The NetBSD build |
suitable for use during the build. The NetBSD build |
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- |
functions (which is a widely-implemented but non- |
standardised feature). |
standardised feature). |
|
|
Depending on the host system, a suitable shell may be |
Depending on the host system, a suitable shell may be |
_/_b_i_n_/_s_h, _/_u_s_r_/_x_p_g_4_/_b_i_n_/_s_h, _/_b_i_n_/_k_s_h (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 |
such as ksh88, but not ksh93), or _/_u_s_r_/_l_o_c_a_l_/_b_i_n_/_b_a_s_h. |
as ksh88, but not ksh93), or /usr/local/bin/bash. |
|
|
Most parts of the build require HHOOSSTT__SSHH to be an |
Most parts of the build require HOST_SH to be an |
absolute path; however, bbuuiilldd..sshh allows it to be a |
absolute path; however, build.sh allows it to be a |
simple command name, which will be converted to an |
simple command name, which will be converted to an |
absolute path by searching the PPAATTHH. |
absolute path by searching the PATH. |
|
|
HHOOSSTT__CCCC Path name to C compiler used to create the toolchain. |
HOST_CC Path name to C compiler used to create the toolchain. |
|
|
HHOOSSTT__CCXXXX Path name to C++ compiler used to create the toolchain. |
HOST_CXX Path name to C++ compiler used to create the toolchain. |
|
|
MMAACCHHIINNEE Machine type, e.g., ``macppc''. |
MACHINE Machine type, e.g., "macppc". |
|
|
MMAACCHHIINNEE__AARRCCHH Machine architecture, e.g., ``powerpc''. |
MACHINE_ARCH Machine architecture, e.g., "powerpc". |
|
|
MMAAKKEE Path name to invoke make(1) as. |
MAKE Path name to invoke make(1) as. |
|
|
MMAAKKEEFFLLAAGGSS Flags to invoke make(1) with. Note that bbuuiilldd..sshh |
MAKEFLAGS Flags to invoke make(1) with. Note that build.sh |
ignores the value of MMAAKKEEFFLLAAGGSS passed in the |
ignores the value of MAKEFLAGS passed in the |
environment, but allows MMAAKKEEFFLLAAGGSS to be set via the --VV |
environment, but allows MAKEFLAGS to be set via the -V |
option. |
option. |
|
|
MMAAKKEEOOBBJJDDIIRR Directory to use as the ..OOBBJJDDIIRR for the current |
MAKEOBJDIR Directory to use as the .OBJDIR for the current |
directory. The value is subjected to variable |
directory. The value is subjected to variable |
expansion by make(1). Typical usage is to set this |
expansion by make(1). Typical usage is to set this |
variable to a value involving the use of |
variable to a value involving the use of |
`${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the |
`${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the |
value of ..OOBBJJDDIIRR from the value of ..CCUURRDDIIRR. Used only |
value of .OBJDIR from the value of .CURDIR. Used only |
if MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX is not defined. MMAAKKEEOOBBJJDDIIRR can be |
if MAKEOBJDIRPREFIX is not defined. MAKEOBJDIR can be |
provided only in the environment or via the --OO flag of |
provided only in the environment or via the -O flag of |
bbuuiilldd..sshh; it cannot usefully be set inside a Makefile, |
build.sh; it cannot usefully be set inside a Makefile, |
including _m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}. |
including mk.conf or ${MAKECONF}. |
|
|
MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX 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). |
bbuuiilldd..sshh will create the ${MAKEOBJDIRPREFIX} directory |
build.sh will create the ${MAKEOBJDIRPREFIX} directory |
if necessary, but if make(1) is used without bbuuiilldd..sshh, |
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 |
value is defined and valid, then |
${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the ..OOBBJJDDIIRR |
${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the .OBJDIR |
for the current directory. The current directory may |
for the current directory. The current directory may |
be read only. MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX can be provided only in |
be read only. MAKEOBJDIRPREFIX can be provided only in |
the environment or via the --MM flag of bbuuiilldd..sshh; it |
the environment or via the -M flag of build.sh; it |
cannot usefully be set inside a Makefile, including |
cannot usefully be set inside a Makefile, including |
_m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}. |
mk.conf or ${MAKECONF}. |
|
|
""mmaakkee"" vvaarriiaabblleess |
"make" variables |
Several variables control the behavior of NetBSD builds. Unless |
Several variables control the behavior of NetBSD builds. Unless |
otherwise specified, these variables may be set in either the process |
otherwise specified, these variables may be set in either the process |
environment or the make(1) configuration file specified by MMAAKKEECCOONNFF. |
environment or the make(1) configuration file specified by MAKECONF. |
|
|
BBUUIILLDDIIDD 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 |
|
directory name. The identifier will be appended to object |
|
directory names, and can be consulted in the make(1) |
configuration file in order to set additional build |
configuration file in order to set additional build |
parameters, such as compiler flags. |
parameters, such as compiler flags. It will also be used as |
|
part of the kernel version string, which can be printed by |
|
"uname -v". |
|
|
|
Default: Unset. |
|
|
|
BUILDINFO This may be a multi-line string containing information about |
|
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. |
|
|
BBUUIILLDDSSEEEEDD GCC uses random numbers when compiling C++ code. This |
BUILDSEED GCC uses random numbers when compiling C++ code. This |
variable seeds the gcc random number generator using the |
variable seeds the gcc random number generator using the |
-frandom-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++ |
NetBSD-(majorversion). Using a fixed value causes C++ |
Line 159 CCOONNFFIIGGUURRAATTIIOONN |
|
Line 188 CCOONNFFIIGGUURRAATTIIOONN |
|
information is available in the GCC documentation of |
information is available in the GCC documentation of |
-frandom-seed. |
-frandom-seed. |
|
|
DDEESSTTDDIIRR Directory to contain the built NetBSD system. If set, |
DESTDIR Directory to contain the built NetBSD system. If set, |
special options are passed to the compilation tools to |
special options are passed to the compilation tools to |
prevent their default use of the host system's //uussrr//iinncclluuddee, |
prevent their default use of the host system's /usr/include, |
//uussrr//lliibb, and so forth. This pathname must be an absolute |
/usr/lib, and so forth. This pathname must be an absolute |
path, and should _n_o_t end with a slash (/) character. (For |
path, and should not end with a slash (/) character. (For |
installation into the system's root directory, set DDEESSTTDDIIRR 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 |
a file system which supports long file names and hard links. |
file system which supports long file names and hard links. |
|
|
|
Default: Empty string if USETOOLS is "yes"; unset otherwise. |
|
|
_D_e_f_a_u_l_t: Empty string if UUSSEETTOOOOLLSS is ``yes''; unset |
Note: build.sh will provide a default of destdir.MACHINE (in |
otherwise. |
the top-level .OBJDIR) unless run in `expert' mode. |
|
|
_N_o_t_e: bbuuiilldd..sshh will provide a default of _d_e_s_t_d_i_r_.MMAACCHHIINNEE (in |
EXTSRCSRCDIR |
the top-level ..OOBBJJDDIIRR) unless run in `expert' mode. |
Directory containing sources of externally added programs and |
|
libraries. If specified, must be an absolute path. |
|
|
MMAAKKEECCOONNFF The name of the make(1) configuration file. _O_n_l_y _s_e_t_t_a_b_l_e _i_n |
Default: NETBSDRCDIR/../extsrc, if that exists; otherwise |
_t_h_e _p_r_o_c_e_s_s _e_n_v_i_r_o_n_m_e_n_t_. |
/usr/extsrc. |
|
|
_D_e_f_a_u_l_t: ``/etc/mk.conf'' |
MAKECONF The name of the make(1) configuration file. Only settable in |
|
the process environment. |
|
|
MMAAKKEEVVEERRBBOOSSEE |
Default: "/etc/mk.conf" |
|
|
|
MAKEVERBOSE |
Level of verbosity of status messages. Supported values: |
Level of verbosity of status messages. Supported values: |
|
|
0 No descriptive messages or commands executed by make(1) |
0 No descriptive messages or commands executed by make(1) |
Line 195 CCOONNFFIIGGUURRAATTIIOONN |
|
Line 230 CCOONNFFIIGGUURRAATTIIOONN |
|
|
|
3 In addition to the above, all commands performed by |
3 In addition to the above, all commands performed by |
make(1) are displayed, even if they would ordinarily |
make(1) are displayed, even if they would ordinarily |
have been hidden through use of the ``@'' prefix in the |
have been hidden through use of the "@" prefix in the |
relevant makefile. |
relevant makefile. |
|
|
4 In addition to the above, commands executed by make(1) |
4 In addition to the above, commands executed by make(1) |
are traced through use of the sh(1) ``--xx'' flag. |
are traced through use of the sh(1) "-x" flag. |
|
|
_D_e_f_a_u_l_t: 2 |
Default: 2 |
|
|
MMKKCCAATTPPAAGGEESS Can be set to ``yes'' or ``no''. Indicates whether |
MKCATPAGES Can be set to "yes" or "no". Indicates whether preformatted |
preformatted plaintext manual pages will be created during a |
plaintext manual pages will be created during a build. |
build. |
|
|
Default: "no" |
|
|
_D_e_f_a_u_l_t: ``no'' |
MKCROSSGDB Can be set to "yes" or "no". Create a cross-gdb as a host |
|
tool. |
|
|
MMKKCCRRYYPPTTOO Can be set to ``yes'' or ``no''. Indicates whether |
Default: "no" |
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). |
|
|
|
_D_e_f_a_u_l_t: ``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. |
|
|
MMKKDDOOCC Can be set to ``yes'' or ``no''. Indicates whether system |
Default: "no" |
documentation destined for DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e_/_d_o_c will be |
|
|
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 |
|
documentation destined for DESTDIR/usr/share/doc will be |
installed during a build. |
installed during a build. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "yes" |
|
|
MMKKHHTTMMLL Can be set to ``yes'' or ``no''. Indicates whether |
MKEXTSRC Can be set to "yes" or "no". Indicates whether extsrc is |
preformatted HTML manual pages will be built and installed |
built from EXTSRCSRCDIR. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "no" |
|
|
MMKKHHOOSSTTOOBBJJ Can be set to ``yes'' or ``no''. If set to ``yes'', then for |
MKHTML Can be set to "yes" or "no". Indicates whether preformatted |
|
HTML manual pages will be built and installed |
|
|
|
Default: "yes" |
|
|
|
MKHOSTOBJ Can be set to "yes" or "no". If set to "yes", then for |
programs intended to be run on the compile host, the name, |
programs intended to be run on the compile host, the name, |
release, and architecture of the host operating system will |
release, and architecture of the host operating system will |
be suffixed to the name of the object directory created by |
be suffixed to the name of the object directory created by |
``make obj''. (This allows multiple host systems to compile |
"make obj". (This allows multiple host systems to compile |
NetBSD for a single target.) If set to ``no'', then programs |
NetBSD for a single target.) If set to "no", then programs |
built to be run on the compile host will use the same object |
built to be run on the compile host will use the same object |
directory names as programs built to be run on the target. |
directory names as programs built to be run on the target. |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "no" |
|
|
MMKKIINNFFOO Can be set to ``yes'' or ``no''. Indicates whether GNU Info |
MKINFO Can be set to "yes" or "no". Indicates whether GNU Info |
files, used for the documentation for most of the compilation |
files, used for the documentation for most of the compilation |
tools, will be created and installed during a build. |
tools, will be created and installed during a build. |
|
|
_D_e_f_a_u_l_t: ``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). |
|
|
MMKKKKMMOODD Can be set to ``yes'' or ``no''. Indicates whether kernel |
Default: "no" |
|
|
|
MKKMOD Can be set to "yes" or "no". Indicates whether kernel |
modules are built and installed. |
modules are built and installed. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "yes" |
|
|
MMKKLLIINNTT Can be set to ``yes'' or ``no''. Indicates whether lint(1) |
MKLINT Can be set to "yes" or "no". Indicates whether lint(1) will |
will be run against portions of the NetBSD source code during |
be run against portions of the NetBSD source code during the |
the build, and whether lint libraries will be installed into |
build, and whether lint libraries will be installed into |
DDEESSTTDDIIRR_/_u_s_r_/_l_i_b_d_a_t_a_/_l_i_n_t. |
DESTDIR/usr/libdata/lint. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "yes" |
|
|
MMKKMMAANN Can be set to ``yes'' or ``no''. Indicates whether manual |
MKMAN Can be set to "yes" or "no". Indicates whether manual pages |
pages will be installed during a build. |
will be installed during a build. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "yes" |
|
|
MMKKNNLLSS 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 |
Language System locale zone files will be compiled and |
installed during a build. |
installed during a build. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "yes" |
|
|
MMKKOOBBJJ Can be set to ``yes'' or ``no''. Indicates whether object |
MKOBJ Can be set to "yes" or "no". Indicates whether object |
directories will be created when running ``make obj''. If |
directories will be created when running "make obj". If set |
set to ``no'', then all built files will be located inside |
to "no", then all built files will be located inside the |
the regular source tree. |
regular source tree. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "yes" |
|
|
Note that setting MMKKOOBBJJ to ``no'' is not recommended and may |
Note that setting MKOBJ to "no" is not recommended and may |
cause problems when updating the tree with cvs(1). |
cause problems when updating the tree with cvs(1). |
|
|
MMKKPPIICC 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. |
|
|
_D_e_f_a_u_l_t: Platform dependent. As of this writing, all |
Default: "yes" |
platforms except sshh33 default to ``yes''. |
|
|
|
MMKKPPIICCIINNSSTTAALLLL |
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 (lliibb**__ppiicc..aa), used to generate shared |
format libraries (lib*_pic.a), used to generate shared |
libraries, are installed during a build. |
libraries, are installed during a build. |
|
|
_D_e_f_a_u_l_t: ``yes'' |
Default: "yes" |
|
|
MMKKPPRROOFFIILLEE Can be set to ``yes'' or ``no''. Indicates whether profiled |
MKPROFILE Can be set to "yes" or "no". Indicates whether profiled |
libraries (lliibb**__pp..aa) will be built and installed during a |
libraries (lib*_p.a) will be built and installed during a |
build. |
build. |
|
|
_D_e_f_a_u_l_t: ``yes''; however, some platforms turn off MMKKPPRROOFFIILLEE |
Default: "yes"; however, some platforms turn off MKPROFILE by |
by default at times due to toolchain problems with profiled |
default at times due to toolchain problems with profiled |
code. |
code. |
|
|
MMKKRREEPPRROO Can be set to ``yes'' or ``no''. Create reproducable builds. |
MKREPRO Can be set to "yes" or "no". Create reproducible builds. |
This enables different switches to make two builds from the |
This enables different switches to make two builds from the |
same source tree result in the same build results. |
same source tree result in the same build results. |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "no" This may be set to "yes" by giving build.sh the |
|
-P option. |
MMKKSSHHAARREE Can be set to ``yes'' or ``no''. Indicates whether files |
|
destined to reside in DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e will be built and |
|
installed during a build. If set to ``no'', then all of |
|
MMKKCCAATTPPAAGGEESS, MMKKDDOOCC, MMKKIINNFFOO, MMKKMMAANN, and MMKKNNLLSS will be set to |
|
``no'' unconditionally. |
|
|
|
_D_e_f_a_u_l_t: ``yes'' |
|
|
|
MMKKSSTTRRIIPPIIDDEENNTT |
MKREPRO_TIMESTAMP |
Can be set to ``yes'' or ``no''. Indicates whether RCS IDs, |
Unix timestamp. When MKREPRO is set, the timestamp of all |
for use with ident(1), should be stripped from program |
files in the sets will be set to this value. |
binaries and shared libraries. |
|
|
Default: Unset. This may be set automatically to the latest |
|
source tree timestamp using cvslatest(1) by giving build.sh |
|
the -P option. |
|
|
|
MKSHARE Can be set to "yes" or "no". Indicates whether files |
|
destined to reside in DESTDIR/usr/share will be built and |
|
installed during a build. If set to "no", then all of |
|
MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to |
|
"no" unconditionally. |
|
|
|
Default: "yes" |
|
|
|
MKSTRIPIDENT |
|
Can be set to "yes" or "no". Indicates whether RCS IDs, for |
|
use with ident(1), should be stripped from program binaries |
|
and shared libraries. |
|
|
|
Default: "no" |
|
|
|
MKSTRIPSYM Can be set to "yes" or "no". Indicates whether all local |
|
symbols should be stripped from shared libraries. If "yes", |
|
strip all local symbols from shared libraries; the affect is |
|
equivalent to the -x option of ld(1). If "no", strip only |
|
temporary local symbols; the affect is equivalent to the -X |
|
option of ld(1). Keeping non-temporary local symbols such as |
|
static function names is useful on using DTrace for userland |
|
libraries and getting a backtrace from a rump kernel loading |
|
shared libraries. |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "yes" |
|
|
MMKKUUNNPPRRIIVVEEDD 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, |
unprivileged install will occur. The user, group, |
permissions, 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 _M_E_T_A_L_O_G in DDEESSTTDDIIRR. The contents of _M_E_T_A_L_O_G 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 |
that the appropriate file ownership is stored. |
that the appropriate file ownership is stored. |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "no" |
|
|
MMKKUUPPDDAATTEE Can be set to ``yes'' or ``no''. Indicates whether all |
MKUPDATE Can be set to "yes" or "no". Indicates whether all install |
install operations intended to write to DDEESSTTDDIIRR will compare |
operations intended to write to DESTDIR will compare file |
file timestamps before installing, and skip the install phase |
timestamps before installing, and skip the install phase if |
if the destination files are up-to-date. This also has |
the destination files are up-to-date. This also has |
implications on full builds (see next subsection). |
implications on full builds (see next subsection). |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "no" |
|
|
MMKKXX1111 Can be set to ``yes'' or ``no''. Indicates whether X11 is |
MKX11 Can be set to "yes" or "no". Indicates whether X11 is built |
built from XX1111SSRRCCDDIIRR. |
from X11SRCDIR. |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "no" |
|
|
TTOOOOLLDDIIRR 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, |
a given host system and NetBSD source tree. (However, |
multiple targets may share the same TTOOOOLLDDIIRR; the target- |
multiple targets may share the same TOOLDIR; the target- |
dependent files have unique names.) If unset, a default |
dependent files have unique names.) If unset, a default |
based on the uname(1) information of the host platform will |
based on the uname(1) information of the host platform will |
be created in the ..OOBBJJDDIIRR of _s_r_c. |
be created in the .OBJDIR of src. |
|
|
_D_e_f_a_u_l_t: Unset. |
Default: Unset. |
|
|
UUSSEETTOOOOLLSS Indicates whether the tools specified by TTOOOOLLDDIIRR should be |
USETOOLS Indicates whether the tools specified by TOOLDIR should be |
used as part of a build in progress. Must be set to ``yes'' |
used as part of a build in progress. Must be set to "yes" if |
if cross-compiling. |
cross-compiling. |
|
|
yyeess Use the tools from TTOOOOLLDDIIRR. |
yes Use the tools from TOOLDIR. |
|
|
nnoo Do not use the tools from TTOOOOLLDDIIRR, but refuse to build |
no Do not use the tools from TOOLDIR, but refuse to build |
native compilation tool components that are version- |
native compilation tool components that are version- |
specific for that tool. |
specific for that tool. |
|
|
nneevveerr Do not use the tools from TTOOOOLLDDIIRR, even when building |
never Do not use the tools from TOOLDIR, even when building |
native tool components. This is similar to the |
native tool components. This is similar to the |
traditional NetBSD build method, but does _n_o_t verify |
traditional NetBSD build method, but does not verify |
that the compilation tools in use are up-to-date |
that the compilation tools in use are up-to-date |
enough in order to build the tree successfully. This |
enough in order to build the tree successfully. This |
may cause build or runtime problems when building the |
may cause build or runtime problems when building the |
whole NetBSD source tree. |
whole NetBSD source tree. |
|
|
_D_e_f_a_u_l_t: ``yes'', unless TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG is set to ``yes''. |
Default: "yes", unless TOOLCHAIN_MISSING is set to "yes". |
|
|
UUSSEETTOOOOLLSS is also set to ``no'' when using <bsd.*.mk> outside |
USETOOLS is also set to "no" when using <bsd.*.mk> outside |
the NetBSD source tree. |
the NetBSD source tree. |
|
|
XX1111SSRRCCDDIIRR Directory containing the X11R6 source. If specified, must be |
X11SRCDIR Directory containing the modular Xorg source. If specified, |
an absolute path. The main X11R6 source is found in |
must be an absolute path. The main modular Xorg source is |
XX1111SSRRCCDDIIRR_/_x_f_r_e_e_/_x_c. |
found in X11SRCDIR/external/mit. |
|
|
_D_e_f_a_u_l_t: NNEETTBBSSDDRRCCDDIIRR_/_._._/_x_s_r_c, if that exists; otherwise |
Default: NETBSDRCDIR/../xsrc, if that exists; otherwise |
_/_u_s_r_/_x_s_r_c. |
/usr/xsrc. |
|
|
XX1111FFLLAAVVOOUURR The style of X11 cross-built, set to either ``Xorg'' or |
"make" variables for full builds |
``XFree86''. |
These variables only affect the top level "Makefile" and do not affect |
|
|
_D_e_f_a_u_l_t: ``Xorg'' on amd64, i386, macppc, shark and sparc64 |
|
platforms, ``XFree86'' on everything else. |
|
|
|
""mmaakkee"" vvaarriiaabblleess ffoorr ffuullll bbuuiillddss |
|
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. |
|
|
IINNSSTTAALLLLWWOORRLLDDDDIIRR Location for the ``make installworld'' target to install |
INSTALLWORLDDIR Location for the "make installworld" target to install |
to. If specified, must be an absolute path. |
to. If specified, must be an absolute path. |
|
|
_D_e_f_a_u_l_t: ``/'' |
Default: "/" |
|
|
MMKKOOBBJJDDIIRRSS Can be set to ``yes'' or ``no''. Indicates whether |
MKOBJDIRS Can be set to "yes" or "no". Indicates whether object |
object directories will be created automatically (via a |
directories will be created automatically (via a "make |
``make obj'' pass) at the start of a build. |
obj" pass) at the start of a build. |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "no" |
|
|
If using bbuuiilldd..sshh, the default is ``yes''. This may be |
If using build.sh, the default is "yes". This may be |
set back to ``no'' by giving bbuuiilldd..sshh the --oo option. |
set back to "no" by giving build.sh the -o option. |
|
|
MMKKUUPPDDAATTEE Can be set to ``yes'' or ``no''. If set, then in |
MKUPDATE Can be set to "yes" or "no". If set, then in addition |
addition to the effects described for MMKKUUPPDDAATTEE==yyeess |
to the effects described for MKUPDATE=yes above, this |
above, this implies the effects of NNOOCCLLEEAANNDDIIRR (i.e., |
implies the effects of NOCLEANDIR (i.e., "make cleandir" |
``make cleandir'' is avoided). |
is avoided). |
|
|
_D_e_f_a_u_l_t: ``no'' |
Default: "no" |
|
|
If using bbuuiilldd..sshh, this may be set by giving the --uu |
If using build.sh, this may be set by giving the -u |
option. |
option. |
|
|
NNBBUUIILLDDJJOOBBSS Now obsolete. Use the make(1) option --jj, instead. See |
NBUILDJOBS Now obsolete. Use the make(1) option -j, instead. See |
below. |
below. |
|
|
_D_e_f_a_u_l_t: Unset. |
Default: Unset. |
|
|
NNOOCCLLEEAANNDDIIRR If set, avoids the ``make cleandir'' phase of a full |
NOCLEANDIR If set, avoids the "make cleandir" phase of a full |
build. This has the effect of allowing only changed |
build. This has the effect of allowing only changed |
files in a source tree to be recompiled. This can speed |
files in a source tree to be recompiled. This can speed |
up builds when updating only a few files in the tree. |
up builds when updating only a few files in the tree. |
|
|
_D_e_f_a_u_l_t: Unset. |
Default: Unset. |
|
|
See also MMKKUUPPDDAATTEE. |
See also MKUPDATE. |
|
|
NNOODDIISSTTRRIIBBDDIIRRSS 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 DDEESSTTDDIIRR, 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 |
where it is known that the system-wide mtree files have |
where it is known that the system-wide mtree files have |
not changed. |
not changed. |
|
|
_D_e_f_a_u_l_t: Unset. |
Default: Unset. |
|
|
NNOOIINNCCLLUUDDEESS 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 |
thinking that some programs are out-of-date simply |
because 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 |
MMKKUUPPDDAATTEE==yyeess instead in that case. |
MKUPDATE=yes instead in that case. |
|
|
_D_e_f_a_u_l_t: Unset. |
Default: Unset. |
|
|
RREELLEEAASSEEDDIIRR 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. |
If specified, must be an absolute path. |
|
|
_D_e_f_a_u_l_t: Unset. |
Default: Unset. |
|
|
_N_o_t_e: bbuuiilldd..sshh will provide a default of _r_e_l_e_a_s_e_d_i_r (in |
Note: build.sh will provide a default of releasedir (in |
the top-level ..OOBBJJDDIIRR) unless run in `expert' mode. |
the top-level .OBJDIR) unless run in `expert' mode. |
|
|
BBUUIILLDDIINNGG |
BUILDING |
""mmaakkee"" ccoommmmaanndd lliinnee ooppttiioonnss |
"make" command line options |
This is not a summary of all the options available to make(1); only the |
This is not a summary of all the options available to make(1); only the |
options used most frequently with NetBSD builds are listed here. |
options used most frequently with NetBSD builds are listed here. |
|
|
--jj _n_j_o_b Run up to _n_j_o_b 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 dependencies as necessary to |
use .WAIT or have explicit dependencies as necessary to |
enforce build ordering. |
enforce build ordering. |
|
|
--mm _d_i_r Specify the default directory for searching for system |
-m dir Specify the default directory for searching for system |
Makefile segments, mainly the <bsd.*.mk> files. When building |
Makefile segments, mainly the <bsd.*.mk> files. When building |
any 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 |
"share/mk" directory in the source tree. This is set |
automatically when building from the top level, or when using |
automatically when building from the top level, or when using |
bbuuiilldd..sshh. |
build.sh. |
|
|
--nn 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. |
|
|
--VV _v_a_r Print make(1)'s idea of the value of _v_a_r. Does not build any |
-V var Print make(1)'s idea of the value of var. Does not build any |
targets. |
targets. |
|
|
_v_a_r_=_v_a_l_u_e Set the variable _v_a_r to _v_a_l_u_e, overriding any setting |
var=value Set the variable var to value, overriding any setting |
specified by the process environment, the MMAAKKEECCOONNFF |
specified by the process environment, the MAKECONF |
configuration file, or the system Makefile segments. |
configuration file, or the system Makefile segments. |
|
|
""mmaakkee"" ttaarrggeettss |
"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 |
the NetBSD source code. It is recommended that none of these be used |
the NetBSD source code. It is recommended that none of these be used |
from the top level Makefile; as a specific exception, ``make obj'' and |
from the top level Makefile; as a specific exception, "make obj" and |
``make cleandir'' are useful in that context. |
"make cleandir" are useful in that context. |
|
|
aallll Build programs, libraries, and preformatted documentation. |
all Build programs, libraries, and preformatted documentation. |
|
|
cclleeaann Remove program and library object code files. |
clean Remove program and library object code files. |
|
|
cclleeaannddiirr Same as cclleeaann, but also remove preformatted documentation, |
cleandir Same as clean, but also remove preformatted documentation, |
dependency 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. |
files known to be created at build time. |
|
|
ddeeppeenndd Create dependency files (..ddeeppeenndd) containing more detailed |
depend Create dependency files (.depend) containing more detailed |
information 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. |
|
|
ddeeppeennddaallll Does a ``make depend'' immediately followed by a ``make all''. |
dependall Does a "make depend" immediately followed by a "make all". |
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. |
|
|
ddiissttcclleeaann Synonym for cclleeaannddiirr. |
distclean Synonym for cleandir. |
|
|
iinncclluuddeess Build and install system header files. Typically needed |
includes Build and install system header files. Typically needed |
before any system libraries or programs can be built. |
before any system libraries or programs can be built. |
|
|
iinnssttaallll Install programs, libraries, and documentation into DDEESSTTDDIIRR. |
install Install programs, libraries, and documentation into DESTDIR. |
Few files will be installed to DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c, |
Few files will be installed to DESTDIR/dev, DESTDIR/etc, |
DDEESSTTDDIIRR_/_r_o_o_t or DDEESSTTDDIIRR_/_v_a_r in order to prevent user supplied |
DESTDIR/root or DESTDIR/var in order to prevent user supplied |
configuration data from being overwritten. |
configuration data from being overwritten. |
|
|
lliinntt Run lint(1) against the C source code, where appropriate, and |
lint Run lint(1) against the C source code, where appropriate, and |
generate system-installed lint libraries. |
generate system-installed lint libraries. |
|
|
oobbjj Create object directories to be used for built files, instead |
obj Create object directories to be used for built files, instead |
of building directly in the source tree. |
of building directly in the source tree. |
|
|
ttaaggss Create ctags(1) searchable function lists usable by the ex(1) |
tags Create ctags(1) searchable function lists usable by the ex(1) |
and vi(1) text editors. |
and vi(1) text editors. |
|
|
""mmaakkee"" ttaarrggeettss ffoorr tthhee ttoopp lleevveell |
"make" targets for the top level |
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. |
|
|
bbuuiilldd Build the entire NetBSD system (except the kernel). This |
build Build the entire NetBSD system (except the kernel). This |
orders portions of the source tree such that prerequisites |
orders portions of the source tree such that prerequisites |
will be built in the proper order. |
will be built in the proper order. |
|
|
ddiissttrriibbuuttiioonn Do a ``make build'', and then install a full distribution |
distribution Do a "make build", and then install a full distribution |
(which does not include a kernel) into DDEESSTTDDIIRR, including |
(which does not include a kernel) into DESTDIR, including |
files in DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c, DDEESSTTDDIIRR_/_r_o_o_t and |
files in DESTDIR/dev, DESTDIR/etc, DESTDIR/root and |
DDEESSTTDDIIRR_/_v_a_r. |
DESTDIR/var. |
|
|
bbuuiillddwwoorrlldd As per ``make distribution'', except that it ensures that |
buildworld As per "make distribution", except that it ensures that |
DDEESSTTDDIIRR is not the root directory. |
DESTDIR is not the root directory. |
|
|
iinnssttaallllwwoorrlldd Install the distribution from DDEESSTTDDIIRR to IINNSSTTAALLLLWWOORRLLDDDDIIRR, |
installworld Install the distribution from DESTDIR to INSTALLWORLDDIR, |
which defaults to the root directory. Ensures that |
which defaults to the root directory. Ensures that |
IINNSSTTAALLLLWWOORRLLDDDDIIRR is not the root directory if cross |
INSTALLWORLDDIR is not the root directory if cross |
compiling. |
compiling. |
|
|
The IINNSSTTAALLLLSSEETTSS 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 |
default, all sets except ``etc'' and ``xetc'' are |
default, all sets except "etc" and "xetc" are installed, so |
installed, so most files in IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c will not be |
most files in INSTALLWORLDDIR/etc will not be installed or |
installed or modified. |
modified. |
|
|
_N_o_t_e: Before performing this operation with |
Note: Before performing this operation with |
IINNSSTTAALLLLWWOORRLLDDDDIIRR=_/, it is highly recommended that you |
INSTALLWORLDDIR=/, it is highly recommended that you |
upgrade your kernel and reboot. After performing this |
upgrade your kernel and reboot. After performing this |
operation, it is recommended that you use etcupdate(8) to |
operation, it is recommended that you use etcupdate(8) to |
update files in IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c, and postinstall(8) to |
update files in INSTALLWORLDDIR/etc, and postinstall(8) to |
check for or fix inconsistencies. |
check for or fix inconsistencies. |
|
|
sseettss Create distribution sets from DDEESSTTDDIIRR into |
sets Create distribution sets from DESTDIR into |
RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_e_t_s. Should be run |
RELEASEDIR/RELEASEMACHINEDIR/binary/sets. Should be run |
after ``make distribution'', as ``make build'' alone does |
after "make distribution", as "make build" alone does not |
not install all of the required files. |
install all of the required files. |
|
|
ssoouurrcceesseettss Create source sets of the source tree into |
sourcesets Create source sets of the source tree into |
RREELLEEAASSEEDDIIRR_/_s_o_u_r_c_e_/_s_e_t_s. |
RELEASEDIR/source/sets. |
|
|
ssyyssppkkggss Create syspkgs from DDEESSTTDDIIRR into |
syspkgs Create syspkgs from DESTDIR into |
RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_y_s_p_k_g_s. Should be run |
RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs. Should be run |
after ``make distribution'', as ``make build'' alone does |
after "make distribution", as "make build" alone does not |
not install all of the required files. |
install all of the required files. |
|
|
rreelleeaassee 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 |
then package the system into a standard release layout as |
package the system into a standard release layout as |
described by release(7). This requires that RREELLEEAASSEEDDIIRR be |
described by release(7). This requires that RELEASEDIR be |
set (see above). |
set (see above). |
|
|
iissoo--iimmaaggee Create a NetBSD installation CD-ROM image in the |
iso-image Create a NetBSD installation CD-ROM image in the |
RREELLEEAASSEEDDIIRR_/_i_s_o directory. The CD-ROM file system will have |
RELEASEDIR/images directory. The CD-ROM file system will |
a layout as described in release(7). |
have 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 |
will automatically run the sysinst(8) menu-based |
Line 593 BBUUIILLDDIINNGG |
|
Line 664 BBUUIILLDDIINNGG |
|
tools that may be useful in repairing a damaged NetBSD |
tools that may be useful in repairing a damaged NetBSD |
installation. |
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 RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m |
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom |
directory by ``make release''. These smaller images |
directory by "make release". These smaller images usually |
usually contain the same tools as the larger images in |
contain the same tools as the larger images in |
RREELLEEAASSEEDDIIRR_/_i_s_o, but do not contain additional content such |
RELEASEDIR/images, but do not contain additional content |
as the distribution sets. |
such 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) |
creating CD-ROM images. This requires the mkisofs(1) |
utility, which is not part of NetBSD, but which can be |
utility, which is not part of NetBSD, but which can be |
installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s. |
installed from pkgsrc/sysutils/cdrtools. |
|
|
iissoo--iimmaaggee--ssoouurrccee |
iso-image-source |
Create a NetBSD installation CD-ROM image in the |
Create a NetBSD installation CD-ROM image in the |
RREELLEEAASSEEDDIIRR_/_i_s_o directory. The CD-ROM file system will have |
RELEASEDIR/images directory. The CD-ROM file system will |
a layout as described in release(7). It will have top |
have a layout as described in release(7). It will have top |
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 |
Line 621 BBUUIILLDDIINNGG |
|
Line 692 BBUUIILLDDIINNGG |
|
tools that may be useful in repairing a damaged NetBSD |
tools that may be useful in repairing a damaged NetBSD |
installation. |
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 |
must be populated by "make sourcesets release" or |
equivalent. |
equivalent. |
|
|
Note that other, smaller, CD-ROM images may be created in |
Note that other, smaller, CD-ROM images may be created in |
the RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m |
the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom |
directory by ``make release''. These smaller images |
directory by "make release". These smaller images usually |
usually contain the same tools as the larger images in |
contain the same tools as the larger images in |
RREELLEEAASSEEDDIIRR_/_i_s_o, but do not contain additional content such |
RELEASEDIR/images, but do not contain additional content |
as the distribution sets. |
such 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) |
creating CD-ROM images. This requires the mkisofs(1) |
utility, which is not part of NetBSD, but which can be |
utility, which is not part of NetBSD, but which can be |
installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s. |
installed from pkgsrc/sysutils/cdrtools. |
|
|
iinnssttaallll--iimmaaggee |
install-image |
Create a bootable NetBSD installation disk image in the |
Create a bootable NetBSD installation disk image in the |
RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_i_n_s_t_a_l_l_i_m_a_g_e |
RELEASEDIR/images directory. The installation disk image |
directory. The installation disk image is suitable for |
is suitable for copying to bootable USB flash memory |
copying to bootable USB flash memory sticks, etc., for |
sticks, etc., for machines which are able to boot from such |
machines which are able to boot from such devices. The |
devices. The file system in the bootable disk image will |
file system in the bootable disk image will have a layout |
have a layout as described in release(7). |
as described in release(7). |
|
|
|
The installation image is bootable, and will automatically |
The installation image is bootable, and will automatically |
run the sysinst(8) menu-based installation program, which |
run the sysinst(8) menu-based installation program, which |
Line 652 BBUUIILLDDIINNGG |
|
Line 722 BBUUIILLDDIINNGG |
|
image also contains tools that may be useful in repairing a |
image also contains tools that may be useful in repairing a |
damaged NetBSD installation. |
damaged NetBSD installation. |
|
|
Before ``make install-image'' is attempted, RREELLEEAASSEEDDIIRR must |
Before "make install-image" is attempted, RELEASEDIR must |
be populated by ``make release'' or equivalent. The build |
be populated by "make release" or equivalent. The build |
must have been performed with MMKKUUNNPPRRIIVVEEDD==yyeess because ``make |
must have been performed with MKUNPRIVED=yes because "make |
install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G. |
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/images |
RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_l_i_v_e_i_m_a_g_e |
|
directory. The live image contains all necessary files to |
directory. The live image contains all necessary files to |
boot NetBSD up to multi-user mode, including all files |
boot NetBSD up to multi-user mode, including all files |
which should be extracted during installation, NetBSD |
which should be extracted during installation, NetBSD |
Line 669 BBUUIILLDDIINNGG |
|
Line 738 BBUUIILLDDIINNGG |
|
to 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 |
populated by ``make release'' or equivalent. The build |
populated by "make release" or equivalent. The build must |
must have been performed with MMKKUUNNPPRRIIVVEEDD==yyeess because ``make |
have been performed with MKUNPRIVED=yes because "make |
install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G. |
install-image" relies on information in DESTDIR/METALOG. |
|
|
rreeggrreessssiioonn--tteessttss |
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 |
tests on the local host. Note that most tests are now |
on the local host. Note that most tests are now managed |
managed instead using atf(7); this target should probably |
instead using atf(7); this target should probably run those |
run those as well but currently does not. |
as well but currently does not. |
|
|
TThhee ""bbuuiilldd..sshh"" ssccrriipptt |
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 |
system on any host with a suitable modern shell and some common |
utilities. The required shell features are described under the HHOOSSTT__SSHH |
utilities. The required shell features are described under the HOST_SH |
variable. |
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 |
like |
like |
|
|
/path/to/suitable/shell build.sh [_o_p_t_i_o_n_s] |
/path/to/suitable/shell build.sh [options] |
|
|
The above command will usually enable bbuuiilldd..sshh to automatically set |
The above command will usually enable build.sh to automatically set |
HHOOSSTT__SSHH==_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l, but if that fails, then the following |
HOST_SH=/path/to/suitable/shell, but if that fails, then the following |
set of commands may be used instead: |
set of commands may be used instead: |
|
|
HOST_SH=_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l |
HOST_SH=/path/to/suitable/shell |
export HOST_SH |
export HOST_SH |
${HOST_SH} build.sh [_o_p_t_i_o_n_s] |
${HOST_SH} build.sh [options] |
|
|
If bbuuiilldd..sshh detects that it is being executed under an unsuitable shell, |
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. |
it attempts to exec a suitable shell instead, or prints an error message. |
If HHOOSSTT__SSHH is not set explicitly, then bbuuiilldd..sshh sets a default using |
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 |
heuristics dependent on the host platform, or from the shell under which |
bbuuiilldd..sshh is executed (if that can be determined), or using the first copy |
build.sh is executed (if that can be determined), or using the first copy |
of _s_h found in PPAATTHH. |
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 bbuuiilldd..sshh 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 |
the make(1) program will be bootstrapped properly, in case the host |
system has an older or incompatible ``make'' program. |
system has an older or incompatible "make" program. |
|
|
When compiling the entire system via bbuuiilldd..sshh, 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 |
of options below, variables that are automatically set by bbuuiilldd..sshh are |
of options below, variables that are automatically set by build.sh are |
noted where applicable. |
noted where applicable. |
|
|
The following operations are supported by bbuuiilldd..sshh: |
The following operations are supported by build.sh: |
|
|
bbuuiilldd Build the system as per ``make build''. Before the main |
build Build the system as per "make build". Before the main part |
part of the build commences, this command runs the oobbjj |
of the build commences, this command runs the obj operation |
operation (unless the --oo option is given), ``make |
(unless the -o option is given), "make cleandir" (unless |
cleandir'' (unless the --uu option is given), and the ttoooollss |
the -u option is given), and the tools operation. |
operation. |
|
|
|
ddiissttrriibbuuttiioonn Build a full distribution as per ``make distribution''. |
distribution Build a full distribution as per "make distribution". This |
This command first runs the bbuuiilldd operation. |
command first runs the build operation. |
|
|
rreelleeaassee Build a full release as per ``make release''. This command |
release Build a full release as per "make release". This command |
first runs the ddiissttrriibbuuttiioonn operation. |
first runs the distribution operation. |
|
|
mmaakkeewwrraappppeerr Create the nnbbmmaakkee--MMAACCHHIINNEE wrapper. This operation is |
makewrapper Create the nbmake-MACHINE wrapper. This operation is |
automatically performed for any of the other operations. |
automatically performed for any of the other operations. |
|
|
cclleeaannddiirr Perform ``make cleandir''. |
cleandir Perform "make cleandir". |
|
|
oobbjj Perform ``make obj''. |
obj Perform "make obj". |
|
|
ttoooollss Build and install the host tools from _s_r_c_/_t_o_o_l_s. This |
tools Build and install the host tools from src/tools. This |
command will first run ``make obj'' and ``make cleandir'' |
command will first run "make obj" and "make cleandir" in |
in the _t_o_o_l_s subdirectory unless the --oo or --uu options |
the tools subdirectory unless the -o or -u options |
(respectively) are given. |
(respectively) are given. |
|
|
iinnssttaallll=_i_d_i_r Install the contents of DDEESSTTDDIIRR to _i_d_i_r, 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 "etc" |
``etc'' or ``xetc'' sets will not be installed, unless |
or "xetc" sets will not be installed, unless overridden by |
overridden by the INSTALLSETS environment variable. |
the INSTALLSETS environment variable. |
|
|
kkeerrnneell=_k_c_o_n_f Build a new kernel. The _k_c_o_n_f 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(1). If _k_c_o_n_f |
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 KKEERRNNCCOONNFFDDIIRR directory, which |
is expected to be found in the KERNCONFDIR directory, which |
is typically ssyyss//aarrcchh//MMAACCHHIINNEE//ccoonnff. The new kernel will be |
is typically sys/arch/MACHINE/conf. The new kernel will be |
built in a subdirectory of KKEERRNNOOBBJJDDIIRR, which is typically |
built in a subdirectory of KERNOBJDIR, which is typically |
ssyyss//aarrcchh//MMAACCHHIINNEE//ccoommppiillee or an associated object directory. |
sys/arch/MACHINE/compile or an associated object directory. |
|
|
This command does _n_o_t imply the ttoooollss command; run the |
This command does not imply the tools command; run the |
ttoooollss command first unless it is _c_e_r_t_a_i_n that the tools |
tools command first unless it is certain that the tools |
already exist and are up to date. |
already exist and are up to date. |
|
|
This command will run ``make cleandir'' on the kernel in |
This command will run "make cleandir" on the kernel in |
question first unless the --uu 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). |
|
|
|
kernels This command will build all kernels defined in port |
|
specific release build procedure. |
|
|
mmoodduulleess This command will build kernel modules and install them |
This command internally calls the kernel=kconf operation |
into DDEESSTTDDIIRR. |
for each found kernel configuration file. |
|
|
rreelleeaasseekkeerrnneell=_k_c_o_n_f |
modules This command will build kernel modules and install them |
|
into DESTDIR. |
|
|
|
releasekernel=kconf |
Install a gzip(1)ed copy of the kernel previously built by |
Install a gzip(1)ed copy of the kernel previously built by |
kkeerrnneell=_k_c_o_n_f into |
kernel=kconf into |
RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_k_e_r_n_e_l, usually as |
RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as |
_n_e_t_b_s_d_-_k_c_o_n_f_._g_z, although the ``_n_e_t_b_s_d'' prefix is |
netbsd-kconf.gz, although the "netbsd" prefix is determined |
determined from the ``ccoonnffiigg'' directives in _k_c_o_n_f. |
from the "config" directives in kconf. |
|
|
|
sets Perform "make sets". |
|
|
sseettss Perform ``make sets''. |
sourcesets Perform "make sourcesets". |
|
|
ssoouurrcceesseettss Perform ``make sourcesets''. |
syspkgs Perform "make syspkgs". |
|
|
ssyyssppkkggss Perform ``make syspkgs''. |
iso-image Perform "make iso-image". |
|
|
iissoo--iimmaaggee Perform ``make iso-image''. |
iso-image-source |
|
Perform "make iso-image-source". |
|
|
iissoo--iimmaaggee--ssoouurrccee |
install-image |
Perform ``make iso-image-source''. |
Perform "make install-image". |
|
|
iinnssttaallll--iimmaaggee |
live-image Perform "make live-image". |
Perform ``make install-image''. |
|
|
|
lliivvee--iimmaaggee Perform ``make live-image''. |
list-arch Prints a list of valid MACHINE and MACHINE_ARCH settings, |
|
the default MACHINE_ARCH for each MACHINE, and aliases for |
|
MACHINE/MACHINE_ARCH pairs, and then exits. The -m or -a |
|
options (or both) may be used to specify glob patterns that |
|
will be used to narrow the list of results; for example, |
|
"build.sh -m 'evm*' -a '*arm*' list-arch" will list all |
|
known MACHINE/MACHINE_ARCH values in which either MACHINE |
|
or ALIAS matches the pattern `evb*', and MACHINE_ARCH |
|
matches the pattern `*arm*'. |
|
|
The following command line options alter the behaviour of the bbuuiilldd..sshh |
The following command line options alter the behaviour of the build.sh |
operations described above: |
operations described above: |
|
|
--aa _a_r_c_h Set the value of MMAACCHHIINNEE__AARRCCHH to _a_r_c_h. |
-a arch Set the value of MACHINE_ARCH to arch. See the -m option for |
|
more information. |
|
|
--BB _b_u_i_l_d_i_d |
-B buildid |
Set the value of BBUUIILLDDIIDD to _b_u_i_l_d_i_d. This will also append the |
Set the value of BUILDID to buildid. This will also append the |
build identifier 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 |
``nnbbmmaakkee--MMAACCHHIINNEE--BBUUIILLDDIIDD''. |
"nbmake-MACHINE-BUILDID". |
|
|
--CC _c_d_e_x_t_r_a_s |
-C cdextras |
Append _c_d_e_x_t_r_a_s to the CCDDEEXXTTRRAA variable, which is a space- |
Append cdextras to the CDEXTRA variable, which is a space- |
separated list of files or directories that will be added to |
separated list of files or directories that will be added to |
the 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 |
root of the CD-ROM image, whereas directories will be copied |
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 |
converted to absolute paths before being used. Multiple paths |
converted to absolute paths before being used. Multiple paths |
may be specified via multiple --CC 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. |
|
|
--DD _d_e_s_t Set the value of DDEESSTTDDIIRR to _d_e_s_t. If a relative path is |
-D dest Set the value of DESTDIR to dest. If a relative path is |
specified, it will be converted to an absolute path before |
specified, it will be converted to an absolute path before |
being used. |
being used. |
|
|
--EE Set `expert' mode. This overrides various sanity checks, and |
-E Set `expert' mode. This overrides various sanity checks, and |
allows: DDEESSTTDDIIRR 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 MMKKUUNNPPRRIIVVEEDD==yyeess does not have to be set when |
builds, and MKUNPRIVED=yes does not have to be set when |
building as a non-root user. |
building as a non-root user. |
|
|
_N_o_t_e: 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. |
|
|
--hh Print a help message. |
-h Print a help message. |
|
|
--jj _n_j_o_b Run up to _n_j_o_b 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 bbuuiilldd..sshh with --jj, please save |
out of memory while using build.sh with -j, please save |
complete build logs so the failures can be analyzed. |
complete build logs so the failures can be analyzed. |
|
|
To achieve the fastest builds, --jj values between (1 + the |
To achieve the fastest builds, -j values between (1 + the |
number of CPUs) and (2 * the number of CPUs) are recommended. |
number of CPUs) and (2 * the number of CPUs) are recommended. |
Use lower values on machines with limited memory or I/O |
Use lower values on machines with limited memory or I/O |
bandwidth. |
bandwidth. |
|
|
--MM _o_b_j Set MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX to _o_b_j. Unsets MMAAKKEEOOBBJJDDIIRR. See ``--OO |
-M obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR. See "-O obj" |
--oobbjj'' for more information. |
for more information. |
|
|
For instance, if the source directory is _/_u_s_r_/_s_r_c, a setting of |
For instance, if the source directory is /usr/src, a setting of |
``--MM _/_u_s_r_/_o_b_j'' will place build-time files under |
"-M /usr/obj" will place build-time files under |
_/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_b_i_n, _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_l_i_b, |
/usr/obj/usr/src/bin, /usr/obj/usr/src/lib, |
_/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_u_s_r_._b_i_n, 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. bbuuiilldd..sshh imposes the |
absolute path before being used. build.sh imposes the |
restriction that the argument to the --MM option must not begin |
restriction that the argument to the -M option must not begin |
with a ``$'' (dollar sign) character; otherwise it would be too |
with a "$" (dollar sign) character; otherwise it would be too |
difficult to determine whether the value is an absolute or a |
difficult to determine whether the value is an absolute or a |
relative path. If the directory does not already exist, |
relative path. If the directory does not already exist, |
bbuuiilldd..sshh will create it. |
build.sh will create it. |
|
|
--mm _m_a_c_h Set the value of MMAACCHHIINNEE to _m_a_c_h, except in some special cases |
-m mach Set the value of MACHINE to mach, unless the mach argument is |
listed below. This will also override any value of |
an alias that refers to a MACHINE/MACHINE_ARCH pair, in which |
MMAACCHHIINNEE__AARRCCHH in the process environment with a value deduced |
case both MACHINE and MACHINE_ARCH are set from the alias. |
from _m_a_c_h, unless --aa is specified. All cross builds require |
Such aliases are interpreted entirely by build.sh; they are not |
--mm, but if unset on a NetBSD host, the host's value of MACHINE |
used by any other part of the build system. The MACHINE_ARCH |
will be detected and used automatically. |
setting implied by mach will override any value of MACHINE_ARCH |
|
in the process environment, but will not override a value set |
Some machines support multiple values for MMAACCHHIINNEE__AARRCCHH. The |
by the -a option. All cross builds require -m, but if unset on |
following special cases for the _m_a_c_h argument are defined to |
a NetBSD host, the host's value of MACHINE will be detected and |
set the listed values of MMAACCHHIINNEE and MMAACCHHIINNEE__AARRCCHH: |
used automatically. |
|
|
mmaacchh MMAACCHHIINNEE MMAACCHHIINNEE__AARRCCHH |
See the list-arch operation for a way to get a list of valid |
evbarm evbarm (not set) |
MACHINE and MACHINE_ARCH settings. |
evbarm-eb evbarm armeb |
|
evbarm-el evbarm arm |
-N noiselevel |
evbmips evbmips (not set) |
Set the "noisyness" level of the build, by setting MAKEVERBOSE |
evbmips-eb evbmips mipseb |
to noiselevel. |
evbmips-el evbmips mipsel |
|
evbsh3 evbsh3 (not set) |
-n Show the commands that would be executed by build.sh, but do |
evbsh3-eb evbsh3 sh3eb |
not make any changes. This is similar in concept to "make -n". |
evbsh3-el evbsh3 sh3el |
|
sbmips sbmips (not set) |
-O obj Create an appropriate transform macro for MAKEOBJDIR that will |
sbmips-eb sbmips mipseb |
place the built object files under obj. Unsets |
sbmips-el sbmips mipsel |
MAKEOBJDIRPREFIX. |
|
|
--NN _n_o_i_s_e_l_e_v_e_l |
For instance, a setting of "-O /usr/obj" will place build-time |
Set the ``noisyness'' level of the build, by setting |
files under /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and |
MMAAKKEEVVEERRBBOOSSEE to _n_o_i_s_e_l_e_v_e_l. |
so forth. |
|
|
--nn Show the commands that would be executed by bbuuiilldd..sshh, but do |
|
not make any changes. This is similar in concept to ``make |
|
-n''. |
|
|
|
--OO _o_b_j Create an appropriate transform macro for MMAAKKEEOOBBJJDDIIRR that will |
|
place the built object files under _o_b_j. Unsets |
|
MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX. |
|
|
|
For instance, a setting of ``--OO _/_u_s_r_/_o_b_j'' will place build- |
|
time files under _/_u_s_r_/_o_b_j_/_b_i_n, _/_u_s_r_/_o_b_j_/_l_i_b, _/_u_s_r_/_o_b_j_/_u_s_r_._b_i_n, |
|
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. bbuuiilldd..sshh imposes the |
absolute path before being used. build.sh imposes the |
restriction that the argument to the --OO option must not contain |
restriction that the argument to the -O option must not contain |
a ``$'' (dollar sign) character. If the directory does not |
a "$" (dollar sign) character. If the directory does not |
already exist, bbuuiilldd..sshh will create it. |
already exist, build.sh will create it. |
|
|
In normal use, exactly one of the --MM or --OO options should be |
In normal use, exactly one of the -M or -O options should be |
specified. If neither --MM nor --OO is specified, then a default |
specified. If neither -M nor -O is specified, then a default |
object directory will be chosen according to rules in |
object directory will be chosen according to rules in |
<bsd.obj.mk>. Relying on this default is not recommended |
<bsd.obj.mk>. Relying on this default is not recommended |
because it is determined by complex rules that are influenced |
because it is determined by complex rules that are influenced |
by the values of several variables and by the location of the |
by the values of several variables and by the location of the |
source directory. |
source directory. |
|
|
--oo Set the value of MMKKOOBBJJDDIIRRSS to ``no''. Otherwise, it will be |
Note that placing the obj directory location outside of the |
automatically set to ``yes''. This default is opposite to the |
default source tree hierarchy makes it easier to manually clear |
behaviour when not using bbuuiilldd..sshh. |
out old files in the event the "make cleandir" operation is |
|
unable to do so. (See CAVEATS below.) |
|
|
|
Note also that use of one of -M or -O is the only means of |
|
building multiple machine architecture userlands from the same |
|
source tree without cleaning between builds (in which case, one |
|
would specify distinct obj locations for each). |
|
|
|
-o Set the value of MKOBJDIRS to "no". Otherwise, it will be |
|
automatically set to "yes". This default is opposite to the |
|
behaviour when not using build.sh. |
|
|
--RR _r_e_l Set the value of RREELLEEAASSEEDDIIRR to _r_e_l. If a relative path is |
-R rel Set the value of RELEASEDIR to rel. If a relative path is |
specified, it will be converted to an absolute path before |
specified, it will be converted to an absolute path before |
being used. |
being used. |
|
|
--rr Remove the contents of DDEESSTTDDIIRR and TTOOOOLLDDIIRR 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 |
DDEESSTTDDIIRR if building on a native system to the root directory. |
DESTDIR if building on a native system to the root directory. |
|
|
--SS _s_e_e_d Change the value of BBUUIILLDDSSEEEEDD to _s_e_e_d. This should rarely be |
-S seed Change the value of BUILDSEED to seed. This should rarely be |
necessary. |
necessary. |
|
|
--TT _t_o_o_l_s Set the value of TTOOOOLLDDIIRR to _t_o_o_l_s. If a relative path is |
-T tools Set the value of TOOLDIR to tools. If a relative path is |
specified, it will be converted to an absolute path before |
specified, it will be converted to an absolute path before |
being used. If set, the bootstrap ``make'' will only be |
being used. If set, the bootstrap "make" will only be rebuilt |
rebuilt if the source files for make(1) have changed. |
if the source files for make(1) have changed. |
|
|
--UU Set MMKKUUNNPPRRIIVVEEDD==yyeess. |
-U Set MKUNPRIVED=yes. |
|
|
--uu Set MMKKUUPPDDAATTEE==yyeess. |
-u Set MKUPDATE=yes. |
|
|
--VV _v_a_r=[_v_a_l_u_e] |
-V var=[value] |
Set the environment variable _v_a_r to an optional _v_a_l_u_e. This is |
Set the environment variable var to an optional value. This is |
propagated to the nnbbmmaakkee wrapper. |
propagated to the nbmake wrapper. |
|
|
--ww _w_r_a_p_p_e_r |
-w wrapper |
Create the nnbbmmaakkee wrapper script (see below) in a custom |
Create the nbmake wrapper script (see below) in a custom |
location, specified by _w_r_a_p_p_e_r. This allows, for instance, to |
location, specified by wrapper. This allows, for instance, to |
place the wrapper in PPAATTHH automatically. Note that _w_r_a_p_p_e_r 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 |
path before being used. |
path before being used. |
|
|
--XX _x_1_1_s_r_c |
-X x11src |
Set the value of XX1111SSRRCCDDIIRR to _x_1_1_s_r_c. If a relative path is |
Set the value of X11SRCDIR to x11src. If a relative path is |
specified, it will be converted to an absolute path before |
specified, it will be converted to an absolute path before |
being used. |
being used. |
|
|
--xx Set MMKKXX1111==yyeess. |
-x Set MKX11=yes. |
|
|
|
-Y extsrcdir |
|
Set the value of EXTSRCSRCDIR to extsrcdir. If a relative path |
|
is specified, it will be converted to an absolute path before |
|
being used. |
|
|
|
-y Set MKEXTSRC=yes. |
|
|
--ZZ _v_a_r Unset ("zap") the environment variable _v_a_r. This is propagated |
-Z var Unset ("zap") the environment variable var. This is propagated |
to the nnbbmmaakkee wrapper. |
to the nbmake wrapper. |
|
|
TThhee ""nnbbmmaakkee--MMAACCHHIINNEE"" wwrraappppeerr ssccrriipptt |
The "nbmake-MACHINE" wrapper script |
If using the bbuuiilldd..sshh script to build NetBSD, a nnbbmmaakkee--MMAACCHHIINNEE script |
If using the build.sh script to build NetBSD, a nbmake-MACHINE script |
will be created in TTOOOOLLDDIIRR//bbiinn upon the first build to assist in building |
will be created in TOOLDIR/bin upon the first build to assist in building |
subtrees on a cross-compile host. |
subtrees on a cross-compile host. |
|
|
nnbbmmaakkee--MMAACCHHIINNEE 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 TTOOOOLLDDIIRR//bbiinn with |
the up-to-date version of "nbmake" installed into TOOLDIR/bin with |
several key variables pre-set, including MMAACCHHIINNEE, MMAACCHHIINNEE__AARRCCHH, and |
several key variables pre-set, including MACHINE, MACHINE_ARCH, and |
TTOOOOLLDDIIRR. nnbbmmaakkee--MMAACCHHIINNEE will also set variables specified with --VV, and |
TOOLDIR. nbmake-MACHINE will also set variables specified with -V, and |
unset variables specified with --ZZ. |
unset variables specified with -Z. |
|
|
This script can be symlinked into a directory listed in PPAATTHH, or called |
This script can be symlinked into a directory listed in PATH, or called |
with an absolute path. |
with an absolute path. |
|
|
EEXXAAMMPPLLEESS |
EXAMPLES |
1. % ./build.sh [options] 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 |
Line 975 EEXXAAMMPPLLEESS |
|
Line 1072 EEXXAAMMPPLLEESS |
|
|
|
2. % ./build.sh [options] -U distribution |
2. % ./build.sh [options] -U distribution |
|
|
Using unprivileged mode, build a complete distribution to a DDEESSTTDDIIRR |
Using unprivileged mode, build a complete distribution to a DESTDIR |
directory that bbuuiilldd..sshh selects (and will display). |
directory that build.sh selects (and will display). |
|
|
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, --UU is required so that the |
Even though this is run as root, -U is required so that the |
permissions stored in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G are correctly applied to the |
permissions stored in DESTDIR/METALOG are correctly applied to the |
files 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 |
|
|
Using unprivileged mode, build a complete release to DDEESSTTDDIIRR and |
Using unprivileged mode, build a complete release to DESTDIR and |
RREELLEEAASSEEDDIIRR directories that bbuuiilldd..sshh selects (and will display). |
RELEASEDIR directories that build.sh selects (and will display). |
MMKKUUPPDDAATTEE==yyeess (--uu) is set to prevent the ``make cleandir'', so that |
MKUPDATE=yes (-u) is set to prevent the "make cleandir", so that if |
if this is run after example 2, it doesn't need to redo that portion |
this is run after example 2, it doesn't need to redo that portion of |
of the release build. |
the release build. |
|
|
OOBBSSOOLLEETTEE VVAARRIIAABBLLEESS |
OBSOLETE VARIABLES |
NNBBUUIILLDDJJOOBBSS Use the make(1) option --jj instead. |
NBUILDJOBS Use the make(1) option -j instead. |
|
|
UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN |
USE_NEW_TOOLCHAIN |
The new toolchain is now the default. To disable, use |
The new toolchain is now the default. To disable, use |
TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG==yyeess. |
TOOLCHAIN_MISSING=yes. |
|
|
SSEEEE AALLSSOO |
SEE ALSO |
make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8), |
make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8), |
_p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s |
pkgsrc/sysutils/cdrtools |
|
|
HHIISSTTOORRYY |
HISTORY |
The bbuuiilldd..sshh based build scheme was introduced for NetBSD 1.6 as |
The build.sh based build scheme was introduced for NetBSD 1.6 as |
UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN, and re-worked to TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG after that. |
USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. |
|
|
|
CAVEATS |
|
After significant updates to third-party components in the source tree, |
|
the "make cleandir" operation may be insufficient to clean out old files |
|
in object directories. Instead, one may have to manually remove the |
|
files. Consult the UPDATING file for notices concerning this. |
|
|
NetBSD November 8, 2012 NetBSD |
NetBSD October 21, 2017 NetBSD |