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.14 retrieving revision 1.20 diff -u -p -r1.14 -r1.20 --- src/BUILDING 2002/09/17 16:35:39 1.14 +++ src/BUILDING 2002/12/25 00:58:00 1.20 @@ -13,7 +13,7 @@ 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 default setting of USE_NEW_TOOLCHAIN in . + 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. @@ -38,7 +38,8 @@ REQUIREMENTS 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). @@ -281,49 +282,54 @@ CONFIGURATION 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. - Default: ``yes'' + Default: ``/'' - NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see be- - low) + 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. - Default: Unset. + Default: ``yes'' - 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. + NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see + below) - 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. + 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. - 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. + 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. - RELEASEDIR If set, specifies the directory to which a release(7) lay- - out will be written at the end of a ``make release''. + 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. - Default: Unset. + Default: Unset. - UPDATE If set, then in addition to the effects described for UP- - DATE above, this implies the effects of NOCLEANDIR. + RELEASEDIR If set, specifies the directory to which a release(7) + layout will be written at the end of a ``make release''. + + Default: Unset. + + UPDATE If set, then in addition to the effects described for + UPDATE above, this implies the effects of NOCLEANDIR. BUILDING "make" command line options @@ -399,18 +405,32 @@ 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. + + 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. + + release Do a ``make build'', then package the system into a stan- + dard release layout as described by release(7). This re- + quires 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 @@ -443,16 +463,42 @@ BUILDING -b Bootstrap ``make'' and create a nbmake-MACHINE script (see be- low). + -D dest Set the value of DESTDIR to dest. + -d Build a full distribution. This differs from a default build in that files will also be installed to /dev, /etc, /root and /var. Note this does not build a ``release''; no release sets are placed in ${RELEASEDIR}. -d is implied by -R. + -E Set `expert' mode; DESTDIR does not have to be set to a non- + root path for builds when this is set. + + -i installworlddir + Install the contents of DESTDIR to installworlddir after all + other operations have completed, using the top level + ``installworld'' target. + -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. + -k kernel + Build a new kernel. The kernel argument is the name of a con- + figuration file suitable for use by config(8). If kernel does + not contain any `/' characters, the configuration file is ex- + pected to be found in the KERNCONFDIR directory, which is typi- + cally 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 -t option) in a separate invocation of build.sh pri- + or to using the -k option, or that the -t and -k options be + used together in a single invocation of build.sh. + + -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 deduced from mach, unless -a is specified. All cross builds @@ -463,15 +509,30 @@ 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. Setting this option will + cause build.sh to run ``make release'' instead of ``make + build''. + -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 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). + -t Build and install the host tools from src/tools only. This op- tion implies -b. + -U Set the UNPRIVED variable. + -u Set the UPDATE variable. -w wrapper @@ -480,25 +541,6 @@ BUILDING 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. - - -M obj Set MAKEOBJDIRPREFIX to obj. - - -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. - - -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. - 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 @@ -510,17 +552,44 @@ BUILDING This script can be symlinked into a directory listed in PATH, or called with an absolute path. +EXAMPLES + ./build.sh -t + Build a new toolchain. + + cd ${KERNCONFDIR} ; ${TOOLDIR}/bin/nbconfig GENERIC + Use the new version of config(8) to prepare to build a new + GENERIC kernel. + + cd ${KERNOBJDIR}/GENERIC ; ${TOOLDIR}/bin/nbmake-${MACHINE} dependall + Use the new toolchain to build a new GENERIC kernel. + + ./build.sh -t -k GENERIC + Build a new toolchain, and use the new toolchain to configure + and build a new GENERIC kernel. + + ./build.sh -U -d + Using unprivileged mode, build a complete distribution in + DESTDIR. + + ./build.sh -U -R /some/dir/RELEASE + Using unprivileged mode, build a complete release in the speci- + fied release directory. + OBSOLETE VARIABLES - NBUILDJOBS Now obsolete. Use the make(1) option -j, instead. + 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 - A few platforms are not yet using the USE_NEW_TOOLCHAIN system. + A few platforms are not yet using this build system. -NetBSD May 3, 2002 8 +NetBSD December 25, 2002 9