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.3 retrieving revision 1.77 diff -u -p -r1.62.4.3 -r1.77 --- src/BUILDING 2008/03/23 00:12:06 1.62.4.3 +++ src/BUILDING 2008/09/06 23:23:17 1.77 @@ -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. @@ -105,17 +108,21 @@ CONFIGURATION MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- tory. The value is subjected to variable expansion by - make(1). Used only if MAKEOBJDIRPREFIX is not defined. - MAKEOBJDIR can only be provided in the environment or - via the -O flag of build.sh. + make(1). Typical usage is to set this variable to a + value involving the use of `${.CURDIR:S...}' or + `${.CURDIR:C...}', to derive the value of .OBJDIR from + the value of .CURDIR. Used only if MAKEOBJDIRPREFIX is + not defined. MAKEOBJDIR can be provided only in the + environment or via the -O flag of build.sh; it cannot + usefully be set inside a Makefile. MAKEOBJDIRPREFIX Top level directory of the object directory tree. If specified, must be an absolute path. If this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the .OBJDIR for the current directory. The current direc- - tory may be read only. MAKEOBJDIRPREFIX can only be - provided in the environment or via the -M flag of - build.sh. + tory may be read only. MAKEOBJDIRPREFIX can be pro- + vided only in the environment or via the -M flag of + build.sh; it cannot usefully be set inside a Makefile. "make" variables Several variables control the behavior of NetBSD builds. Unless other- @@ -127,6 +134,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 +155,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. @@ -178,6 +193,11 @@ CONFIGURATION Default: ``yes'' + MKHTML Can be set to ``yes'' or ``no''. Indicates whether prefor- + matted HTML manual pages will be built and installed + + Default: ``yes'' + MKHOSTOBJ Can be set to ``yes'' or ``no''. If set to ``yes'', then for programs intended to be run on the compile host, the name, release, and architecture of the host operating system will @@ -220,6 +240,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 @@ -278,6 +301,15 @@ CONFIGURATION MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11R6 is built from X11SRCDIR. + Mutually exclusive to MKXORG != no. + + Default: ``no'' + + MKXORG Can be set to ``yes'' or ``no''. Indicates whether X11R7 + (modular Xorg) is built from X11SRCDIR. + + Mutually exclusive to MKX11 != no. + Default: ``no'' TOOLDIR Directory to hold the host tools, once built. If specified, @@ -308,10 +340,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 +366,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 +376,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 +391,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 +407,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 +418,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 @@ -387,15 +427,14 @@ BUILDING -j njob Run up to njob make(1) subjobs in parallel. Makefiles should use .WAIT or have explicit dependencies as necessary to - enforce build ordering. If you see build failures with -j, - please save complete build logs so the failures can be ana- - lyzed. + enforce build ordering. -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 @@ -466,15 +505,15 @@ BUILDING 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 @@ -486,16 +525,16 @@ BUILDING sets Create distribution sets from DESTDIR into RELEASEDIR/RELEASEMACHINEDIR/binary/sets. Should be run - after ``make distribution'' (as ``make build'' does not - install all of the required files). + 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/RELEASEMACHINEDIR/binary/syspkgs. Should be run - after ``make distribution'' (as ``make build'' does not - install all of the required files). + 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 @@ -558,8 +597,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 @@ -580,21 +621,29 @@ 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. + cleandir Perform ``make cleandir''. + 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 @@ -607,12 +656,16 @@ 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 + 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- @@ -663,14 +716,22 @@ 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. - - -M obj Set MAKEOBJDIRPREFIX to obj. If a relative path is specified, - it will be converted to an absolute path before being used. - Unsets MAKEOBJDIR. + -j njob Run up to njob make(1) subjobs in parallel; passed through to + make(1). If you see failures for reasons other than running + out of memory while using build.sh with -j, please save com- + plete build logs so the failures can be analyzed. + + To achieve the fastest builds, -j values between (1 + the num- + ber of CPUs) and (2 * the number of CPUs) are recommended. Use + lower values on machines with limited memory or I/O bandwidth. + + -M obj Set MAKEOBJDIRPREFIX to obj. For instance, if the source + directory is /usr/src, a setting of ``-M /usr/obj'' will place + build-time files under /usr/obj/usr/src/bin, + /usr/obj/usr/src/lib, /usr/obj/usr/src/usr.bin, and so forth. + If a relative path is specified, it will be converted to an + absolute path before being used. Unsets MAKEOBJDIR. See ``-O + -obj'' for more information. -m mach Set the value of MACHINE to mach, except in some special cases listed below. This will also override any value of @@ -706,15 +767,21 @@ BUILDING -n''. -O obj Create an appropriate transform macro for MAKEOBJDIR that will - place the built object files under obj. If a relative path is - specified, it will be converted to an absolute path before - being used. For instance, a setting of /usr/obj will place - build-time files under /usr/obj/bin, /usr/obj/lib, - /usr/obj/usr.bin, and so forth. Unsets MAKEOBJDIRPREFIX. + place the built object files under obj. For instance, a set- + ting of ``-O /usr/obj'' will place build-time files under + /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth. If + a relative path is specified, it will be converted to an abso- + lute path before being used. Unsets MAKEOBJDIRPREFIX. + + In normal use, exactly one of the -M or -O options should be + specified. If the source directory is /usr/src and neither -M + nor -O is specified, then a default object directory will be + chosen according to rules in ; this default is usu- + ally either /usr/obj or /usr/obj.MACHINE. -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 @@ -724,10 +791,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. @@ -763,8 +833,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. @@ -796,7 +866,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 @@ -810,7 +880,4 @@ HISTORY 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 this build system. - -NetBSD March 18, 2008 NetBSD +NetBSD August 18, 2008 NetBSD