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.59.2.3 retrieving revision 1.85 diff -u -p -r1.59.2.3 -r1.85 --- src/BUILDING 2007/09/29 11:10:56 1.59.2.3 +++ src/BUILDING 2009/07/12 14:17:18 1.85 @@ -3,21 +3,6 @@ BUILDING(8) NetBSD System Ma NAME BUILDING -- Procedure for building NetBSD from source code. -STATUS - This document is a work-in-progress. As such, the information described - here may not match the reality of the build system as of this writing. - Once this document is completely in sync with reality, this paragraph - will be removed. - - Discrepancies between this documentation and the current reality of - implementation are noted specially, as with the note below: - - Note: This document applies only to platforms which use the new toolchain - as indicated by the default setting of TOOLCHAIN_MISSING in . - Platforms which have not yet been switched to the new toolchain should - continue building traditionally, using the notes specified in the file - UPDATING. - REQUIREMENTS NetBSD is designed to be buildable on most POSIX-compliant host systems. The basic build procedure is the same whether compiling natively (on the @@ -69,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. @@ -110,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. @@ -120,17 +108,23 @@ 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, including mk.conf or + ${MAKECONF}. 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, + including mk.conf or ${MAKECONF}. "make" variables Several variables control the behavior of NetBSD builds. Unless other- @@ -142,6 +136,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, result- + ing in identical (reproducible) builds. Additional informa- + tion 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, @@ -155,7 +157,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. @@ -165,12 +167,24 @@ CONFIGURATION MAKEVERBOSE Level of verbosity of status messages. Supported values: - 0 No descriptive messages are shown. + 0 No descriptive messages or commands executed by make(1) + are shown. - 1 Descriptive messages are shown. + 1 Brief messages are shown describing what is being done, + but the actual commands executed by make(1) are not dis- + played. + + 2 Descriptive messages are shown as above (prefixed with a + `#'), and ordinary commands performed by make(1) are + displayed. + + 3 In addition to the above, all commands performed by + make(1) are displayed, even if they would ordinarily + have been hidden through use of the ``@'' prefix in the + relevant makefile. - 2 Descriptive messages (prefixed with a `#') and command - output is not suppressed. + 4 In addition to the above, commands executed by make(1) + are traced through use of the sh(1) ``-x'' flag. Default: 2 @@ -193,6 +207,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 @@ -235,6 +254,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 @@ -266,6 +288,19 @@ CONFIGURATION Default: ``yes'' + MKSTRIPIDENT + Can be set to ``yes'' or ``no''. Indicates whether program + binaries and shared libraries should be built to include RCS + IDs for use with ident(1). + + Default: ``no'' + + MKSUBPIXEL Can be set to ``yes'' or ``no''. For X builds, decides if + subpixel rendering code in FreeType is turned on. Turned off + by default because of patent issues. + + Default: ``no'' + MKTTINTERP Can be set to ``yes'' or ``no''. For X builds, decides if the TrueType bytecode interpreter is turned on. See http://www.freetype.org/patents.html for details. @@ -290,7 +325,7 @@ CONFIGURATION Default: ``no'' - MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11R6 is + MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11 is built from X11SRCDIR. Default: ``no'' @@ -323,10 +358,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 +369,12 @@ CONFIGURATION Default: ``/usr/xsrc'' + X11FLAVOUR The style of X11 cross-built, set to either ``Xorg'' or + ``XFree86''. + + Default: ``Xorg'' on amd64, i386, macppc, shark and sparc64 + platforms, ``XFree86'' on everything else. + "make" variables for full builds These variables only affect the top level ``Makefile'' and do not affect manually building subtrees of the NetBSD source code. @@ -349,6 +390,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 @@ -356,8 +400,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. @@ -368,6 +415,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 @@ -382,7 +431,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. @@ -393,7 +442,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 @@ -402,15 +451,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 @@ -469,26 +517,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 @@ -499,17 +548,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 @@ -531,11 +580,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- @@ -559,11 +608,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- @@ -572,8 +621,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 @@ -594,21 +645,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 @@ -621,15 +680,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''. @@ -649,15 +713,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 @@ -673,27 +740,38 @@ 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. - - -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, 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: + -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 + 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. + + Some machines support multiple values for MACHINE_ARCH. The + following special cases for the mach argument are defined to + set the listed values of MACHINE and MACHINE_ARCH: mach MACHINE MACHINE_ARCH + evbarm evbarm (not set) + evbarm-eb evbarm armeb + evbarm-el evbarm arm evbmips evbmips (not set) evbmips-eb evbmips mipseb evbmips-el evbmips mipsel @@ -713,15 +791,23 @@ 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 neither -M nor -O is specified, then a default + object directory will be chosen according to rules in + . Relying on this default is not recommended + because it is determined by complex rules that are influenced + by the values of several variables and by the location of the + source directory. -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 @@ -731,10 +817,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. @@ -770,31 +859,31 @@ 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. EXAMPLES - 1. % ./build.sh tools kernel=GENERIC + 1. % ./build.sh [options] 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 + 2. % ./build.sh [options] -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=/ + 3. # ./build.sh [options] -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 + 4. % ./build.sh [options] -U -u release Using unprivileged mode, build a complete release to DESTDIR and RELEASEDIR directories that build.sh selects (and will display). @@ -803,7 +892,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 @@ -817,7 +906,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 September 1, 2007 NetBSD +NetBSD May 1, 2009 NetBSD