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.62.4.1 retrieving revision 1.72 diff -u -p -r1.62.4.1 -r1.72 --- src/BUILDING 2007/11/06 23:07:09 1.62.4.1 +++ src/BUILDING 2008/08/05 19:43:33 1.72 @@ -54,8 +54,11 @@ FILES 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. + tests/, regress/ + Regression test harness. Can be cross-compiled, but only + run natively. tests/ uses the atf(7) test framework; + regress/ contains older tests that have not yet been + migrated to atf(7). sys/ NetBSD kernel sources. @@ -95,9 +98,9 @@ CONFIGURATION HOST_CXX Path name to C++ compiler used to create the toolchain. - MACHINE Machine type. + MACHINE Machine type, e.g., ``macppc''. - MACHINE_ARCH Machine architecture. + MACHINE_ARCH Machine architecture, e.g., ``powerpc''. MAKE Path name to invoke make(1) as. @@ -127,6 +130,14 @@ CONFIGURATION configuration file in order to set additional build parame- ters, such as compiler flags. + BUILDSEED GCC uses random numbers when compiling C++ code. This vari- + able seeds the gcc random number generator using the -fran- + dom-seed flag with this value. By default, it is set to + NetBSD-(majorversion). Using a fixed value causes C++ bina- + ries to be the same when built from the same sources. Addi- + tional information is available in the GCC documentation of + -frandom-seed. + 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, @@ -140,7 +151,7 @@ CONFIGURATION wise. Note: build.sh will provide a default of destdir.MACHINE (in - the top-level .OBJDIR) unless run in `expert' mode + the top-level .OBJDIR) unless run in `expert' mode. MAKECONF The name of the make(1) configuration file. Only settable in the process environment. @@ -220,6 +231,9 @@ CONFIGURATION Default: ``yes'' + Note that setting MKOBJ to ``no'' is not recommended and may + cause problems when updating the tree with cvs(1). + MKPIC Can be set to ``yes'' or ``no''. Indicates whether shared objects and libraries will be created and installed during a build. If set to ``no'', the entire built system will be @@ -308,10 +322,10 @@ CONFIGURATION build or runtime problems when building the whole NetBSD source tree. - Default: ``yes'' if building all or part of a whole NetBSD - source tree (detected automatically); ``no'' otherwise (to - preserve traditional semantics of the make(1) - include files). + Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''. + + USETOOLS is also set to ``no'' when using outside + the NetBSD source tree. X11SRCDIR Directory containing the X11R6 source. If specified, must be an absolute path. The main X11R6 source is found in @@ -334,6 +348,9 @@ CONFIGURATION Default: ``no'' + If using build.sh, the default is ``yes''. This may be + set back to ``no'' by giving build.sh the -o option. + 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 @@ -341,8 +358,11 @@ CONFIGURATION Default: ``no'' - NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see - below) + If using build.sh, this may be set by giving the -u + option. + + NBUILDJOBS Now obsolete. Use the make(1) option -j, instead. See + below. Default: Unset. @@ -353,6 +373,8 @@ CONFIGURATION Default: Unset. + See also MKUPDATE. + 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 @@ -367,7 +389,7 @@ CONFIGURATION because 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 - MKUPDATE=yes in that case. + MKUPDATE=yes instead in that case. Default: Unset. @@ -378,7 +400,7 @@ CONFIGURATION Default: Unset. Note: build.sh will provide a default of releasedir (in - the top-level .OBJDIR) unless run in `expert' mode + the top-level .OBJDIR) unless run in `expert' mode. BUILDING "make" command line options @@ -394,8 +416,9 @@ BUILDING -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 - ``share/mk'' directory in the source tree. (This is set auto- - matically when building from the top level.) + ``share/mk'' directory in the source tree. This is set auto- + matically when building from the top level, or when using + build.sh. -n Display the commands that would have been executed, but do not actually execute them. This will still cause recursion to @@ -454,26 +477,27 @@ 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 proper order. + build Build the entire NetBSD system (except the kernel). 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. + (which does not include a kernel) 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 + installworld Install the distribution from DESTDIR to INSTALLWORLDDIR, + which defaults to the root directory. Ensures that INSTALLWORLDDIR is not the root directory if cross compil- ing. The INSTALLSETS environment variable may be set to a list of distribution sets to be installed. By default, all sets - except ``etc'' and ``xetc'' are installed (so most files in - INSTALLWORLDDIR/etc will not be installed or modified). + except ``etc'' and ``xetc'' are installed, so most files in + INSTALLWORLDDIR/etc will not be installed or modified. Note: Before performing this operation with INSTALLWORLDDIR=/, it is highly recommended that you @@ -484,17 +508,17 @@ BUILDING to fix them). 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). + RELEASEDIR/RELEASEMACHINEDIR/binary/sets. Should be run + after ``make distribution'', as ``make build'' alone does + not install all of the required files. sourcesets Create source sets of the source tree into RELEASEDIR/source/sets. syspkgs Create syspkgs from DESTDIR into - RELEASEDIR/MACHINE/binary/syspkgs. Should be run after - ``make distribution'' (as ``make build'' does not install - all of the required files). + RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs. Should be run + after ``make distribution'', as ``make build'' alone does + not install all of the required files. release Do a ``make distribution'', build kernels, distribution media, and install sets (this as per ``make sets''), and @@ -516,11 +540,11 @@ BUILDING populated by ``make release'' or equivalent. Note that other, smaller, CD-ROM images may be created in - the RELEASEDIR/MACHINE/installation/cdrom directory by - ``make release''. These smaller images usually contain the - same tools as the larger images in RELEASEDIR/iso, but do - not contain additional content such as the distribution - sets. + the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc- + tory by ``make release''. These smaller images usually + contain the same tools as the larger images in + RELEASEDIR/iso, but do not contain additional content such + as the distribution sets. Note that the mac68k port still uses an older method of creating CD-ROM images. This requires the mkisofs(1) util- @@ -544,11 +568,11 @@ BUILDING lent. Note that other, smaller, CD-ROM images may be created in - the RELEASEDIR/MACHINE/installation/cdrom directory by - ``make release''. These smaller images usually contain the - same tools as the larger images in RELEASEDIR/iso, but do - not contain additional content such as the distribution - sets. + the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc- + tory by ``make release''. These smaller images usually + contain the same tools as the larger images in + RELEASEDIR/iso, but do not contain additional content such + as the distribution sets. Note that the mac68k port still uses an older method of creating CD-ROM images. This requires the mkisofs(1) util- @@ -557,8 +581,10 @@ BUILDING regression-tests Can only be run after building the regression tests in the - directory ``regress''. Runs the compiled regression tests - on the local host. + directory ``regress''. Runs those compiled regression + tests on the local host. Note that most tests are now man- + aged instead using atf(7); this target should probably run + those as well but currently does not. The "build.sh" script This script file is a Bourne shell script designed to build the entire @@ -579,21 +605,27 @@ BUILDING The following operations are supported by build.sh: - build Build the system as per ``make build''. This option - implies the obj and tools operations. + build Build the system as per ``make build''. Before the main + part of the build commences, this command runs the obj + operation (unless the -o option is given), ``make + cleandir'' (unless the -u option is given), and the tools + operation. distribution Build a full distribution as per ``make distribution''. - This option implies the build operation. + This command first runs the build operation. - release Build a full release as per ``make release''. This option - implies the distribution operation. + release Build a full release as per ``make release''. This command + first runs 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. + tools Build and install the host tools from src/tools. This com- + mand will first run ``make obj'' and ``make cleandir'' in + the tools subdirectory unless the -o or -u options (respec- + tively) are given. install=idir Install the contents of DESTDIR to idir, using ``make installworld''. Note that files that are part of the @@ -606,15 +638,20 @@ BUILDING 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). + + This command does not imply the tools command; run the + tools command first unless it is certain that the tools + already exist and are up to date. + + This command will run ``make cleandir'' on the kernel in + question first unless the -u option is given. 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 - determined from the ``config'' directives in kconf. + Install a gzip(1)ed copy of the kernel previously built by + kernel=kconf into + RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as + netbsd-kconf.gz, although the ``netbsd'' prefix is deter- + mined from the ``config'' directives in kconf. sets Perform ``make sets''. @@ -634,15 +671,18 @@ 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 + build identifier to the name of the ``make'' wrapper script so that the resulting name is of the form ``nbmake-MACHINE-BUILDID''. - -C cddir Set the value of CDEXTRA to cddir. If a relative path is spec- - ified, it will be converted to an absolute path before being - used. When combined with ``iso-image'' or - ``iso-image-source'', it will cause the contents of cddir to be - added to the CD-ROM image. + -C cdextras + Set the value of CDEXTRA to cdextras which is a space-separated + list of files or directories which will be added in order to + the CD-ROM image when used in conjunction with ``iso-image'' or + ``iso-image-source''. Files will be added to the root of the + CD-ROM image, whereas directories will be copied recursively. + If relative paths are specified, they will be converted to + absolute paths before being used. -D dest Set the value of DESTDIR to dest. If a relative path is speci- fied, it will be converted to an absolute path before being @@ -658,10 +698,11 @@ BUILDING -h Print a help message. - -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. + -j njob Run up to njob make(1) subjobs in parallel; passed through to + make(1). Makefiles should use .WAIT or have explicit dependan- + cies as necessary to enforce build ordering. If you see build + failures with -j, please save complete build logs so the fail- + ures can be analyzed. -M obj Set MAKEOBJDIRPREFIX to obj. If a relative path is specified, it will be converted to an absolute path before being used. @@ -708,8 +749,8 @@ BUILDING /usr/obj/usr.bin, and so forth. Unsets MAKEOBJDIRPREFIX. -o Set the value of MKOBJDIRS to ``no''. Otherwise, it will be - automatically set to ``yes'' (which is opposite to the default - behaviour). + automatically set to ``yes''. This default is opposite to the + behaviour when not using build.sh. -R rel Set the value of RELEASEDIR to rel. If a relative path is specified, it will be converted to an absolute path before @@ -719,10 +760,13 @@ BUILDING (provides a clean starting point). This will skip deleting DESTDIR if building on a native system to the root directory. + -S seed Change the value of BUILDSEED to seed. This should rarely be + necessary. + -T tools Set the value of TOOLDIR to tools. If a relative path is spec- ified, it will be converted to an absolute path before being - used. If set, the bootstrap ``make'' will only be rebuilt as - needed (when the source files for make(1) change). + used. If set, the bootstrap ``make'' will only be rebuilt if + the source files for make(1) have changed. -U Set MKUNPRIVED=yes. @@ -758,8 +802,8 @@ 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. + nbmake-MACHINE will also set variables specified with -V, and unset vari- + ables specified with -Z. This script can be symlinked into a directory listed in PATH, or called with an absolute path. @@ -791,7 +835,7 @@ EXAMPLES of the release build. OBSOLETE VARIABLES - NBUILDJOBS 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 @@ -808,4 +852,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD September 1, 2007 NetBSD +NetBSD March 18, 2008 NetBSD