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.94 retrieving revision 1.101.2.1 diff -u -p -r1.94 -r1.101.2.1 --- src/BUILDING 2011/09/09 13:29:23 1.94 +++ src/BUILDING 2012/11/20 02:57:26 1.101.2.1 @@ -82,17 +82,23 @@ 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_SH Path name to a shell available on the host system and + suitable for use during the build. The NetBSD build + system requires a modern Bourne-like shell with POSIX- + compliant features, and also requires support for the + ``local'' keyword to declare local variables in shell + functions (which is a widely-implemented but non-stan- + dardised feature). + + Depending on the host system, a suitable shell may be + /bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a + variant of ksh that supports the ``local'' keyword, + such as ksh88, but not ksh93), or /usr/local/bin/bash. + + Most parts of the build require HOST_SH to be an abso- + lute path; however, build.sh allows it to be a simple + command name, which will be converted to an absolute + path by searching the PATH. HOST_CC Path name to C compiler used to create the toolchain. @@ -198,7 +204,7 @@ CONFIGURATION MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor- matted plaintext manual pages will be created during a build. - Default: ``yes'' + Default: ``no'' MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto- graphic code will be included in a build; provided for the @@ -236,6 +242,11 @@ CONFIGURATION Default: ``yes'' + MKKMOD Can be set to ``yes'' or ``no''. Indicates whether kernel + modules are built and installed. + + Default: ``yes'' + MKLINT Can be set to ``yes'' or ``no''. Indicates whether lint(1) will be run against portions of the NetBSD source code during the build, and whether lint libraries will be installed into @@ -287,6 +298,12 @@ CONFIGURATION by default at times due to toolchain problems with profiled code. + MKREPRO Can be set to ``yes'' or ``no''. Create reproducable builds. + This enables different switches to make two builds from the + same source tree result in the same build results. + + Default: ``no'' + MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files destined to reside in DESTDIR/usr/share will be built and installed during a build. If set to ``no'', then all of @@ -296,9 +313,9 @@ 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). + Can be set to ``yes'' or ``no''. Indicates whether RCS IDs, + for use with ident(1), should be stripped from program bina- + ries and shared libraries. Default: ``no'' @@ -530,18 +547,18 @@ BUILDING 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. + The INSTALLSETS environment variable may be set to a space- + separated 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). + update files in INSTALLWORLDDIR/etc, and postinstall(8) to + check for or fix inconsistencies. sets Create distribution sets from DESTDIR into RELEASEDIR/RELEASEMACHINEDIR/binary/sets. Should be run @@ -615,6 +632,43 @@ BUILDING ity, which is not part of NetBSD, but which can be installed from pkgsrc/sysutils/cdrtools. + install-image + Create a bootable NetBSD installation disk image in the + RELEASEDIR/RELEASEMACHINEDIR/installation/installimage + directory. The installation disk image is suitable for + copying to bootable USB flash memory sticks, etc., for + machines which are able to boot from such devices. The + file system in the bootable disk image will have a layout + as described in release(7). + + The installation image is bootable, and will automatically + run the sysinst(8) menu-based installation program, which + can be used to install or upgrade a NetBSD system. The + image also contains tools that may be useful in repairing a + damaged NetBSD installation. + + Before ``make install-image'' is attempted, RELEASEDIR must + be populated by ``make release'' or equivalent. The build + must have been performed with MKUNPRIVED=yes because ``make + install-image'' relies on information in DESTDIR/METALOG. + + live-image Create NetBSD live images in the + RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage direc- + tory. The live image contains all necessary files to boot + NetBSD up to multi-user mode, including all files which + should be extracted during installation, NetBSD disklabel, + bootloaders, etc. + + The live image is suitable for use as a disk image in vir- + tual machine environments such as QEMU, and also useful to + boot NetBSD from a USB flash memory stick on a real + machine, without the need for installation. + + Before ``make live-image'' is attempted, RELEASEDIR must be + populated by ``make release'' or equivalent. The build + must have been performed with MKUNPRIVED=yes because ``make + install-image'' relies on information in DESTDIR/METALOG. + regression-tests Can only be run after building the regression tests in the directory ``regress''. Runs those compiled regression @@ -623,11 +677,31 @@ BUILDING those as well but currently does not. The "build.sh" script - This script file is a Bourne shell script designed to build the entire - NetBSD system on any host with a Bourne shell in /bin/sh, including many - that are not POSIX compliant. Note that if a host system's /bin/sh is - unusually old and broken, the Korn Shell (/bin/ksh), if available, may be - a usable alternative. + This script file is a shell script designed to build the entire NetBSD + system on any host with a suitable modern shell and some common utili- + ties. The required shell features are described under the HOST_SH vari- + able. + + If a host system's default shell does support the required features, then + we suggest that you explicitly specify a suitable shell using a command + like + + /path/to/suitable/shell build.sh [options] + + The above command will usually enable build.sh to automatically set + HOST_SH=/path/to/suitable/shell, but if that fails, then the following + set of commands may be used instead: + + HOST_SH=/path/to/suitable/shell + export HOST_SH + ${HOST_SH} build.sh [options] + + If build.sh detects that it is being executed under an unsuitable shell, + it attempts to exec a suitable shell instead, or prints an error message. + If HOST_SH is not set explicitly, then build.sh sets a default using + heuristics dependent on the host platform, or from the shell under which + build.sh is executed (if that can be determined), or using the first copy + of sh found in PATH. All cross-compile builds, and most native builds, of the entire system should make use of build.sh rather than just running ``make''. This way, @@ -667,7 +741,8 @@ BUILDING install=idir Install the contents of DESTDIR to idir, using ``make installworld''. Note that files that are part of the - ``etc'' or ``xetc'' sets will not be installed. + ``etc'' or ``xetc'' sets will not be installed, unless + overridden by the INSTALLSETS environment variable. kernel=kconf Build a new kernel. The kconf argument is the name of a configuration file suitable for use by config(1). If kconf @@ -705,6 +780,11 @@ BUILDING iso-image-source Perform ``make iso-image-source''. + install-image + Perform ``make install-image''. + + live-image Perform ``make live-image''. + The following command line options alter the behaviour of the build.sh operations described above: @@ -922,4 +1002,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. -NetBSD September 9, 2011 NetBSD +NetBSD September 19, 2012 NetBSD