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.50 retrieving revision 1.59 diff -u -p -r1.50 -r1.59 --- src/BUILDING 2004/03/19 12:34:39 1.50 +++ src/BUILDING 2006/10/08 17:54:30 1.59 @@ -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 @@ -28,7 +28,8 @@ 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. + the NetBSD build process. (See the environment variables section below + if you need to override or manually select your compilers.) FILES Source tree layout @@ -93,6 +94,22 @@ CONFIGURATION Environment variables Several environment variables control the behaviour of NetBSD builds. + HOST_SH Path name to a POSIX-compliant shell. If this is not + set explicitly, then the default is set using heuris- + tics dependent on the host platform, or from the shell + under which build.sh is executed (if that can be deter- + mined), or using the first copy of sh found in PATH. + If the host system's /bin/sh is not POSIX-compliant, we + suggest that you build using commands like + + HOST_SH=/path/to/working/shell + export HOST_SH + ${HOST_SH} build.sh [options] + + 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,15 +119,17 @@ CONFIGURATION MAKEFLAGS Flags to invoke make(1) with. MAKEOBJDIR Directory to use as the .OBJDIR for the current direc- - tory. Used only if MAKEOBJDIRPREFIX is not defined. + 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. 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 or via the -M flag of + 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. "make" variables @@ -126,11 +145,11 @@ CONFIGURATION 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, - /usr/lib, and so forth. This pathname should not end with a - slash (/) character (for installation into the system's root - directory, set DESTDIR to an empty string). The directory - must reside on a file system which supports long file names - and hard links. + /usr/lib, and so forth. This pathname must be an absolute + path, and should not end with a slash (/) character. (For + installation into the system's root directory, set DESTDIR to + an empty string, not to ``/''). The directory must reside on + a file system which supports long file names and hard links. Default: Empty string if USETOOLS is ``yes''; unset other- wise. @@ -255,11 +274,11 @@ CONFIGURATION 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 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. + 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'' @@ -276,12 +295,13 @@ CONFIGURATION 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. + TOOLDIR Directory to hold the host tools, once built. If specified, + must be an absolute path. This directory should be unique to + a given host system and NetBSD source tree. (However, multi- + ple 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 platform will be created in + the .OBJDIR of src. Default: Unset. @@ -308,8 +328,9 @@ CONFIGURATION 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. + X11SRCDIR Directory containing the X11R6 source. If specified, must be + an absolute path. The main X11R6 source is found in + X11SRCDIR/xfree/xc. Default: ``/usr/xsrc'' @@ -318,7 +339,7 @@ CONFIGURATION manually building subtrees of the NetBSD source code. INSTALLWORLDDIR Location for the ``make installworld'' target to install - to. + to. If specified, must be an absolute path. Default: ``/'' @@ -367,6 +388,7 @@ CONFIGURATION RELEASEDIR If set, specifies the directory to which a release(7) layout will be written at the end of a ``make release''. + If specified, must be an absolute path. Default: Unset. @@ -375,11 +397,11 @@ CONFIGURATION 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 + 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. @@ -460,7 +482,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 @@ -474,12 +496,24 @@ BUILDING 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 @@ -524,7 +558,7 @@ BUILDING 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 @@ -544,9 +578,12 @@ BUILDING 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 - build.sh operations described above: + 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. @@ -556,7 +593,9 @@ BUILDING that the resulting name is of the form ``nbmake-MACHINE-BUILDID''. - -D dest Set the value of DESTDIR to dest. + -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 + used. -E Set `expert' mode. This overrides various sanity checks, and allows: DESTDIR does not have to be set to a non-root path for @@ -566,12 +605,16 @@ BUILDING 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. Unsets MAKEOBJDIR. + -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 @@ -604,24 +647,28 @@ BUILDING -n''. -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, /usr/obj/usr.bin, and so forth. - Unsets MAKEOBJDIRPREFIX. + 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. -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. + -R rel Set the value of RELEASEDIR to rel. If a relative path is + specified, it will be converted to an absolute path before + being used. -r Remove the contents of DESTDIR and TOOLDIR before building (provides a clean starting point). This will skip deleting DESTDIR if building on a native system to the root directory. - -T tools Set the value of TOOLDIR to tools. If set, the bootstrap - ``make'' will only be rebuilt as needed (when the source files - for make(1) change). + -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). -U Set MKUNPRIVED=yes. @@ -635,10 +682,14 @@ BUILDING Create the nbmake wrapper script (see below) in a custom loca- tion, specified by wrapper. This allows, for instance, to place the wrapper in PATH automatically. Note that wrapper is - the full name of the file, not just a directory name. + the full name of the file, not just a directory name. If a + relative path is specified, it will be converted to an absolute + path before being used. -X x11src - Set the value of X11SRCDIR to x11src. + Set the value of X11SRCDIR to x11src. If a relative path is + specified, it will be converted to an absolute path before + being used. -x Set MKX11=yes. @@ -693,7 +744,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 @@ -702,4 +753,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD February 6, 2003 NetBSD +NetBSD January 4, 2006 NetBSD