version 1.23, 2003/01/26 05:34:32 |
version 1.66, 2007/09/01 09:32:19 |
|
|
BUILDING(8) NetBSD System Manager's Manual BUILDING(8) |
BUILDING(8) NetBSD System Manager's Manual BUILDING(8) |
|
|
NAME |
NAME |
BUILDING - Procedure for building NetBSD from source code. |
BUILDING -- Procedure for building NetBSD from source code. |
|
|
STATUS |
|
This document is a work-in-progress. As such, the information described |
|
here may not match the reality of the build system as of this writing. |
|
Once this document is completely in sync with reality, this paragraph |
|
will be removed. |
|
|
|
Discrepancies between this documentation and the current reality of 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 |
|
|
doc/BUILDING.mdoc |
doc/BUILDING.mdoc |
This document (in -mdoc troff format; the original copy). |
This document (in -mdoc troff format; the original copy). |
|
|
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.) |
|
|
|
|
Sources imported verbatim from third parties, without man- |
Sources imported verbatim from third parties, without man- |
gling the existing build structure. Other source trees in |
gling the existing build structure. Other source trees in |
bin through usr.sbin use the NetBSD make(1) ``reachover'' |
bin through usr.sbin use the NetBSD make(1) ``reachover'' |
Makefile semantics when building these programs for a na- |
Makefile semantics when building these programs for a |
tive host. |
native host. |
|
|
distrib/, etc/ |
distrib/, etc/ |
Sources for items used when making a full release snap- |
Sources for items used when making a full release snap- |
shot, such as files installed in /etc on the destination |
shot, such as files installed in DESTDIR/etc on the desti- |
system, boot media, and release notes. |
nation system, boot media, and release notes. |
|
|
regress/ Regression test harness. Can be cross-compiled, but only |
regress/ Regression test harness. Can be cross-compiled, but only |
run natively. |
run natively. |
|
|
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. |
|
|
|
HOST_SH Path name to a POSIX-compliant shell. If this is not |
|
set explicitly, then the default is set using heuris- |
|
tics dependent on the host platform, or from the shell |
|
under which build.sh is executed (if that can be deter- |
|
mined), or using the first copy of sh found in PATH. |
|
If the host system's /bin/sh is not POSIX-compliant, we |
|
suggest that you build using commands like |
|
|
|
HOST_SH=/path/to/working/shell |
|
export HOST_SH |
|
${HOST_SH} build.sh [options] |
|
|
|
HOST_CC Path name to C compiler used to create the toolchain. |
|
|
|
HOST_CXX Path name to C++ compiler used to create the toolchain. |
|
|
MACHINE Machine type. |
MACHINE Machine type. |
|
|
MACHINE_ARCH Machine architecture. |
MACHINE_ARCH Machine architecture. |
|
|
MAKEFLAGS Flags to invoke make(1) with. |
MAKEFLAGS Flags to invoke make(1) with. |
|
|
MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- |
MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- |
tory. Used only if MAKEOBJDIRPREFIX is not defined. |
tory. The value is subjected to variable expansion by |
MAKEOBJDIR can only be provided in the environment. |
make(1). Used only if MAKEOBJDIRPREFIX is not defined. |
|
MAKEOBJDIR can only be provided in the environment or |
|
via the -O flag of build.sh. |
|
|
MAKEOBJDIRPREFIX Top level directory of the object directory tree. If |
MAKEOBJDIRPREFIX Top level directory of the object directory tree. If |
this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used |
specified, must be an absolute path. If this is |
as the .OBJDIR for the current directory. The current |
defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the |
directory may be read only. MAKEOBJDIRPREFIX can only |
.OBJDIR for the current directory. The current direc- |
be provided in the environment. |
tory may be read only. MAKEOBJDIRPREFIX can only be |
|
provided in the environment or via the -M flag of |
|
build.sh. |
|
|
"make" variables |
"make" variables |
Several variables control the behavior of NetBSD builds. Unless other- |
Several variables control the behavior of NetBSD builds. Unless other- |
|
|
DESTDIR Directory to contain the built NetBSD system. If set, spe- |
DESTDIR Directory to contain the built NetBSD system. If set, spe- |
cial options are passed to the compilation tools to prevent |
cial options are passed to the compilation tools to prevent |
their default use of the host system's /usr/include, |
their default use of the host system's /usr/include, |
/usr/lib, and so forth. This pathname should not end with a |
/usr/lib, and so forth. This pathname must be an absolute |
slash (/) character (for installation into the system's root |
path, and should not end with a slash (/) character. (For |
directory, set DESTDIR to an empty string). The directory |
installation into the system's root directory, set DESTDIR to |
must reside on a file system which supports long file names |
an empty string, not to ``/''). The directory must reside on |
and hard links. |
a file system which supports long file names and hard links. |
|
|
Default: Empty string if USETOOLS is ``yes''; unset other- |
Default: Empty string if USETOOLS is ``yes''; unset other- |
wise. |
wise. |
|
|
|
Note: build.sh will provide a default of destdir.MACHINE (in |
|
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'' |
|
|
|
MAKEVERBOSE |
|
Level of verbosity of status messages. Supported values: |
|
|
|
0 No descriptive messages are shown. |
|
|
|
1 Descriptive messages are shown. |
|
|
|
2 Descriptive messages (prefixed with a `#') and command |
|
output is not suppressed. |
|
|
|
Default: 2 |
|
|
MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor- |
MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor- |
matted plaintext manual pages will be created during a build. |
matted plaintext manual pages will be created during a build. |
|
|
|
|
MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto- |
MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto- |
graphic code will be included in a build; provided for the |
graphic code will be included in a build; provided for the |
benefit of countries that do not allow strong cryptography. |
benefit of countries that do not allow strong cryptography. |
Will not affect use of the standard low-security password en- |
Will not affect use of the standard low-security password |
cryption system, crypt(3). |
encryption system, crypt(3). |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
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 /usr/share/doc will be installed |
documentation destined for DESTDIR/usr/share/doc will be |
during a build. |
installed during a build. |
|
|
Default: ``yes'' |
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 |
/usr/libdata/lint. |
DESTDIR/usr/libdata/lint. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
|
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'' |
|
|
|
|
|
|
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'' |
|
|
|
|
code. |
code. |
|
|
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 /usr/share will be built and installed |
destined to reside in DESTDIR/usr/share will be built and |
during a build. If set to ``no'', then all of MKCATPAGES, |
installed during a build. If set to ``no'', then all of |
MKDOC, MKINFO, MKMAN, and MKNLS will be set to ``no'' uncon- |
MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to |
ditionally. |
``no'' unconditionally. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
TOOLDIR Directory to hold the host tools, once built. This directory |
MKTTINTERP Can be set to ``yes'' or ``no''. For X builds, decides if |
should be unique to a given host system and NetBSD source |
the TrueType bytecode interpreter is turned on. See |
tree. (However, multiple targets may share the same TOOLDIR; |
http://www.freetype.org/patents.html for details. |
the target-dependent files have unique names.) If unset, a |
|
default based on the uname(1) information of the host plat- |
|
form will be created in the .OBJDIR of src/tools. |
|
|
|
Default: Unset. |
Default: ``no'' |
|
|
UNPRIVED If set, then an unprivileged install will occur. The user, |
MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an |
group, permissions, and file flags, will not be set on the |
unprivileged install will occur. The user, group, permis- |
installed item; instead the information will be appended to a |
sions, and file flags, will not be set on the installed |
file called METALOG in DESTDIR. The contents of METALOG is |
items; instead the information will be appended to a file |
used during the generation of the distribution tar files to |
called METALOG in DESTDIR. The contents of METALOG are used |
ensure that the appropriate file ownership is stored. |
during the generation of the distribution tar files to ensure |
|
that the appropriate file ownership is stored. |
|
|
Default: Unset. |
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 |
|
if the destination files are up-to-date. This also has |
|
implications on full builds (see next subsection). |
|
|
UPDATE If set, then all install operations intended to write to |
Default: ``no'' |
DESTDIR will compare file timestamps before installing, and |
|
skip the install phase if the destination files are up-to- |
MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11R6 is |
date. This also has implications on full builds (see next |
built from X11SRCDIR. |
subsection). |
|
|
Default: ``no'' |
|
|
|
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, multi- |
|
ple 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. |
|
|
|
|
|
|
Default: ``yes'' if building all or part of a whole NetBSD |
Default: ``yes'' if building all or part of a whole NetBSD |
source tree (detected automatically); ``no'' otherwise (to |
source tree (detected automatically); ``no'' otherwise (to |
preserve traditional semantics of the <bsd.*.mk> make(1) in- |
preserve traditional semantics of the <bsd.*.mk> make(1) |
clude files). |
include files). |
|
|
|
X11SRCDIR Directory containing the X11R6 source. If specified, must be |
|
an absolute path. The main X11R6 source is found in |
|
X11SRCDIR/xfree/xc. |
|
|
|
Default: ``/usr/xsrc'' |
|
|
"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: ``yes'' |
Default: ``no'' |
|
|
|
MKUPDATE Can be set to ``yes'' or ``no''. If set, then in addi- |
|
tion to the effects described for MKUPDATE=yes above, |
|
this implies the effects of NOCLEANDIR (i.e., ``make |
|
cleandir'' is avoided). |
|
|
|
Default: ``no'' |
|
|
NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see |
NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see |
below) |
below) |
|
|
|
|
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 |
UPDATE in that case. |
MKUPDATE=yes 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. |
|
|
UPDATE If set, then in addition to the effects described for |
Note: build.sh will provide a default of releasedir (in |
UPDATE above, this implies the effects of NOCLEANDIR. |
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. If you see build failures with -j, |
please save complete build logs so the failures can be ana- |
please save complete build logs so the failures can be ana- |
lyzed. |
lyzed. |
|
|
|
|
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 speci- |
|
|
|
|
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 /dev, /etc, /root or /var in |
Few files will be installed to DESTDIR/dev, DESTDIR/etc, |
order to prevent user supplied configuration data from being |
DESTDIR/root or DESTDIR/var in order to prevent user supplied |
overwritten. |
configuration data from being overwritten. |
|
|
lint 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. |
|
|
the proper order. |
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 /dev, /etc, /root and |
into DESTDIR, including files in DESTDIR/dev, DESTDIR/etc, |
/var. |
DESTDIR/root and DESTDIR/var. |
|
|
buildworld As per ``make distribution'', except that it ensures that |
buildworld As per ``make distribution'', except that it ensures that |
DESTDIR is not the root directory. |
DESTDIR is not the root directory. |
|
|
installworld Install the distribution from DESTDIR to INSTALLWORLDDIR |
installworld Install the distribution from DESTDIR to INSTALLWORLDDIR |
(which defaults to the root directory). Ensures that |
(which defaults to the root directory). Ensures that |
INSTALLWORLDDIR is the not root directory if cross compil- |
INSTALLWORLDDIR is not the root directory if cross compil- |
ing. |
ing. |
|
|
Note: It is highly recommended that you upgrade your kernel |
The INSTALLSETS environment variable may be set to a list |
and reboot before performing this operation. |
of distribution sets to be installed. By default, all sets |
|
except ``etc'' and ``xetc'' are installed (so most files in |
release Do a ``make distribution'', build kernels, distribution me- |
INSTALLWORLDDIR/etc will not be installed or modified). |
dia, and install sets, and then package the system into a |
|
standard release layout as described by release(7). This |
Note: Before performing this operation with |
requires that RELEASEDIR be set (see above). |
INSTALLWORLDDIR=/, it is highly recommended that you |
|
upgrade your kernel and reboot. After performing this |
|
operation, it is recommended that you use etcupdate(8) to |
|
update files in INSTALLWORLDDIR/etc and that you use |
|
postinstall(8) to check for inconsistencies (and possibly |
|
to fix them). |
|
|
|
sets Create distribution sets from DESTDIR into |
|
RELEASEDIR/MACHINE/binary/sets. Should be run after ``make |
|
distribution'' (as ``make build'' does not install all of |
|
the required files). |
|
|
|
sourcesets Create source sets of the source tree into |
|
RELEASEDIR/source/sets. |
|
|
|
syspkgs Create syspkgs from DESTDIR into |
|
RELEASEDIR/MACHINE/binary/syspkgs. Should be run after |
|
``make distribution'' (as ``make build'' does not install |
|
all of the required files). |
|
|
|
release Do a ``make distribution'', build kernels, distribution |
|
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). |
|
|
|
iso-image Create a NetBSD installation CD-ROM image in the |
|
RELEASEDIR/iso directory. The CD-ROM file system will have |
|
a layout as described in release(7). |
|
|
|
For most machine types, the CD-ROM will be bootable, and |
|
will automatically run the sysinst(8) menu-based installa- |
|
tion program, which can be used to install or upgrade a |
|
NetBSD system. Bootable CD-ROMs also contain tools that |
|
may be useful in repairing a damaged NetBSD installation. |
|
|
|
Before ``make iso-image'' is attempted, RELEASEDIR must be |
|
populated by ``make release'' or equivalent. |
|
|
|
Note that other, smaller, CD-ROM images may be created in |
|
the RELEASEDIR/MACHINE/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) util- |
|
ity, which is not part of NetBSD, but which can be |
|
installed from pkgsrc/sysutils/cdrtools. |
|
|
|
iso-image-source |
|
Create a NetBSD installation CD-ROM image in the |
|
RELEASEDIR/iso directory. The CD-ROM file system will have |
|
a layout as described in release(7). It will have top |
|
level directories for the machine type and source. |
|
|
|
For most machine types, the CD-ROM will be bootable, and |
|
will automatically run the sysinst(8) menu-based installa- |
|
tion program, which can be used to install or upgrade a |
|
NetBSD system. Bootable CD-ROMs also contain tools that |
|
may be useful in repairing a damaged NetBSD installation. |
|
|
|
Before ``make iso-image-source'' is attempted, RELEASEDIR |
|
must be populated by ``make sourcesets release'' or equiva- |
|
lent. |
|
|
|
Note that other, smaller, CD-ROM images may be created in |
|
the RELEASEDIR/MACHINE/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) util- |
|
ity, which is not part of NetBSD, but which can be |
|
installed from pkgsrc/sysutils/cdrtools. |
|
|
regression-tests |
regression-tests |
Can only be run after building the regression tests in the |
Can only be run after building the regression tests in the |
|
|
|
|
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''. This option |
plies the obj and tools operations. |
implies the obj and tools operations. |
|
|
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 option implies the build operation. |
|
|
|
|
tools Build and install the host tools from src/tools. |
tools Build and install the host tools from src/tools. |
|
|
|
install=idir Install the contents of DESTDIR to idir, using ``make |
|
installworld''. Note that files that are part of the |
|
``etc'' or ``xetc'' sets will not be installed. |
|
|
kernel=kconf Build a new kernel. The kconf argument is the name of a |
kernel=kconf Build a new kernel. The kconf argument is the name of a |
configuration file suitable for use by config(8). If kconf |
configuration file suitable for use by config(1). If kconf |
does not contain any `/' characters, the configuration file |
does not contain any `/' characters, the configuration file |
is expected to be found in the KERNCONFDIR directory, which |
is expected to be found in the KERNCONFDIR directory, which |
is typically sys/arch/MACHINE/conf. The new kernel will be |
is typically sys/arch/MACHINE/conf. The new kernel will be |
|
|
date tools, it is strongly recommended that the tools be |
date tools, it is strongly recommended that the tools be |
rebuilt (using the tools operation). |
rebuilt (using the tools operation). |
|
|
install=idir Install the contents of DESTDIR to idir, using ``make |
releasekernel=kconf |
installworld''. |
Install a gzip(1)ed copy of the kernel built by |
|
kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually |
|
as netbsd-kconf.gz, although the ``netbsd'' prefix is |
|
determined from the ``config'' directives in kconf. |
|
|
The following command line options alter the behaviour of the above oper- |
sets Perform ``make sets''. |
ations: The following command line options alter the behaviour of the |
|
build.sh operations described above: |
sourcesets Perform ``make sourcesets''. |
|
|
|
syspkgs Perform ``make syspkgs''. |
|
|
|
iso-image Perform ``make iso-image''. |
|
|
|
iso-image-source |
|
Perform ``make iso-image-source''. |
|
|
|
The following command line options alter the behaviour of the build.sh |
|
operations described above: |
|
|
-a arch Set the value of MACHINE_ARCH to arch. |
-a arch Set the value of MACHINE_ARCH to arch. |
|
|
-B buildid |
-B buildid |
Set the value of BUILDID to buildid. This will also append the |
Set the value of BUILDID to buildid. This will also append the |
build idenfitier to the name of the ``make'' wrapper script so |
build idenfitier to the name of the ``make'' wrapper script so |
that the resulting name is of the form ``nbmake-MACHINE- |
that the resulting name is of the form |
BUILDID''. |
``nbmake-MACHINE-BUILDID''. |
|
|
-D dest Set the value of DESTDIR to dest. |
-C cddir Set the value of CDEXTRA to cddir. If a relative path is spec- |
|
ified, it will be converted to an absolute path before being |
|
used. When combined with ``iso-image'' or |
|
``iso-image-source'', it will cause the contents of cddir to be |
|
added to the CD-ROM image. |
|
|
|
-D dest Set the value of DESTDIR to dest. If a relative path is speci- |
|
fied, it will be converted to an absolute path before being |
|
used. |
|
|
-E Set `expert' mode. This overrides various sanity checks, and |
-E Set `expert' mode. This overrides various sanity checks, and |
allows: DESTDIR does not have to be set to a non-root path for |
allows: DESTDIR does not have to be set to a non-root path for |
builds, and UNPRIVED does not have to be set when building as a |
builds, and MKUNPRIVED=yes does not have to be set when build- |
non-root user. |
ing 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. |
|
|
|
-h Print a help message. |
|
|
-j njob Passed through to make(1). Makefiles should use .WAIT or have |
-j njob Passed through to make(1). Makefiles should use .WAIT or have |
explicit dependancies as necessary to enforce build ordering. |
explicit dependancies as necessary to enforce build ordering. |
If you see build failures with -j, please save complete build |
If you see build failures with -j, please save complete build |
logs so the failures can be analyzed. |
logs so the failures can be analyzed. |
|
|
-M obj Set MAKEOBJDIRPREFIX to obj. |
-M obj Set MAKEOBJDIRPREFIX to obj. If a relative path is specified, |
|
it will be converted to an absolute path before being used. |
-m mach Set the value of MACHINE to mach. This will also override any |
Unsets MAKEOBJDIR. |
value of MACHINE_ARCH in the process environment with a value |
|
deduced from mach, unless -a is specified. All cross builds |
-m mach Set the value of MACHINE to mach, except in some special cases |
require -m, but if unset on a NetBSD host, the host's value of |
listed below. This will also override any value of |
MACHINE will be detected and used automatically. |
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 |
|
evbarm evbarm (not set) |
|
evbarm-eb evbarm armeb |
|
evbarm-el evbarm arm |
|
evbmips evbmips (not set) |
|
evbmips-eb evbmips mipseb |
|
evbmips-el evbmips mipsel |
|
evbsh3 evbsh3 (not set) |
|
evbsh3-eb evbsh3 sh3eb |
|
evbsh3-el evbsh3 sh3el |
|
sbmips sbmips (not set) |
|
sbmips-eb sbmips mipseb |
|
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. If a relative path is |
ting of /usr/obj will place build-time files under |
specified, it will be converted to an absolute path before |
/usr/obj/bin, /usr/obj/lib, and so forth. |
being used. For instance, a setting of /usr/obj will place |
|
build-time files under /usr/obj/bin, /usr/obj/lib, |
-o Set the value of MKOBJDIRS to ``no''. |
/usr/obj/usr.bin, and so forth. Unsets MAKEOBJDIRPREFIX. |
|
|
-R rel Set the value of RELEASEDIR to rel. |
-o Set the value of MKOBJDIRS to ``no''. Otherwise, it will be |
|
automatically set to ``yes'' (which is opposite to the default |
|
behaviour). |
|
|
|
-R rel Set the value of RELEASEDIR to rel. If a relative path is |
|
specified, it will be converted to an absolute path before |
|
being used. |
|
|
-r Remove the contents of DESTDIR and TOOLDIR before building |
-r Remove the contents of DESTDIR and TOOLDIR before building |
(provides a clean starting point). This will skip deleting |
(provides a clean starting point). This will skip deleting |
DESTDIR if building on a native system to the root directory. |
DESTDIR if building on a native system to the root directory. |
|
|
-T tools Set the value of TOOLDIR to tools. If set, the bootstrap |
-T tools Set the value of TOOLDIR to tools. If a relative path is spec- |
``make'' will only be rebuilt as needed (when the source files |
ified, it will be converted to an absolute path before being |
for make(1) change). |
used. If set, the bootstrap ``make'' will only be rebuilt as |
|
needed (when the source files for make(1) change). |
|
|
-U Set the UNPRIVED variable. |
-U Set MKUNPRIVED=yes. |
|
|
-u Set the UPDATE variable. |
-u Set MKUPDATE=yes. |
|
|
-V var=[value] |
-V var=[value] |
Set the variable var to value (which is optional). |
Set the environment variable var to an optional value. This is |
|
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 loca- |
tion, specified by wrapper. This allows, for instance, to |
tion, specified by wrapper. This allows, for instance, to |
place the wrapper in PATH automatically. Note that wrapper is |
place the wrapper in PATH automatically. Note that wrapper is |
the full name of the file, not just a directory name. |
the full name of the file, not just a directory name. If a |
|
relative path is specified, it will be converted to an absolute |
|
path before being used. |
|
|
|
-X x11src |
|
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 |
|
to the nbmake wrapper. |
|
|
The "nbmake-MACHINE" wrapper script |
The "nbmake-MACHINE" wrapper script |
If using the build.sh script to build NetBSD, a nbmake-MACHINE script |
If using the build.sh script to build NetBSD, a nbmake-MACHINE script |
|
|
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 sev- |
eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR. |
eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR. |
|
build.sh will also set variables specified with -V, and 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 |
./build.sh tools kernel=GENERIC |
1. % ./build.sh tools kernel=GENERIC |
Build a new toolchain, and use the new toolchain to configure |
|
and build a new GENERIC kernel. This is a simpler way to |
Build a new toolchain, and use the new toolchain to configure and |
achieve what the first three examples do. |
build a new GENERIC kernel. |
|
|
./build.sh -U -D /some/DESTDIR distribution |
2. % ./build.sh -U distribution |
Using unprivileged mode, build a complete distribution in |
|
/some/DESTDIR. |
Using unprivileged mode, build a complete distribution to a DESTDIR |
|
directory that build.sh selects (and will display). |
# ./build.sh -U -D /some/DESTDIR installworld=/ |
|
As root, install the distribution that was built with unprivi- |
3. # ./build.sh -U install=/ |
leged mode from /some/DESTDIR to /. (Even though this is run |
|
as root, -U is required so that the permissions stored in |
As root, install to / the distribution that was built by example 2. |
/some/DESTDIR/METALOG are correctly applied to the files as |
Even though this is run as root, -U is required so that the permis- |
they're copied to /). |
sions stored in DESTDIR/METALOG are correctly applied to the files |
|
as they're copied to /. |
./build.sh -U -D /some/dir/DESTDIR -R /some/dir/RELEASE release |
|
Using unprivileged mode, build a complete release in |
4. % ./build.sh -U -u release |
/some/dir/RELEASE. |
|
|
Using unprivileged mode, build a complete release to DESTDIR and |
|
RELEASEDIR directories that build.sh selects (and will display). |
|
MKUPDATE=yes (-u) is set to prevent the ``make cleandir'', so that |
|
if this is run after example 2, it doesn't need to redo that portion |
|
of the release build. |
|
|
OBSOLETE VARIABLES |
OBSOLETE VARIABLES |
NBUILDJOBS Use the make(1) option -j, instead. |
NBUILDJOBS Use the make(1) option -j, instead. |
Line 592 OBSOLETE VARIABLES |
|
Line 798 OBSOLETE VARIABLES |
|
TOOLCHAIN_MISSING=yes. |
TOOLCHAIN_MISSING=yes. |
|
|
SEE ALSO |
SEE ALSO |
make(1), hier(7), release(7) |
make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8), |
|
pkgsrc/sysutils/cdrtools |
|
|
HISTORY |
HISTORY |
The build.sh based build scheme was introduced for NetBSD 1.6 as |
The build.sh based build scheme was introduced for NetBSD 1.6 as |
|
|
BUGS |
BUGS |
A few platforms are not yet using this build system. |
A few platforms are not yet using this build system. |
|
|
NetBSD January 26, 2003 10 |
NetBSD September 1, 2007 NetBSD |