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.27 retrieving revision 1.57 diff -u -p -r1.27 -r1.57 --- src/BUILDING 2003/01/30 02:52:41 1.27 +++ src/BUILDING 2006/01/29 14:03:59 1.57 @@ -1,7 +1,7 @@ BUILDING(8) NetBSD System Manager's Manual BUILDING(8) NAME - BUILDING - Procedure for building NetBSD from source code. + BUILDING -- Procedure for building NetBSD from source code. STATUS This document is a work-in-progress. As such, the information described @@ -9,8 +9,8 @@ STATUS Once this document is completely in sync with reality, this paragraph will be removed. - Discrepancies between this documentation and the current reality of im- - plementation are noted specially, as with the note below: + 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 . @@ -28,23 +28,22 @@ REQUIREMENTS host system to create a build toolchain for the target architecture. The host system must have at least C and C++ compilers in order to create the toolchain (make is not required); all other tools are created as part of - the NetBSD build process. - - 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. + the NetBSD build process. (See the environment variables section below + if you need to override or manually select your compilers.) FILES Source tree layout - doc/BUILDING.mdoc This document (in -mdoc troff format; the original copy). BUILDING This document (in plaintext). - Makefile The main Makefile for NetBSD; should only be run for na- - tive builds with an appropriately up-to-date version of + tools/compat/README + Special notes for cross-hosting a NetBSD build on non- + NetBSD platforms. + + Makefile The main Makefile for NetBSD; should only be run for + native builds with an appropriately up-to-date version of NetBSD make(1). (For building from out-of-date systems or on a non-native host, see the build.sh shell script.) @@ -62,8 +61,8 @@ FILES Sources imported verbatim from third parties, without man- gling the existing build structure. Other source trees in bin through usr.sbin use the NetBSD make(1) ``reachover'' - Makefile semantics when building these programs for a na- - tive host. + Makefile semantics when building these programs for a + native host. distrib/, etc/ Sources for items used when making a full release snap- @@ -84,6 +83,9 @@ FILES any of these directories are missing, they will be skipped during the build. + x11/ ``Reachover'' build structure for X11R6; the source is in + X11SRCDIR. + Build tree layout The NetBSD build tree is described in hier(7), and the release layout is described in release(7). @@ -92,6 +94,10 @@ CONFIGURATION Environment variables Several environment variables control the behaviour of NetBSD builds. + HOST_CC Path name to C compiler used to create the toolchain. + + HOST_CXX Path name to C++ compiler used to create the toolchain. + MACHINE Machine type. MACHINE_ARCH Machine architecture. @@ -102,13 +108,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,11 +140,26 @@ 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. Default: ``/etc/mk.conf'' + MAKEVERBOSE + Level of verbosity of status messages. Supported values: + + 0 No descriptive messages are shown. + + 1 Descriptive messages are shown. + + 2 Descriptive messages (prefixed with a `#') and command + output is not suppressed. + + Default: 2 + MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor- matted plaintext manual pages will be created during a build. @@ -145,14 +168,14 @@ CONFIGURATION MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto- graphic code will be included in a build; provided for the benefit of countries that do not allow strong cryptography. - Will not affect use of the standard low-security password en- - cryption system, crypt(3). + Will not affect use of the standard low-security password + encryption system, crypt(3). Default: ``yes'' MKDOC Can be set to ``yes'' or ``no''. Indicates whether system - documentation destined for DESTDIR/usr/share/doc will be in- - stalled during a build. + documentation destined for DESTDIR/usr/share/doc will be + installed during a build. Default: ``yes'' @@ -186,8 +209,8 @@ CONFIGURATION Default: ``yes'' MKNLS Can be set to ``yes'' or ``no''. Indicates whether Native - Language System locale zone files will be compiled and in- - stalled during a build. + Language System locale zone files will be compiled and + installed during a build. Default: ``yes'' @@ -208,8 +231,8 @@ CONFIGURATION MKPICINSTALL Can be set to ``yes'' or ``no''. Indicates whether the ar(1) - format libraries (lib*_pic.a), used to generate shared li- - braries, are installed during a build. + format libraries (lib*_pic.a), used to generate shared + libraries, are installed during a build. Default: ``yes'' @@ -222,36 +245,48 @@ CONFIGURATION code. MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files - destined to reside in DESTDIR/usr/share will be built and in- - stalled during a build. If set to ``no'', then all of + destined to reside in DESTDIR/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'' unconditionally. Default: ``yes'' + 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. + + Default: ``no'' + + MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an + unprivileged install will occur. The user, group, permis- + sions, and file flags, will not be set on the installed + items; instead the information will be appended to a file + called METALOG in DESTDIR. The contents of METALOG are 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 + 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). + + Default: ``no'' + + MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11R6 is + built from X11SRCDIR. + + 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. @@ -275,8 +310,13 @@ CONFIGURATION 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) in- - clude files). + preserve traditional semantics of the make(1) + include files). + + X11SRCDIR Directory containing the X11R6 source. The main X11R6 source + is found in X11SRCDIR/xfree/xc. + + Default: ``/usr/xsrc'' "make" variables for full builds These variables only affect the top level ``Makefile'' and do not affect @@ -287,11 +327,18 @@ CONFIGURATION Default: ``/'' - MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether ob- - ject directories will be created automatically (via a + MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether + object 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) @@ -315,11 +362,11 @@ CONFIGURATION NOINCLUDES If set, avoids the ``make includes'' phase of a full build. This has the effect of preventing make(1) from - thinking that some programs are out-of-date simply be- - cause the system include files have changed. However, + thinking that some programs are out-of-date simply + 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 - UPDATE in that case. + MKUPDATE=yes in that case. Default: Unset. @@ -328,17 +375,17 @@ 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 - This is only a summary of options available to make(1); only the options - used most frequently with NetBSD builds are listed here. + This is not a summary of all the options available to make(1); only the + options used most frequently with NetBSD builds are listed here. -j njob Run up to njob make(1) subjobs in parallel. Makefiles should - use .WAIT or have explicit dependancies as necessary to en- - force build ordering. If you see build failures with -j, + 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. @@ -352,7 +399,7 @@ BUILDING actually execute them. This will still cause recursion to take place. - -v var Print make(1)'s idea of the value of var. Does not build any + -V var Print make(1)'s idea of the value of var. Does not build any targets. var=value Set the variable var to value, overriding any setting speci- @@ -369,14 +416,12 @@ BUILDING clean Remove program and library object code files. - cleandir Same as clean, but also remove preformatted documentation, de- - pendency files generated by ``make depend'', and any other - files known to be created at build time. ``make distclean'' - may be used as a synonym, for familiarity with a similar well- - known convention. + cleandir Same as clean, but also remove preformatted documentation, + dependency files generated by ``make depend'', and any other + files known to be created at build time. - depend Create dependency files (.depend) containing more detailed in- - formation about the dependencies of source code on header + depend Create dependency files (.depend) containing more detailed + information about the dependencies of source code on header files. Allows programs to be recompiled automatically when a dependency changes. @@ -384,8 +429,10 @@ BUILDING This improves cache locality of the build since both passes read the source files in their entirety. - includes Build and install system header files. Typically needed be- - fore any system libraries or programs can be built. + distclean Synonym for cleandir. + + includes Build and install system header files. Typically needed + before any system libraries or programs can be built. install Install programs, libraries, and documentation into DESTDIR. Few files will be installed to DESTDIR/dev, DESTDIR/etc, @@ -418,7 +465,7 @@ BUILDING installworld Install the distribution from DESTDIR to INSTALLWORLDDIR (which defaults to the root directory). Ensures that - INSTALLWORLDDIR is the not root directory if cross compil- + INSTALLWORLDDIR is not the root directory if cross compil- ing. Note: It is highly recommended that you upgrade your kernel @@ -429,12 +476,27 @@ BUILDING distribution'' (as ``make build'' does not install all of the required files). - 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 + 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). + + release Do a ``make distribution'', build kernels, distribution + media, and install sets (this as per ``make sets''), and + then package the system into a standard release layout as + described by release(7). This requires that RELEASEDIR be set (see above). + iso-image Create a CD-ROM image in + RELEASEDIR/MACHINE/installation/cdrom. RELEASEDIR must + already have been populated by ``make release'' or equiva- + lent. This requires the mkisofs(1) utility, which is not + part of NetBSD, but which can be installed from + pkgsrc/sysutils/cdrtools. + regression-tests Can only be run after building the regression tests in the directory ``regress''. Runs the compiled regression tests @@ -459,8 +521,8 @@ BUILDING 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. + build Build the system as per ``make build''. This option + implies the obj and tools operations. distribution Build a full distribution as per ``make distribution''. This option implies the build operation. @@ -475,8 +537,11 @@ BUILDING 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 + configuration file suitable for use by config(1). 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 @@ -486,45 +551,75 @@ 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 + determined from the ``config'' directives in kconf. sets Perform ``make sets''. - 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: + sourcesets Perform ``make sourcesets''. + + syspkgs Perform ``make syspkgs''. + + iso-image Perform ``make iso-image''. + + 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. -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. 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. + 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. + -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. + -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 noiselevel + Set the ``noisyness'' level of the build, by setting + MAKEVERBOSE to noiselevel. -n Show the commands that would be executed by build.sh, but do not make any changes. This is similar in concept to ``make @@ -533,9 +628,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. @@ -547,12 +645,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). + 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- @@ -560,6 +659,14 @@ BUILDING place the wrapper in PATH automatically. Note that wrapper is the full name of the file, not just a directory name. + -X x11src + Set the value of X11SRCDIR to x11src. + + -x Set MKX11=yes. + + -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 @@ -568,28 +675,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 kernel=GENERIC - Build a new toolchain, and use the new toolchain to configure - and build a new GENERIC kernel. - - ./build.sh -U -D /path/to/destdir distribution - Using unprivileged mode, build a complete distribution in - /path/to/destdir. - - # ./build.sh -U -D /path/to/destdir installworld=/ - As root, install the distribution that was built with unprivi- - leged mode from /path/to/destdir to /. (Even though this is - run as root, -U is required so that the permissions stored in - /path/to/destdir/METALOG are correctly applied to the files as - they're copied to /). - - ./build.sh -U -D /path/to/destdir -R /path/to/releasedir release - Using unprivileged mode, build a complete release in - /path/to/dir/releasedir. + 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 + + 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. @@ -599,7 +715,7 @@ OBSOLETE VARIABLES TOOLCHAIN_MISSING=yes. SEE ALSO - make(1), hier(7), release(7) + make(1), hier(7), release(7), pkgsrc/sysutils/cdrtools HISTORY The build.sh based build scheme was introduced for NetBSD 1.6 as @@ -608,4 +724,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD January 30, 2003 10 +NetBSD January 4, 2006 NetBSD