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.19 retrieving revision 1.23 diff -u -p -r1.19 -r1.23 --- src/BUILDING 2002/12/08 22:14:01 1.19 +++ src/BUILDING 2003/01/26 05:34:32 1.23 @@ -30,8 +30,8 @@ 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. @@ -282,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 @@ -400,18 +405,34 @@ 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 /dev, /etc, /root and + /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. + + release Do a ``make distribution'', build kernels, distribution me- + dia, and install sets, and then package the system into a + standard release layout as described 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 @@ -430,8 +451,41 @@ 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''. + + 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. @@ -441,38 +495,21 @@ BUILDING that the resulting name is of the form ``nbmake-MACHINE- BUILDID''. - -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. 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. - -E Set `expert' mode; DESTDIR does not have to be set to a non- - root path for builds when this is set. + 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. - -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 @@ -492,9 +529,7 @@ BUILDING -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 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 @@ -504,13 +539,13 @@ BUILDING ``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. + -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 @@ -529,27 +564,25 @@ BUILDING 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.sh tools kernel=GENERIC Build a new toolchain, and use the new toolchain to configure - and build a new GENERIC kernel. + and build a new GENERIC kernel. This is a simpler way to + achieve what the first three examples do. - ./build.sh -U -d + ./build.sh -U -D /some/DESTDIR distribution Using unprivileged mode, build a complete distribution in - DESTDIR. + /some/DESTDIR. - ./build.sh -U -R /some/dir/RELEASE - Using unprivileged mode, build a complete release in the speci- - fied release directory. + # ./build.sh -U -D /some/DESTDIR installworld=/ + As root, install the distribution that was built with unprivi- + leged mode from /some/DESTDIR to /. (Even though this is run + as root, -U is required so that the permissions stored in + /some/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 + /some/dir/RELEASE. OBSOLETE VARIABLES NBUILDJOBS Use the make(1) option -j, instead. @@ -568,4 +601,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD December 8, 2002 9 +NetBSD January 26, 2003 10