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.4 retrieving revision 1.30 diff -u -p -r1.4 -r1.30 --- src/BUILDING 2001/11/14 22:29:23 1.4 +++ src/BUILDING 2003/05/08 14:42:05 1.30 @@ -13,10 +13,10 @@ STATUS 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 setting of USE_NEW_TOOLCHAIN in /etc/mk.conf or - . Platforms which have not yet been switched to the new - toolchain should continue building traditionally, using the notes speci- - fied in the file UPDATING. + as indicated by the default setting of TOOLCHAIN_MISSING in . + Platforms which have not yet been switched to the new toolchain should + continue building traditionally, using the notes specified in the file + UPDATING. REQUIREMENTS NetBSD is designed to be buildable on most POSIX-compliant host systems. @@ -30,15 +30,16 @@ REQUIREMENTS 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 + 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 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). @@ -66,8 +67,8 @@ FILES 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. @@ -88,21 +89,52 @@ FILES described in release(7). CONFIGURATION + Environment variables + Several environment variables control the behaviour of NetBSD builds. + + MACHINE Machine type. + + MACHINE_ARCH Machine architecture. + + 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. Used only if MAKEOBJDIRPREFIX is not defined. + MAKEOBJDIR can only be provided in the environment. + + MAKEOBJDIRPREFIX Top level directory of the object directory tree. If + this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used + as the .OBJDIR for the current directory. The current + directory may be read only. MAKEOBJDIRPREFIX can only + be provided in the environment. + "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. + 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). + directory, set DESTDIR to an empty string). 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. @@ -122,8 +154,8 @@ CONFIGURATION 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 in- + stalled during a build. Default: ``yes'' @@ -147,7 +179,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'' @@ -193,10 +225,10 @@ 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 in- + stalled during a build. If set to ``no'', then all of + MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to + ``no'' unconditionally. Default: ``yes'' @@ -209,6 +241,15 @@ CONFIGURATION Default: Unset. + 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 DESTDIR. The contents of METALOG is + used during the generation of the distribution tar files to + ensure that the appropriate file ownership is stored. + + Default: Unset. + 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- @@ -241,62 +282,73 @@ CONFIGURATION clude files). "make" variables for full builds - These variables only affect the top level ``Makefile'' and do not manual- - ly building subtrees of the NetBSD source code. + These variables only affect the top level ``Makefile'' and do not affect + manually building subtrees of the NetBSD source code. + + INSTALLWORLDDIR Location for the ``make installworld'' target to install + to. + + Default: ``/'' + + MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether ob- + ject directories will be created automatically (via a + ``make obj'' pass) at the start of a build. - 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: ``yes'' - Default: ``yes'' + NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see + below) - 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. + 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. - 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. + 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 be- + cause 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 + UPDATE in that case. - 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. + RELEASEDIR If set, specifies the directory to which a release(7) + layout will be written at the end of a ``make release''. - 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. + Note: build.sh will provide a default of releasedir (in + the top-level .OBJDIR) unless run in `expert' mode - UPDATE If set, then in addition to the effects described for UP- - DATE above, this implies the effects of NOCLEANDIR. + UPDATE If set, then in addition to the effects described for + UPDATE above, this implies the effects of NOCLEANDIR + (i.e., ``make cleandir'' is avoided). 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. + -j njob Run up to njob make(1) subjobs in parallel. Makefiles should + use .WAIT or have explicit dependancies as necessary to en- + force build ordering. If you see build failures with -j, + please save complete build logs so the failures can be ana- + lyzed. + -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 @@ -336,13 +388,16 @@ BUILDING 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. includes Build and install system header files. Typically needed be- fore 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. @@ -357,18 +412,40 @@ 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. 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 + 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 the not root directory if cross compil- + ing. + + Note: It is highly recommended that you upgrade your kernel + and reboot before performing this operation. + + 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). + + release Do a ``make distribution'', build kernels, distribution me- + dia, and install sets (this as per ``make sets''), and then + package the system into a standard release layout as de- + scribed by release(7). This requires that RELEASEDIR be + set (see above). 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 the compiled regression tests + on the local host. The "build.sh" script This script file is a Bourne shell script designed to build the entire @@ -387,17 +464,68 @@ 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: + + build Build the system as per ``make build''. This option im- + plies the obj and tools operations. + + distribution Build a full distribution as per ``make distribution''. + This option implies the build operation. + + release Build a full release as per ``make release''. This option + implies the distribution operation. + + makewrapper Create the nbmake-MACHINE wrapper. This operation is auto- + matically performed for any of the other operations. + + obj Perform ``make obj''. + + tools Build and install the host tools from src/tools. + + kernel=kconf Build a new kernel. The kconf argument is the name of a + configuration file suitable for use by config(8). 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. + In order to ensure that the kernel is built using up-to- + date tools, it is strongly recommended that the tools be + rebuilt (using the tools operation). + + install=idir Install the contents of DESTDIR to idir, using ``make + installworld''. + + sets Perform ``make sets''. + + The following command line options alter the behaviour of the above oper- + ations: 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. - -b Bootstrap ``make'' and create a nbmake-MACHINE script (see be- - low). + -B buildid + Set the value of BUILDID to buildid. This will also append the + build idenfitier to the name of the ``make'' wrapper script so + that the resulting name is of the form ``nbmake-MACHINE- + BUILDID''. - -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''. + -D dest Set the value of DESTDIR to dest. + + -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 UNPRIVED does not have to be set when building as a + non-root user. + + Note: It is highly recommended that you know what you are doing + when you use this option. + + -j njob Passed through to make(1). Makefiles should use .WAIT or have + explicit dependancies as necessary to enforce build ordering. + If you see build failures with -j, please save complete build + logs so the failures can be analyzed. + + -M obj Set MAKEOBJDIRPREFIX to obj. -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 @@ -409,38 +537,36 @@ BUILDING not make any changes. This is similar in concept to ``make -n''. + -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 under + /usr/obj/bin, /usr/obj/lib, and so forth. + -o Set the value of MKOBJDIRS to ``no''. + -R rel Set the value of RELEASEDIR to rel. + -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. + -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. -u Set the UPDATE variable. + -V var=[value] + Set the variable var to value (which is optional). + -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. - -D dest Set the value of DESTDIR to dest. - - -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). - The "nbmake-MACHINE" wrapper script If using the build.sh script to build NetBSD, a nbmake-MACHINE script will be created in TOOLDIR/bin upon the first build to assist in building @@ -452,14 +578,47 @@ BUILDING This script can be symlinked into a directory listed in PATH, or called with an absolute path. +EXAMPLES + 1. ./build.sh tools kernel=GENERIC + + Build a new toolchain, and use the new toolchain to configure and + build a new GENERIC kernel. + + 2. ./build.sh -U distribution + + Using unprivileged mode, build a complete distribution to a DESTDIR + directory that build.sh selects (and will display). + + 3. # ./build.sh -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 -U -u release + + Using unprivileged mode, build a complete release to DESTDIR and + RELEASEDIR directories that build.sh selects (and will display). + UPDATE (-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) HISTORY - The USE_NEW_TOOLCHAIN based build scheme was introduced in the ``NetBSD- - current'' development sources between NetBSD 1.5 and NetBSD 1.6. + The build.sh based build scheme was introduced for NetBSD 1.6 as + USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. BUGS - Many platforms are not yet using the USE_NEW_TOOLCHAIN system. + A few platforms are not yet using this build system. -NetBSD November 12, 2001 8 +NetBSD May 8, 2003 10