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.20 retrieving revision 1.32 diff -u -p -r1.20 -r1.32 --- src/BUILDING 2002/12/25 00:58:00 1.20 +++ src/BUILDING 2003/05/10 07:15:53 1.32 @@ -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. @@ -67,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. @@ -132,6 +132,9 @@ CONFIGURATION 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. @@ -151,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'' @@ -176,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'' @@ -222,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'' @@ -328,8 +331,12 @@ CONFIGURATION 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 - UPDATE above, this implies the effects of NOCLEANDIR. + UPDATE above, this implies the effects of NOCLEANDIR + (i.e., ``make cleandir'' is avoided). BUILDING "make" command line options @@ -388,9 +395,9 @@ BUILDING fore any system libraries or programs can be built. install Install programs, libraries, and documentation into DESTDIR. - Few files will be installed to /dev, /etc, /root or /var in - order to prevent user supplied configuration data from being - overwritten. + 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. @@ -410,7 +417,8 @@ BUILDING the proper order. distribution Do a ``make build'', and then install a full distribution - into DESTDIR. + 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. @@ -423,9 +431,19 @@ BUILDING 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). + 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. + + 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 @@ -449,8 +467,45 @@ 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''. + + sourcesets Perform ``make sourcesets''. + + 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. @@ -460,43 +515,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; 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. + -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. - -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 @@ -516,9 +549,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 @@ -528,13 +559,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 @@ -553,27 +584,30 @@ BUILDING with an absolute path. EXAMPLES - ./build.sh -t - Build a new toolchain. + 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 - 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. + 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. @@ -592,4 +626,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD December 25, 2002 9 +NetBSD May 10, 2003 10