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.60 retrieving revision 1.62.4.3 diff -u -p -r1.60 -r1.62.4.3 --- src/BUILDING 2007/01/27 11:47:36 1.60 +++ src/BUILDING 2008/03/23 00:12:06 1.62.4.3 @@ -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 @@ -469,13 +454,14 @@ 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. @@ -485,21 +471,31 @@ 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 - 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'' 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'' 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 @@ -507,12 +503,58 @@ BUILDING 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. + 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/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- + 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/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- + 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 @@ -555,7 +597,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 @@ -570,9 +613,10 @@ BUILDING 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. + 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''. @@ -582,6 +626,9 @@ BUILDING iso-image Perform ``make iso-image''. + iso-image-source + Perform ``make iso-image-source''. + The following command line options alter the behaviour of the build.sh operations described above: @@ -589,10 +636,19 @@ 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 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 used. @@ -747,7 +803,8 @@ OBSOLETE VARIABLES TOOLCHAIN_MISSING=yes. SEE ALSO - make(1), hier(7), release(7), pkgsrc/sysutils/cdrtools + 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 @@ -756,4 +813,4 @@ HISTORY BUGS A few platforms are not yet using this build system. -NetBSD January 4, 2006 NetBSD +NetBSD March 18, 2008 NetBSD