Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files. =================================================================== RCS file: /ftp/cvs/cvsroot/src/BUILDING,v rcsdiff: /ftp/cvs/cvsroot/src/BUILDING,v: warning: Unknown phrases like `commitid ...;' are present. retrieving revision 1.7 retrieving revision 1.80 diff -u -p -r1.7 -r1.80 --- src/BUILDING 2002/03/04 02:10:02 1.7 +++ src/BUILDING 2008/11/13 20:40:11 1.80 @@ -1,22 +1,7 @@ BUILDING(8) NetBSD System Manager's Manual BUILDING(8) NAME - 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 USE_NEW_TOOLCHAIN in . - Platforms which have not yet been switched to the new toolchain should - continue building traditionally, using the notes specified in the file - UPDATING. + BUILDING -- Procedure for building NetBSD from source code. REQUIREMENTS NetBSD is designed to be buildable on most POSIX-compliant host systems. @@ -28,22 +13,22 @@ REQUIREMENTS 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 toolchain (make is not required); all other tools are created as part of - the NetBSD build process. - - Note: A couple 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. + the NetBSD build process. (See the environment variables section below + if you need to override or manually select your compilers.) FILES Source tree layout - - BUILDING.mdoc This document (in -mdoc troff format; the original copy). + doc/BUILDING.mdoc + This document (in -mdoc troff format; the original copy). BUILDING This document (in plaintext). - Makefile The main Makefile for NetBSD; should only be run for na- - tive builds with an appropriately up-to-date version of + tools/compat/README + 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 on a non-native host, see the build.sh shell script.) @@ -61,16 +46,19 @@ FILES Sources imported verbatim from third parties, without man- gling the existing build structure. Other source trees in bin through usr.sbin use the NetBSD make(1) ``reachover'' - Makefile semantics when building these programs for a na- - tive host. + Makefile semantics when building these programs for a + native host. distrib/, etc/ Sources for items used when making a full release snap- - shot, such as files installed in /etc on the destination - system, boot media, and release notes. + shot, such as files installed in DESTDIR/etc on the desti- + nation system, boot media, and release notes. - regress/ Regression test harness. Can be cross-compiled, but only - run natively. + tests/, regress/ + Regression test harness. Can be cross-compiled, but only + run natively. tests/ uses the atf(7) test framework; + regress/ contains older tests that have not yet been + migrated to atf(7). sys/ NetBSD kernel sources. @@ -83,33 +71,121 @@ FILES any of these directories are missing, they will be skipped during the build. + x11/ ``Reachover'' build structure for X11R6; the source is in + X11SRCDIR. + Build tree layout The NetBSD build tree is described in hier(7), and the release layout is described in release(7). CONFIGURATION + Environment variables + 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, e.g., ``macppc''. + + MACHINE_ARCH Machine architecture, e.g., ``powerpc''. + + MAKE Path name to invoke make(1) as. + + MAKEFLAGS Flags to invoke make(1) with. + + MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- + tory. The value is subjected to variable expansion by + make(1). Typical usage is to set this variable to a + value involving the use of `${.CURDIR:S...}' or + `${.CURDIR:C...}', to derive the value of .OBJDIR from + the value of .CURDIR. Used only if MAKEOBJDIRPREFIX is + not defined. MAKEOBJDIR can be provided only in the + environment or via the -O flag of build.sh; it cannot + usefully be set inside a Makefile. + + MAKEOBJDIRPREFIX Top level directory of the object directory tree. If + specified, must be an absolute path. If this is + defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the + .OBJDIR for the current directory. The current direc- + tory may be read only. MAKEOBJDIRPREFIX can be pro- + vided only in the environment or via the -M flag of + build.sh; it cannot usefully be set inside a Makefile. + "make" variables Several variables control the behavior of NetBSD builds. Unless other- wise specified, these variables may be set in either the process environ- ment or the make(1) configuration file specified by MAKECONF. + BUILDID Identifier for the build. 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 parame- + ters, such as compiler flags. + + BUILDSEED GCC uses random numbers when compiling C++ code. This vari- + able seeds the gcc random number generator using the -fran- + dom-seed flag with this value. By default, it is set to + NetBSD-(majorversion). Using a fixed value causes C++ bina- + ries to be the same when built from the same sources. Addi- + tional information is available in the GCC documentation of + -frandom-seed. + DESTDIR Directory to contain the built NetBSD system. If set, spe- cial options are passed to the compilation tools to prevent their default use of the host system's /usr/include, - /usr/lib, and so forth. This pathname should not end with a - slash (/) character (for installation into the system's root - directory, set DESTDIR to an empty string). The directory - must reside on a file system which supports long file names - and hard links. + /usr/lib, and so forth. This pathname must be an absolute + path, and should not end with a slash (/) character. (For + installation into the system's root directory, set DESTDIR to + an empty string, not to ``/''). The directory must reside on + a file system which supports long file names and hard links. Default: Empty string if USETOOLS is ``yes''; unset other- 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 the process environment. Default: ``/etc/mk.conf'' + MAKEVERBOSE + Level of verbosity of status messages. Supported values: + + 0 No descriptive messages or commands executed by make(1) + are shown. + + 1 Brief messages are shown describing what is being done, + but the actual commands executed by make(1) are not dis- + played. + + 2 Descriptive messages are shown as above (prefixed with a + `#'), and ordinary commands performed by make(1) are + displayed. + + 3 In addition to the above, all commands performed by + make(1) are displayed, even if they would ordinarily + have been hidden through use of the ``@'' prefix in the + relevant makefile. + + 4 In addition to the above, commands executed by make(1) + are traced through use of the sh(1) ``-x'' flag. + + Default: 2 + MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor- matted plaintext manual pages will be created during a build. @@ -118,14 +194,19 @@ CONFIGURATION MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto- graphic 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 en- - cryption system, crypt(3). + Will not affect use of the standard low-security password + encryption system, crypt(3). Default: ``yes'' MKDOC Can be set to ``yes'' or ``no''. Indicates whether system - documentation destined for /usr/share/doc will be installed - during a build. + documentation destined for DESTDIR/usr/share/doc will be + installed during a build. + + Default: ``yes'' + + MKHTML Can be set to ``yes'' or ``no''. Indicates whether prefor- + matted HTML manual pages will be built and installed Default: ``yes'' @@ -149,7 +230,7 @@ CONFIGURATION MKLINT Can be set to ``yes'' or ``no''. Indicates whether lint(1) will be run against portions of the NetBSD source code during the build, and whether lint libraries will be installed into - /usr/libdata/lint. + DESTDIR/usr/libdata/lint. Default: ``yes'' @@ -159,8 +240,8 @@ CONFIGURATION Default: ``yes'' MKNLS Can be set to ``yes'' or ``no''. Indicates whether Native - Language System locale zone files will be compiled and in- - stalled during a build. + Language System locale zone files will be compiled and + installed during a build. Default: ``yes'' @@ -171,6 +252,9 @@ CONFIGURATION Default: ``yes'' + Note that setting MKOBJ to ``no'' is not recommended and may + cause problems when updating the tree with cvs(1). + MKPIC Can be set to ``yes'' or ``no''. Indicates whether shared objects and libraries will be created and installed during a build. If set to ``no'', the entire built system will be @@ -181,8 +265,8 @@ CONFIGURATION MKPICINSTALL Can be set to ``yes'' or ``no''. Indicates whether the ar(1) - format libraries (lib*_pic.a), used to generate shared li- - braries, are installed during a build. + format libraries (lib*_pic.a), used to generate shared + libraries, are installed during a build. Default: ``yes'' @@ -195,37 +279,56 @@ CONFIGURATION code. MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files - destined to reside in /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'' uncon- - ditionally. + 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'' - TOOLDIR Directory to hold the host tools, once built. This directory - should be unique to a given host system and NetBSD source - tree. (However, multiple targets may share the same TOOLDIR; - the target-dependent files have unique names.) If unset, a - default based on the uname(1) information of the host plat- - form will be created in the .OBJDIR of src/tools. + MKSTRIPIDENT + Can be set to ``yes'' or ``no''. Indicates whether program + binaries and shared libraries should be built to include RCS + IDs for use with ident(1). - Default: Unset. + Default: ``no'' - UNPRIVED If set, then an unprivileged install will occur. The user, - group, permissions, and file flags, will not be set on the - installed item; instead the information will be appended to a - file called METALOG in the .OBJDIR of src. The contents of - METALOG is used during the generation of the distribution tar - files to ensure that the appropriate file ownership is - stored. + MKTTINTERP Can be set to ``yes'' or ``no''. For X builds, decides if + the TrueType bytecode interpreter is turned on. See + http://www.freetype.org/patents.html for details. - Default: Unset. + Default: ``no'' + + MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an + unprivileged install will occur. The user, group, permis- + sions, and file flags, will not be set on the installed + items; instead the information will be appended to a file + called METALOG in DESTDIR. The contents of METALOG are used + during the generation of the distribution tar files to ensure + that the appropriate file ownership is stored. + + Default: ``no'' + + MKUPDATE Can be set to ``yes'' or ``no''. Indicates whether all + install operations intended to write to DESTDIR will compare + file timestamps before installing, and skip the install phase + if the destination files are up-to-date. This also has + implications on full builds (see next subsection). + + Default: ``no'' + + MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11 is + built from X11SRCDIR. + + Default: ``no'' - UPDATE If set, then 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). + 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. @@ -247,79 +350,113 @@ CONFIGURATION build or runtime problems when building the whole NetBSD source tree. - Default: ``yes'' if building all or part of a whole NetBSD - source tree (detected automatically); ``no'' otherwise (to - preserve traditional semantics of the make(1) in- - clude files). + Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''. + + USETOOLS is also set to ``no'' when using outside + the NetBSD source tree. + + X11SRCDIR Directory containing the X11R6 source. If specified, must be + an absolute path. The main X11R6 source is found in + X11SRCDIR/xfree/xc. + + Default: ``/usr/xsrc'' + + X11FLAVOUR The style of X11 cross-built, set to either ``Xorg'' or + ``XFree86''. + + Default: ``Xorg'' on amd64, i386, macppc, shark, sparc and + sparc64 platforms, ``XFree86'' on everything else. "make" variables for full builds These variables only affect the top level ``Makefile'' and do not affect manually building subtrees of the NetBSD source code. - MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether object - directories will be created automatically (via a ``make - obj'' pass) at the start of a build. + INSTALLWORLDDIR Location for the ``make installworld'' target to install + to. If specified, must be an absolute path. + + Default: ``/'' + + MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether + object directories will be created automatically (via a + ``make obj'' pass) at the start of a build. + + Default: ``no'' + + If using build.sh, the default is ``yes''. This may be + set back to ``no'' by giving build.sh the -o option. + + 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'' - Default: ``yes'' + If using build.sh, this may be set by giving the -u + option. - NBUILDJOBS If set, specifies the number of parallel make(1) processes - that should be run simultaneously. This can speed up - builds on SMP machines, or machines with much more CPU - power than I/O availability. This should be used instead - of the make(1) option -j, in order to ensure proper order- - ing of build components. + NBUILDJOBS Now obsolete. Use the make(1) option -j, instead. See + below. - Default: Unset. + Default: Unset. - NOCLEANDIR If set, avoids the ``make cleandir'' phase of a full - build. This has the effect of allowing only changed files - in a source tree to be recompiled. This can speed up - builds when updating only a few files in the tree. + NOCLEANDIR If set, avoids the ``make cleandir'' phase of a full + build. This has the effect of allowing only changed + files in a source tree to be recompiled. This can speed + up builds when updating only a few files in the tree. - Default: Unset. + Default: Unset. - NODISTRIBDIRS If set, avoids the ``make distrib-dirs'' phase of a full - build. This skips running mtree(8) on DESTDIR, useful on - systems where building as an unprivileged user, or where - it is known that the system-wide mtree files have not - changed. + See also MKUPDATE. - Default: Unset. + NODISTRIBDIRS If set, avoids the ``make distrib-dirs'' phase of a full + build. This skips running mtree(8) on DESTDIR, useful + on systems where building as an unprivileged user, or + where it is known that the system-wide mtree files have + not changed. - NOINCLUDES If set, avoids the ``make includes'' phase of a full - build. This has the effect of preventing make(1) from - thinking that some programs are out-of-date simply because - the system include files have changed. However, this op- - tion should not be used when updating the entire NetBSD - source tree arbitrarily; it is suggested to use UPDATE in - that case. + Default: Unset. - Default: Unset. + NOINCLUDES If set, avoids the ``make includes'' phase of a full + build. This has the effect of preventing make(1) from + thinking that some programs are out-of-date simply + because the system include files have changed. However, + this option should not be used when updating the entire + NetBSD source tree arbitrarily; it is suggested to use + MKUPDATE=yes instead in that case. - RELEASEDIR If set, specifies the directory to which a release(7) lay- - out will be written at the end of a ``make release''. + Default: Unset. - Default: Unset. + RELEASEDIR If set, specifies the directory to which a release(7) + layout will be written at the end of a ``make release''. + If specified, must be an absolute path. - UPDATE If set, then in addition to the effects described for UP- - DATE above, this implies the effects of NOCLEANDIR. + Default: Unset. + + Note: build.sh will provide a default of releasedir (in + the top-level .OBJDIR) unless run in `expert' mode. BUILDING "make" command line options - This is only a summary of options available to make(1); only the options - used most frequently with NetBSD builds are listed here. + 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. + + -j njob Run up to njob make(1) subjobs in parallel. Makefiles should + use .WAIT or have explicit dependencies as necessary to + enforce build ordering. -m dir Specify the default directory for searching for system Make- file segments, mainly the files. When building any full NetBSD source tree, this should be set to the - ``share/mk'' directory in the source tree. (This is set auto- - matically when building from the top level.) + ``share/mk'' directory in the source tree. This is set auto- + matically when building from the top level, or when using + build.sh. -n Display the commands that would have been executed, but do not actually execute them. This will still cause recursion to 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. var=value Set the variable var to value, overriding any setting speci- @@ -336,25 +473,28 @@ BUILDING clean Remove program and library object code files. - cleandir Same as clean, but also remove preformatted documentation, de- - pendency files generated by ``make depend'', and any other - files known to be created at build time. ``make distclean'' - may be used as a synonym, for familiarity with a similar well- - known convention. + cleandir Same as clean, but also remove preformatted documentation, + dependency files generated by ``make depend'', and any other + files known to be created at build time. - depend Create dependency files (.depend) containing more detailed in- - formation about the dependencies of source code on header + depend Create dependency files (.depend) containing more detailed + information about the dependencies of source code on header files. Allows programs to be recompiled automatically when a dependency changes. dependall Does a ``make depend'' immediately followed by a ``make all''. - This combined target recurses as an atomic unit, so that the - ``make depend'' phase can participate in make -j parallelism. + This improves cache locality of the build since both passes + read the source files in their entirety. + + distclean Synonym for cleandir. - includes Build and install system header files. Typically needed be- - 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. + Few files will be installed to DESTDIR/dev, DESTDIR/etc, + DESTDIR/root or DESTDIR/var in order to prevent user supplied + configuration data from being overwritten. lint Run lint(1) against the C source code, where appropriate, and generate system-installed lint libraries. @@ -369,18 +509,114 @@ BUILDING Additional make(1) targets are usable specifically from the top source level to facilitate building the entire NetBSD source tree. - build Build the entire NetBSD system. This orders portions of the - source tree such that prerequisites will be built in the prop- - er order. - - release Do a ``make build'', then package the system into a standard - release layout as described by release(7). This requires that - RELEASEDIR be set (see above). + build Build the entire NetBSD system (except the kernel). This + orders portions of the source tree such that prerequisites + will be built in the proper order. + + distribution Do a ``make build'', and then install a full distribution + (which does not include a kernel) into DESTDIR, including + files in DESTDIR/dev, DESTDIR/etc, DESTDIR/root and + DESTDIR/var. + + buildworld As per ``make distribution'', except that it ensures that + DESTDIR is not the root directory. + + installworld Install the distribution from DESTDIR to INSTALLWORLDDIR, + which defaults to the root directory. Ensures that + INSTALLWORLDDIR is not the root directory if cross compil- + ing. + + The INSTALLSETS environment variable may be set to a list + of distribution sets to be installed. By default, all sets + except ``etc'' and ``xetc'' are installed, so most files in + INSTALLWORLDDIR/etc will not be installed or modified. + + Note: Before performing this operation with + INSTALLWORLDDIR=/, it is highly recommended that you + upgrade your kernel and reboot. After performing this + operation, it is recommended that you use etcupdate(8) to + update files in INSTALLWORLDDIR/etc and that you use + postinstall(8) to check for inconsistencies (and possibly + to fix them). + + sets Create distribution sets from DESTDIR into + RELEASEDIR/RELEASEMACHINEDIR/binary/sets. Should be run + after ``make distribution'', as ``make build'' alone 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/RELEASEMACHINEDIR/binary/syspkgs. Should be run + after ``make distribution'', as ``make build'' alone 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/RELEASEMACHINEDIR/installation/cdrom direc- + tory by ``make release''. These smaller images usually + contain the same tools as the larger images in + RELEASEDIR/iso, but do not contain additional content such + as the distribution sets. + + Note that the mac68k port still uses an older method of + creating CD-ROM images. This requires the mkisofs(1) util- + ity, which is not part of NetBSD, but which can be + installed from pkgsrc/sysutils/cdrtools. + + iso-image-source + Create a NetBSD installation CD-ROM image in the + RELEASEDIR/iso directory. The CD-ROM file system will have + a layout as described in release(7). It will have top + level directories for the machine type and source. + + For most machine types, the CD-ROM will be bootable, and + will automatically run the sysinst(8) menu-based installa- + tion program, which can be used to install or upgrade a + NetBSD system. Bootable CD-ROMs also contain tools that + may be useful in repairing a damaged NetBSD installation. + + Before ``make iso-image-source'' is attempted, RELEASEDIR + must be populated by ``make sourcesets release'' or equiva- + lent. + + Note that other, smaller, CD-ROM images may be created in + the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc- + tory by ``make release''. These smaller images usually + contain the same tools as the larger images in + RELEASEDIR/iso, but do not contain additional content such + as the distribution sets. + + Note that the mac68k port still uses an older method of + creating CD-ROM images. This requires the mkisofs(1) util- + ity, which is not part of NetBSD, but which can be + installed from pkgsrc/sysutils/cdrtools. regression-tests - Can only be run after building the regression tests in the di- - rectory ``regress''. Runs the compiled regression tests on - the local host. + Can only be run after building the regression tests in the + directory ``regress''. Runs those compiled regression + tests on the local host. Note that most tests are now man- + aged instead using atf(7); this target should probably run + those as well but currently does not. The "build.sh" script This script file is a Bourne shell script designed to build the entire @@ -399,66 +635,213 @@ BUILDING of options below, variables that are automatically set by build.sh are noted where applicable. - The following are available command line options that may be supplied to - build.sh: + The following operations are supported by build.sh: - -a arch Set the value of MACHINE_ARCH to arch. + build Build the system as per ``make build''. Before the main + part of the build commences, this command runs the obj + operation (unless the -o option is given), ``make + cleandir'' (unless the -u option is given), and the tools + operation. + + distribution Build a full distribution as per ``make distribution''. + This command first runs the build operation. + + release Build a full release as per ``make release''. This command + first runs the distribution operation. + + makewrapper Create the nbmake-MACHINE wrapper. This operation is auto- + matically performed for any of the other operations. + + cleandir Perform ``make cleandir''. + + obj Perform ``make obj''. + + tools Build and install the host tools from src/tools. This com- + mand will first run ``make obj'' and ``make cleandir'' in + the tools subdirectory unless the -o or -u options (respec- + tively) are given. + + 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. - -b Bootstrap ``make'' and create a nbmake-MACHINE script (see be- - low). + kernel=kconf Build a new kernel. The kconf argument is the name of a + configuration file suitable for use by config(1). If kconf + does not contain any `/' characters, the configuration file + is expected to be found in the KERNCONFDIR directory, which + is typically sys/arch/MACHINE/conf. The new kernel will be + built in a subdirectory of KERNOBJDIR, which is typically + sys/arch/MACHINE/compile or an associated object directory. + + This command does not imply the tools command; run the + tools command first unless it is certain that the tools + already exist and are up to date. + + This command will run ``make cleandir'' on the kernel in + question first unless the -u option is given. + + releasekernel=kconf + Install a gzip(1)ed copy of the kernel previously built by + kernel=kconf into + RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as + netbsd-kconf.gz, although the ``netbsd'' prefix is deter- + mined from the ``config'' directives in kconf. + + sets Perform ``make sets''. + + 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. - -d Build a full distribution. This differs from a normal build in - that etc files will also be installed. Note this does not - build a ``release''; no release sets are placed in ${RE- - LEASEDIR}. - - -j njob Set the value of NBUILDJOBS to njob. This provides similar - functionality to the familiar ``make -j'', but preserves the - ordering of the top level ``make build''. - - -m mach Set the value of MACHINE to mach. This will also override any - value of MACHINE_ARCH in the process environment with a value - deduced from mach, unless -a is specified. All cross builds - require -m, but if unset on a NetBSD host, the host's value of - MACHINE will be detected and used automatically. + -B buildid + Set the value of BUILDID to buildid. This will also append the + build identifier to the name of the ``make'' wrapper script so + that the resulting name is of the form + ``nbmake-MACHINE-BUILDID''. + + -C cdextras + Set the value of CDEXTRA to cdextras which is a space-separated + list of files or directories which will be added in order to + the CD-ROM image when used in conjunction with ``iso-image'' or + ``iso-image-source''. Files will be added to the root of the + CD-ROM image, whereas directories will be copied recursively. + If relative paths are specified, they will be converted to + absolute paths before being used. + + -D dest Set the value of DESTDIR to dest. If a relative path is speci- + fied, it will be converted to an absolute path before being + used. + + -E Set `expert' mode. This overrides various sanity checks, and + allows: DESTDIR does not have to be set to a non-root path for + builds, and MKUNPRIVED=yes does not have to be set when build- + ing as a non-root user. + + Note: It is highly recommended that you know what you are doing + when you use this option. + + -h Print a help message. + + -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 + out of memory while using build.sh with -j, please save com- + plete build logs so the failures can be analyzed. + + To achieve the fastest builds, -j values between (1 + the num- + ber of CPUs) and (2 * the number of CPUs) are recommended. Use + lower values on machines with limited memory or I/O bandwidth. + + -M obj Set MAKEOBJDIRPREFIX to obj. For instance, if the source + directory is /usr/src, a setting of ``-M /usr/obj'' will place + build-time files under /usr/obj/usr/src/bin, + /usr/obj/usr/src/lib, /usr/obj/usr/src/usr.bin, and so forth. + If a relative path is specified, it will be converted to an + absolute path before being used. Unsets MAKEOBJDIR. See ``-O + -obj'' for more information. + + -m mach Set the value of MACHINE to mach, except in some special cases + listed below. This will also override any value of + MACHINE_ARCH in the process environment with a value deduced + from mach, unless -a is specified. All cross builds require + -m, but if unset on a NetBSD host, the host's value of MACHINE + will be detected and used automatically. + + Some machines support multiple values for MACHINE_ARCH. The + following special cases for the mach argument are defined to + set the listed values of MACHINE and MACHINE_ARCH: + + mach MACHINE MACHINE_ARCH + 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 not make any changes. This is similar in concept to ``make -n''. - -o Set the value of MKOBJDIRS to ``no''. + -O obj Create an appropriate transform macro for MAKEOBJDIR that will + place the built object files under obj. For instance, a set- + ting of ``-O /usr/obj'' will place build-time files under + /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth. If + a relative path is specified, it will be converted to an abso- + lute path before being used. Unsets MAKEOBJDIRPREFIX. + + In normal use, exactly one of the -M or -O options should be + specified. If neither -M nor -O is specified, then a default + object directory will be chosen according to rules in + . Relying on this default is not recommended + because it is determined by complex rules that are influenced + by the values of several variables and by the location of the + source directory. + + -o Set the value of MKOBJDIRS to ``no''. Otherwise, it will be + automatically set to ``yes''. This default is opposite to the + behaviour when not using build.sh. + + -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 (provides a clean starting point). This will skip deleting DESTDIR if building on a native system to the root directory. - -t Build and install the host tools from src/tools only. This op- - tion implies -b. + -S seed Change the value of BUILDSEED to seed. This should rarely be + necessary. + + -T tools Set the value of TOOLDIR to tools. If a relative path is spec- + ified, it will be converted to an absolute path before being + used. If set, the bootstrap ``make'' will only be rebuilt if + the source files for make(1) have changed. - -u Set the UPDATE variable. + -U Set MKUNPRIVED=yes. + + -u Set MKUPDATE=yes. + + -V var=[value] + Set the environment variable var to an optional value. This is + propagated to the nbmake wrapper. -w wrapper Create the nbmake wrapper script (see below) in a custom loca- tion, specified by wrapper. This allows, for instance, to 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. - -D dest Set the value of DESTDIR to dest. + -x Set MKX11=yes. - -O obj Create an appropriate transform macro for MAKEOBJDIR that will - place the built object files under obj. For instance, a set- - ting of /usr/obj will place build-time files files under - /usr/obj/bin, /usr/obj/lib, and so forth. - - -R rel Set the value of RELEASEDIR to rel. Setting this option will - cause build.sh to run ``make release'' instead of ``make - build''. - - -T tools Set the value of TOOLDIR to tools. If set, the bootstrap - ``make'' will only be rebuilt as needed (when the source files - for make(1) change). - - -U Set the UNPRIVED variable. + -Z var Unset ("zap") the environment variable var. This is propagated + to the nbmake wrapper. The "nbmake-MACHINE" wrapper script If using the build.sh script to build NetBSD, a nbmake-MACHINE script @@ -468,17 +851,51 @@ BUILDING 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- eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR. + nbmake-MACHINE will also set variables specified with -V, and unset vari- + ables specified with -Z. + This script can be symlinked into a directory listed in PATH, or called with an absolute path. +EXAMPLES + 1. % ./build.sh [options] tools kernel=GENERIC + + Build a new toolchain, and use the new toolchain to configure and + build a new GENERIC kernel. + + 2. % ./build.sh [options] -U distribution + + Using unprivileged mode, build a complete distribution to a DESTDIR + directory that build.sh selects (and will display). + + 3. # ./build.sh [options] -U install=/ + + As root, install to / the distribution that was built by example 2. + Even though this is run as root, -U is required so that the permis- + sions stored in DESTDIR/METALOG are correctly applied to the files + as they're copied to /. + + 4. % ./build.sh [options] -U -u 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 + NBUILDJOBS Use the make(1) option -j instead. + + USE_NEW_TOOLCHAIN + The new toolchain is now the default. To disable, use + TOOLCHAIN_MISSING=yes. + SEE ALSO - make(1), hier(7), release(7) + make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8), + pkgsrc/sysutils/cdrtools HISTORY - The USE_NEW_TOOLCHAIN based build scheme was introduced in the ``NetBSD- - current'' development sources between NetBSD 1.5 and NetBSD 1.6. - -BUGS - Many platforms are not yet using the USE_NEW_TOOLCHAIN system. + The build.sh based build scheme was introduced for NetBSD 1.6 as + USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. -NetBSD March 4, 2002 8 +NetBSD September 10, 2008 NetBSD