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.22 retrieving revision 1.43 diff -u -p -r1.22 -r1.43 --- src/BUILDING 2003/01/23 16:24:08 1.22 +++ src/BUILDING 2003/08/19 12:53:30 1.43 @@ -37,7 +37,6 @@ REQUIREMENTS FILES Source tree layout - doc/BUILDING.mdoc This document (in -mdoc troff format; the original copy). @@ -67,8 +66,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. @@ -102,13 +101,15 @@ CONFIGURATION 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. + MAKEOBJDIR can only be provided in the environment or + via the -O flag of build.sh. 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. + be provided in the environment or via the -M flag of + build.sh. "make" variables Several variables control the behavior of NetBSD builds. Unless other- @@ -132,6 +133,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 +155,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 +180,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,36 +226,37 @@ 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'' + MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an un- + privileged install will occur. The user, group, permissions, + and file flags, will not be set on the installed item; in- + stead 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: ``no'' + + MKUPDATE Can be set to ``yes'' or ``no''. Indicates whether all in- + stall 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 im- + plications on full builds (see next subsection). + + Default: ``no'' + 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. - - 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- - date. This also has implications on full builds (see next - subsection). + form will be created in the .OBJDIR of src. Default: Unset. @@ -291,7 +296,14 @@ CONFIGURATION ject directories will be created automatically (via a ``make obj'' pass) at the start of a build. - Default: ``yes'' + Default: ``no'' + + 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'' NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see below) @@ -319,7 +331,7 @@ CONFIGURATION 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. + MKUPDATE=yes in that case. Default: Unset. @@ -328,8 +340,8 @@ CONFIGURATION Default: Unset. - UPDATE If set, then in addition to the effects described for - UPDATE above, this implies the effects of NOCLEANDIR. + Note: build.sh will provide a default of releasedir (in + the top-level .OBJDIR) unless run in `expert' mode BUILDING "make" command line options @@ -388,9 +400,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,8 +422,8 @@ BUILDING the proper order. distribution Do a ``make build'', and then install a full distribution - into DESTDIR, including files in /dev, /etc, /root and - /var. + 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. @@ -424,10 +436,19 @@ BUILDING 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). + + 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, and then package the system into a - standard release layout as described by release(7). This - requires that RELEASEDIR be set (see above). + 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 @@ -462,10 +483,16 @@ BUILDING 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. + install=idir Install the contents of DESTDIR to idir, using ``make + installworld''. + 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 @@ -477,8 +504,15 @@ BUILDING 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''. + releasekernel=kconf + Install a gzip(1)ed copy of the kernel built by + kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually + as netbsd-kconf.gz, although the ``netbsd'' prefix is de- + termined from the ``config'' directives in kconf. + + 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 @@ -489,26 +523,47 @@ BUILDING -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''. + that the resulting name is of the form + ``nbmake-MACHINE-BUILDID''. -D dest Set the value of DESTDIR to dest. - -E Set `expert' mode; DESTDIR does not have to be set to a non- - root path for builds when this is set. + -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. -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 obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR. -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. + deduced from mach, unless -a is specified, or mach is a special + case listed below. 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. For a + given value of mach, the following MACHINE and MACHINE_ARCH + values will result: + + mach MACHINE MACHINE_ARCH + 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 Show the commands that would be executed by build.sh, but do not make any changes. This is similar in concept to ``make @@ -517,9 +572,12 @@ BUILDING -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. + /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth. + Unsets MAKEOBJDIRPREFIX. - -o Set the value of MKOBJDIRS to ``no''. + -o Set the value of MKOBJDIRS to ``no''. Otherwise, it will be + automatically set to ``yes'' (which is opposite to the default + behaviour). -R rel Set the value of RELEASEDIR to rel. @@ -531,14 +589,13 @@ BUILDING ``make'' will only be rebuilt as needed (when the source files for make(1) change). - -U Set the UNPRIVED variable. + -U Set MKUNPRIVED=yes. - -u Set the UPDATE variable. + -u Set MKUPDATE=yes. -V var=[value] - Set the variable var to value (which is optional). This is - useful for setting RELEASEDIR without actually building a re- - lease. + 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- @@ -546,6 +603,9 @@ BUILDING place the wrapper in PATH automatically. Note that wrapper is the full name of the file, not just a directory name. + -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 will be created in TOOLDIR/bin upon the first build to assist in building @@ -554,39 +614,37 @@ 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. + build.sh will also set variables specified with -V, and unset variables + specified with -Z. + This script can be symlinked into a directory listed in PATH, or called with an absolute path. EXAMPLES - ./build.sh tools - 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 tools kernel=GENERIC - Build a new toolchain, and use the new toolchain to configure - and build a new GENERIC kernel. This is a simpler way to - achieve what the first three examples do. - - ./build.sh -U distribution - Using unprivileged mode, build a complete distribution in - DESTDIR. - - # ./build.sh -U installworld=/ - As root, install the distribution that was built with unprivi- - leged mode from DESTDIR to /. (Even though this is run as - root, -U is required so that the permissions stored in - DESTDIR/METALOG are correctly applied to the files as they're - copied to /). - - ./build.sh -U -R /some/dir/RELEASE 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). + 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. @@ -605,4 +663,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD January 24, 2003 10 +NetBSD August 7, 2003 NetBSD