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.55 retrieving revision 1.65 diff -u -p -r1.55 -r1.65 --- src/BUILDING 2006/01/12 21:22:30 1.55 +++ src/BUILDING 2007/09/01 08:15:27 1.65 @@ -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 @@ -94,6 +79,18 @@ 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. @@ -107,15 +104,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 @@ -131,11 +130,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. @@ -281,12 +280,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. @@ -313,8 +313,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'' @@ -323,7 +324,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: ``/'' @@ -372,6 +373,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. @@ -468,8 +470,18 @@ BUILDING INSTALLWORLDDIR is not the root directory if cross compil- ing. - Note: It is highly recommended that you upgrade your kernel - and reboot before performing this operation. + 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). + + Note: Before performing this operation with + INSTALLWORLDDIR=/, it is highly recommended that you + upgrade your kernel and reboot. After performing this + operation, it is recommended that you use etcupdate(8) to + update files in INSTALLWORLDDIR/etc and that you use + postinstall(8) to check for inconsistencies (and possibly + to fix them). sets Create distribution sets from DESTDIR into RELEASEDIR/MACHINE/binary/sets. Should be run after ``make @@ -490,6 +502,59 @@ BUILDING described by release(7). This requires that RELEASEDIR be set (see above). + iso-image Create a NetBSD installation CD-ROM image in the + RELEASEDIR/iso directory. The CD-ROM file system will have + a layout as described in release(7). + + For most machine types, the CD-ROM will be bootable, and + will automatically run the sysinst(8) menu-based installa- + tion program, which can be used to install or upgrade a + NetBSD system. Bootable CD-ROMs also contain tools that + may be useful in repairing a damaged NetBSD installation. + + Before ``make iso-image'' is attempted, RELEASEDIR must be + 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. + + Note that the mac68k port still uses an older method of + creating CD-ROM images. This requires the mkisofs(1) util- + ity, which is not part of NetBSD, but which can be + installed from pkgsrc/sysutils/cdrtools. + + iso-image-source + Create a NetBSD installation CD-ROM image in the + RELEASEDIR/iso directory. The CD-ROM file system will have + a layout as described in release(7). It will have top + level directories for the machine type and source. + + For most machine types, the CD-ROM will be bootable, and + will automatically run the sysinst(8) menu-based installa- + tion program, which can be used to install or upgrade a + NetBSD system. Bootable CD-ROMs also contain tools that + may be useful in repairing a damaged NetBSD installation. + + Before ``make iso-image-source'' is attempted, RELEASEDIR + must be populated by ``make sourcesets release'' or equiva- + 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. + + Note that the mac68k port still uses an older method of + creating CD-ROM images. This requires the mkisofs(1) util- + ity, 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 @@ -531,7 +596,8 @@ BUILDING tools Build and install the host tools from src/tools. install=idir Install the contents of DESTDIR to idir, using ``make - installworld''. + installworld''. Note that files that are part of the + ``etc'' or ``xetc'' sets will not be installed. kernel=kconf Build a new kernel. The kconf argument is the name of a configuration file suitable for use by config(1). If kconf @@ -556,6 +622,17 @@ BUILDING syspkgs Perform ``make syspkgs''. + iso-image Perform ``make iso-image''. + + iso-image-source + Perform ``make iso-image-source''. + + iso-dir=directory + When combined with ``iso-image'' or ``iso-image-source'', + it will cause directory to be added to the CD-ROM image. + If directory does not start with ``/'' then it will be made + relative to RELEASEDIR. + The following command line options alter the behaviour of the build.sh operations described above: @@ -567,7 +644,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 @@ -584,20 +663,25 @@ BUILDING 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 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: + -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, 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 @@ -617,24 +701,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. @@ -648,10 +736,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. @@ -706,7 +798,8 @@ OBSOLETE VARIABLES TOOLCHAIN_MISSING=yes. SEE ALSO - make(1), hier(7), release(7) + make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8), + pkgsrc/sysutils/cdrtools HISTORY The build.sh based build scheme was introduced for NetBSD 1.6 as @@ -715,4 +808,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD January 4, 2006 NetBSD +NetBSD September 1, 2007 NetBSD