[BACK]Return to BUILDING CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src

Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.

Diff for /src/BUILDING between version 1.96.2.4 and 1.102

version 1.96.2.4, 2014/05/22 13:23:26 version 1.102, 2012/09/19 23:40:03
Line 1 
Line 1 
 BUILDING(8)                 System Manager's Manual                BUILDING(8)  BUILDING(8)             NetBSD System Manager's Manual             BUILDING(8)
   
 NAME  NAME
      BUILDING -- Procedure for building NetBSD from source code.       BUILDING -- Procedure for building NetBSD from source code.
Line 43  FILES
Line 43  FILES
                     recompiled regularly.                      recompiled regularly.
   
      crypto/dist/, dist/, gnu/dist/       crypto/dist/, dist/, gnu/dist/
                     Sources imported verbatim from third parties, without                      Sources imported verbatim from third parties, without man-
                     mangling the existing build structure.  Other source trees                      gling the existing build structure.  Other source trees in
                     in bin through usr.sbin use the NetBSD make(1)                      bin through usr.sbin use the NetBSD make(1) ``reachover''
                     ``reachover'' Makefile semantics when building these                      Makefile semantics when building these programs for a
                     programs for a native host.                      native host.
   
      distrib/, etc/       distrib/, etc/
                     Sources for items used when making a full release                      Sources for items used when making a full release snap-
                     snapshot, such as files installed in DESTDIR/etc on the                      shot, such as files installed in DESTDIR/etc on the desti-
                     destination system, boot media, and release notes.                      nation system, boot media, and release notes.
   
      tests/, regress/       tests/, regress/
                     Regression test harness.  Can be cross-compiled, but only                      Regression test harness.  Can be cross-compiled, but only
Line 63  FILES
Line 63  FILES
      sys/           NetBSD kernel sources.       sys/           NetBSD kernel sources.
   
      tools/         ``Reachover'' build structure for the host build tools.       tools/         ``Reachover'' build structure for the host build tools.
                     This has a special method of determining out-of-date                      This has a special method of determining out-of-date sta-
                     status.                      tus.
   
      bin/ ... usr.sbin/       bin/ ... usr.sbin/
                     Sources to the NetBSD userland (non-kernel) programs.  If                      Sources to the NetBSD userland (non-kernel) programs.  If
Line 87  CONFIGURATION
Line 87  CONFIGURATION
                        system requires a modern Bourne-like shell with POSIX-                         system requires a modern Bourne-like shell with POSIX-
                        compliant features, and also requires support for the                         compliant features, and also requires support for the
                        ``local'' keyword to declare local variables in shell                         ``local'' keyword to declare local variables in shell
                        functions (which is a widely-implemented but non-                         functions (which is a widely-implemented but non-stan-
                        standardised feature).                         dardised feature).
   
                        Depending on the host system, a suitable shell may be                         Depending on the host system, a suitable shell may be
                        /bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a                         /bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a
                        variant of ksh that supports the ``local'' keyword,                         variant of ksh that supports the ``local'' keyword,
                        such as ksh88, but not ksh93), or /usr/local/bin/bash.                         such as ksh88, but not ksh93), or /usr/local/bin/bash.
   
                        Most parts of the build require HOST_SH to be an                         Most parts of the build require HOST_SH to be an abso-
                        absolute path; however, build.sh allows it to be a                         lute path; however, build.sh allows it to be a simple
                        simple command name, which will be converted to an                         command name, which will be converted to an absolute
                        absolute path by searching the PATH.                         path by searching the PATH.
   
      HOST_CC           Path name to C compiler used to create the toolchain.       HOST_CC           Path name to C compiler used to create the toolchain.
   
Line 111  CONFIGURATION
Line 111  CONFIGURATION
      MAKE              Path name to invoke make(1) as.       MAKE              Path name to invoke make(1) as.
   
      MAKEFLAGS         Flags to invoke make(1) with.  Note that build.sh       MAKEFLAGS         Flags to invoke make(1) with.  Note that build.sh
                        ignores the value of MAKEFLAGS passed in the                         ignores the value of MAKEFLAGS passed in the environ-
                        environment, but allows MAKEFLAGS to be set via the -V                         ment, but allows MAKEFLAGS to be set via the -V option.
                        option.  
        MAKEOBJDIR        Directory to use as the .OBJDIR for the current direc-
      MAKEOBJDIR        Directory to use as the .OBJDIR for the current                         tory.  The value is subjected to variable expansion by
                        directory.  The value is subjected to variable                         make(1).  Typical usage is to set this variable to a
                        expansion by make(1).  Typical usage is to set this                         value involving the use of `${.CURDIR:S...}' or
                        variable to a value involving the use of                         `${.CURDIR:C...}', to derive the value of .OBJDIR from
                        `${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the                         the value of .CURDIR.  Used only if MAKEOBJDIRPREFIX is
                        value of .OBJDIR from the value of .CURDIR.  Used only                         not defined.  MAKEOBJDIR can be provided only in the
                        if MAKEOBJDIRPREFIX is not defined.  MAKEOBJDIR can be                         environment or via the -O flag of build.sh; it cannot
                        provided only in the environment or via the -O flag of                         usefully be set inside a Makefile, including mk.conf or
                        build.sh; it cannot usefully be set inside a Makefile,                         ${MAKECONF}.
                        including mk.conf or ${MAKECONF}.  
   
      MAKEOBJDIRPREFIX  Top level directory of the object directory tree.  The       MAKEOBJDIRPREFIX  Top level directory of the object directory tree.  The
                        value is subjected to variable expansion by make(1).                         value is subjected to variable expansion by make(1).
Line 132  CONFIGURATION
Line 131  CONFIGURATION
                        if necessary, but if make(1) is used without build.sh,                         if necessary, but if make(1) is used without build.sh,
                        then rules in <bsd.obj.mk> will abort the build if the                         then rules in <bsd.obj.mk> will abort the build if the
                        ${MAKEOBJDIRPREFIX} directory does not exist.  If the                         ${MAKEOBJDIRPREFIX} directory does not exist.  If the
                        value is defined and valid, then                         value is defined and valid, then ${MAKEOBJDIRPRE-
                        ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the .OBJDIR                         FIX}/${.CURDIR} is used as the .OBJDIR for the current
                        for the current directory.  The current directory may                         directory.  The current directory may be read only.
                        be read only.  MAKEOBJDIRPREFIX can be provided only in                         MAKEOBJDIRPREFIX can be provided only in the environ-
                        the environment or via the -M flag of build.sh; it                         ment or via the -M flag of build.sh; it cannot usefully
                        cannot usefully be set inside a Makefile, including                         be set inside a Makefile, including mk.conf or
                        mk.conf or ${MAKECONF}.                         ${MAKECONF}.
   
    "make" variables     "make" variables
      Several variables control the behavior of NetBSD builds.  Unless       Several variables control the behavior of NetBSD builds.  Unless other-
      otherwise specified, these variables may be set in either the process       wise specified, these variables may be set in either the process environ-
      environment or the make(1) configuration file specified by MAKECONF.       ment or the make(1) configuration file specified by MAKECONF.
   
      BUILDID     Identifier for the build.  The identifier will be appended to       BUILDID     Identifier for the build.  The identifier will be appended to
                  object directory names, and can be consulted in the make(1)                   object directory names, and can be consulted in the make(1)
                  configuration file in order to set additional build                   configuration file in order to set additional build parame-
                  parameters, such as compiler flags.                   ters, such as compiler flags.
   
      BUILDSEED   GCC uses random numbers when compiling C++ code.  This       BUILDSEED   GCC uses random numbers when compiling C++ code.  This vari-
                  variable seeds the gcc random number generator using the                   able seeds the gcc random number generator using the -fran-
                  -frandom-seed flag with this value.  By default, it is set to                   dom-seed flag with this value.  By default, it is set to
                  NetBSD-(majorversion).  Using a fixed value causes C++                   NetBSD-(majorversion).  Using a fixed value causes C++ bina-
                  binaries to be the same when built from the same sources,                   ries to be the same when built from the same sources, result-
                  resulting in identical (reproducible) builds.  Additional                   ing in identical (reproducible) builds.  Additional informa-
                  information is available in the GCC documentation of                   tion is available in the GCC documentation of -frandom-seed.
                  -frandom-seed.  
        DESTDIR     Directory to contain the built NetBSD system.  If set, spe-
      DESTDIR     Directory to contain the built NetBSD system.  If set,                   cial options are passed to the compilation tools to prevent
                  special options are passed to the compilation tools to                   their default use of the host system's /usr/include,
                  prevent their default use of the host system's /usr/include,  
                  /usr/lib, and so forth.  This pathname must be an absolute                   /usr/lib, and so forth.  This pathname must be an absolute
                  path, and should not end with a slash (/) character.  (For                   path, and should not end with a slash (/) character.  (For
                  installation into the system's root directory, set DESTDIR to                   installation into the system's root directory, set DESTDIR to
                  an empty string, not to ``/'').  The directory must reside on                   an empty string, not to ``/'').  The directory must reside on
                  a file system which supports long file names and hard links.                   a file system which supports long file names and hard links.
   
                  Default: Empty string if USETOOLS is ``yes''; unset                   Default: Empty string if USETOOLS is ``yes''; unset other-
                  otherwise.                   wise.
   
                  Note: build.sh will provide a default of destdir.MACHINE (in                   Note: build.sh will provide a default of destdir.MACHINE (in
                  the top-level .OBJDIR) unless run in `expert' mode.                   the top-level .OBJDIR) unless run in `expert' mode.
Line 186  CONFIGURATION
Line 184  CONFIGURATION
                       are shown.                        are shown.
   
                  1    Brief messages are shown describing what is being done,                   1    Brief messages are shown describing what is being done,
                       but the actual commands executed by make(1) are not                        but the actual commands executed by make(1) are not dis-
                       displayed.                        played.
   
                  2    Descriptive messages are shown as above (prefixed with a                   2    Descriptive messages are shown as above (prefixed with a
                       `#'), and ordinary commands performed by make(1) are                        `#'), and ordinary commands performed by make(1) are
Line 203  CONFIGURATION
Line 201  CONFIGURATION
   
                  Default: 2                   Default: 2
   
      MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether       MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether prefor-
                  preformatted plaintext manual pages will be created during a                   matted plaintext manual pages will be created during a build.
                  build.  
   
                  Default: ``no''                   Default: ``yes''
   
      MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether       MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether crypto-
                  cryptographic code will be included in a build; provided for                   graphic code will be included in a build; provided for the
                  the benefit of countries that do not allow strong                   benefit of countries that do not allow strong cryptography.
                  cryptography.  Will not affect use of the standard low-                   Will not affect use of the standard low-security password
                  security password encryption system, crypt(3).                   encryption system, crypt(3).
   
                  Default: ``yes''                   Default: ``yes''
   
Line 223  CONFIGURATION
Line 220  CONFIGURATION
   
                  Default: ``yes''                   Default: ``yes''
   
      MKHTML      Can be set to ``yes'' or ``no''.  Indicates whether       MKHTML      Can be set to ``yes'' or ``no''.  Indicates whether prefor-
                  preformatted HTML manual pages will be built and installed                   matted HTML manual pages will be built and installed
   
                  Default: ``yes''                   Default: ``yes''
   
Line 283  CONFIGURATION
Line 280  CONFIGURATION
                  build.  If set to ``no'', the entire built system will be                   build.  If set to ``no'', the entire built system will be
                  statically linked.                   statically linked.
   
                  Default: Platform dependent.  As of this writing, all                   Default: Platform dependent.  As of this writing, all plat-
                  platforms except sh3 default to ``yes''.                   forms except sh3 default to ``yes''.
   
      MKPICINSTALL       MKPICINSTALL
                  Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)                   Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)
Line 317  CONFIGURATION
Line 314  CONFIGURATION
   
      MKSTRIPIDENT       MKSTRIPIDENT
                  Can be set to ``yes'' or ``no''.  Indicates whether RCS IDs,                   Can be set to ``yes'' or ``no''.  Indicates whether RCS IDs,
                  for use with ident(1), should be stripped from program                   for use with ident(1), should be stripped from program bina-
                  binaries and shared libraries.                   ries and shared libraries.
   
                  Default: ``no''                   Default: ``no''
   
      MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an       MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an
                  unprivileged install will occur.  The user, group,                   unprivileged install will occur.  The user, group, permis-
                  permissions, and file flags, will not be set on the installed                   sions, and file flags, will not be set on the installed
                  items; instead the information will be appended to a file                   items; instead the information will be appended to a file
                  called METALOG in DESTDIR.  The contents of METALOG are used                   called METALOG in DESTDIR.  The contents of METALOG are used
                  during the generation of the distribution tar files to ensure                   during the generation of the distribution tar files to ensure
Line 347  CONFIGURATION
Line 344  CONFIGURATION
   
      TOOLDIR     Directory to hold the host tools, once built.  If specified,       TOOLDIR     Directory to hold the host tools, once built.  If specified,
                  must be an absolute path.  This directory should be unique to                   must be an absolute path.  This directory should be unique to
                  a given host system and NetBSD source tree.  (However,                   a given host system and NetBSD source tree.  (However, multi-
                  multiple targets may share the same TOOLDIR; the target-                   ple targets may share the same TOOLDIR; the target-dependent
                  dependent files have unique names.)  If unset, a default                   files have unique names.)  If unset, a default based on the
                  based on the uname(1) information of the host platform will                   uname(1) information of the host platform will be created in
                  be created in the .OBJDIR of src.                   the .OBJDIR of src.
   
                  Default: Unset.                   Default: Unset.
   
Line 366  CONFIGURATION
Line 363  CONFIGURATION
                         specific for that tool.                          specific for that tool.
   
                  never  Do not use the tools from TOOLDIR, even when building                   never  Do not use the tools from TOOLDIR, even when building
                         native tool components.  This is similar to the                          native tool components.  This is similar to the tradi-
                         traditional NetBSD build method, but does not verify                          tional NetBSD build method, but does not verify that
                         that the compilation tools in use are up-to-date                          the compilation tools in use are up-to-date enough in
                         enough in order to build the tree successfully.  This                          order to build the tree successfully.  This may cause
                         may cause build or runtime problems when building the                          build or runtime problems when building the whole
                         whole NetBSD source tree.                          NetBSD source tree.
   
                  Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''.                   Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''.
   
Line 409  CONFIGURATION
Line 406  CONFIGURATION
                       If using build.sh, the default is ``yes''.  This may be                        If using build.sh, the default is ``yes''.  This may be
                       set back to ``no'' by giving build.sh the -o option.                        set back to ``no'' by giving build.sh the -o option.
   
      MKUPDATE         Can be set to ``yes'' or ``no''.  If set, then in       MKUPDATE         Can be set to ``yes'' or ``no''.  If set, then in addi-
                       addition to the effects described for MKUPDATE=yes                        tion to the effects described for MKUPDATE=yes above,
                       above, this implies the effects of NOCLEANDIR (i.e.,                        this implies the effects of NOCLEANDIR (i.e., ``make
                       ``make cleandir'' is avoided).                        cleandir'' is avoided).
   
                       Default: ``no''                        Default: ``no''
   
Line 469  BUILDING
Line 466  BUILDING
                 use .WAIT or have explicit dependencies as necessary to                  use .WAIT or have explicit dependencies as necessary to
                 enforce build ordering.                  enforce build ordering.
   
      -m dir     Specify the default directory for searching for system       -m dir     Specify the default directory for searching for system Make-
                 Makefile segments, mainly the <bsd.*.mk> files.  When building                  file segments, mainly the <bsd.*.mk> files.  When building any
                 any full NetBSD source tree, this should be set to the                  full NetBSD source tree, this should be set to the
                 ``share/mk'' directory in the source tree.  This is set                  ``share/mk'' directory in the source tree.  This is set auto-
                 automatically when building from the top level, or when using                  matically when building from the top level, or when using
                 build.sh.                  build.sh.
   
      -n         Display the commands that would have been executed, but do not       -n         Display the commands that would have been executed, but do not
Line 483  BUILDING
Line 480  BUILDING
      -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.                  targets.
   
      var=value  Set the variable var to value, overriding any setting       var=value  Set the variable var to value, overriding any setting speci-
                 specified by the process environment, the MAKECONF                  fied by the process environment, the MAKECONF configuration
                 configuration file, or the system Makefile segments.                  file, or the system Makefile segments.
   
    "make" targets     "make" targets
      These default targets may be built by running make(1) in any subtree of       These default targets may be built by running make(1) in any subtree of
Line 547  BUILDING
Line 544  BUILDING
   
      installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR,       installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR,
                    which defaults to the root directory.  Ensures that                     which defaults to the root directory.  Ensures that
                    INSTALLWORLDDIR is not the root directory if cross                     INSTALLWORLDDIR is not the root directory if cross compil-
                    compiling.                     ing.
   
                    The INSTALLSETS environment variable may be set to a space-                     The INSTALLSETS environment variable may be set to a space-
                    separated list of distribution sets to be installed.  By                     separated list of distribution sets to be installed.  By
Line 587  BUILDING
Line 584  BUILDING
                    a layout as described in release(7).                     a layout as described in release(7).
   
                    For most machine types, the CD-ROM will be bootable, and                     For most machine types, the CD-ROM will be bootable, and
                    will automatically run the sysinst(8) menu-based                     will automatically run the sysinst(8) menu-based installa-
                    installation program, which can be used to install or                     tion program, which can be used to install or upgrade a
                    upgrade a NetBSD system.  Bootable CD-ROMs also contain                     NetBSD system.  Bootable CD-ROMs also contain tools that
                    tools that may be useful in repairing a damaged NetBSD                     may be useful in repairing a damaged NetBSD installation.
                    installation.  
   
                    Before ``make iso-image'' is attempted, RELEASEDIR must be                     Before ``make iso-image'' is attempted, RELEASEDIR must be
                    populated by ``make release'' or equivalent.                     populated by ``make release'' or equivalent.
   
                    Note that other, smaller, CD-ROM images may be created in                     Note that other, smaller, CD-ROM images may be created in
                    the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom                     the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc-
                    directory by ``make release''.  These smaller images                     tory by ``make release''.  These smaller images usually
                    usually contain the same tools as the larger images in                     contain the same tools as the larger images in
                    RELEASEDIR/iso, but do not contain additional content such                     RELEASEDIR/iso, but do not contain additional content such
                    as the distribution sets.                     as the distribution sets.
   
                    Note that the mac68k port still uses an older method of                     Note that the mac68k port still uses an older method of
                    creating CD-ROM images.  This requires the mkisofs(1)                     creating CD-ROM images.  This requires the mkisofs(1) util-
                    utility, which is not part of NetBSD, but which can be                     ity, which is not part of NetBSD, but which can be
                    installed from pkgsrc/sysutils/cdrtools.                     installed from pkgsrc/sysutils/cdrtools.
   
      iso-image-source       iso-image-source
Line 615  BUILDING
Line 611  BUILDING
                    level directories for the machine type and source.                     level directories for the machine type and source.
   
                    For most machine types, the CD-ROM will be bootable, and                     For most machine types, the CD-ROM will be bootable, and
                    will automatically run the sysinst(8) menu-based                     will automatically run the sysinst(8) menu-based installa-
                    installation program, which can be used to install or                     tion program, which can be used to install or upgrade a
                    upgrade a NetBSD system.  Bootable CD-ROMs also contain                     NetBSD system.  Bootable CD-ROMs also contain tools that
                    tools that may be useful in repairing a damaged NetBSD                     may be useful in repairing a damaged NetBSD installation.
                    installation.  
   
                    Before ``make iso-image-source'' is attempted, RELEASEDIR                     Before ``make iso-image-source'' is attempted, RELEASEDIR
                    must be populated by ``make sourcesets release'' or                     must be populated by ``make sourcesets release'' or equiva-
                    equivalent.                     lent.
   
                    Note that other, smaller, CD-ROM images may be created in                     Note that other, smaller, CD-ROM images may be created in
                    the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom                     the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc-
                    directory by ``make release''.  These smaller images                     tory by ``make release''.  These smaller images usually
                    usually contain the same tools as the larger images in                     contain the same tools as the larger images in
                    RELEASEDIR/iso, but do not contain additional content such                     RELEASEDIR/iso, but do not contain additional content such
                    as the distribution sets.                     as the distribution sets.
   
                    Note that the mac68k port still uses an older method of                     Note that the mac68k port still uses an older method of
                    creating CD-ROM images.  This requires the mkisofs(1)                     creating CD-ROM images.  This requires the mkisofs(1) util-
                    utility, which is not part of NetBSD, but which can be                     ity, which is not part of NetBSD, but which can be
                    installed from pkgsrc/sysutils/cdrtools.                     installed from pkgsrc/sysutils/cdrtools.
   
      install-image       install-image
Line 658  BUILDING
Line 653  BUILDING
                    install-image'' relies on information in DESTDIR/METALOG.                     install-image'' relies on information in DESTDIR/METALOG.
   
      live-image    Create NetBSD live images in the       live-image    Create NetBSD live images in the
                    RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage                     RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage direc-
                    directory.  The live image contains all necessary files to                     tory.  The live image contains all necessary files to boot
                    boot NetBSD up to multi-user mode, including all files                     NetBSD up to multi-user mode, including all files which
                    which should be extracted during installation, NetBSD                     should be extracted during installation, NetBSD disklabel,
                    disklabel, bootloaders, etc.                     bootloaders, etc.
   
                    The live image is suitable for use as a disk image in                     The live image is suitable for use as a disk image in vir-
                    virtual machine environments such as QEMU, and also useful                     tual machine environments such as QEMU, and also useful to
                    to boot NetBSD from a USB flash memory stick on a real                     boot NetBSD from a USB flash memory stick on a real
                    machine, without the need for installation.                     machine, without the need for installation.
   
                    Before ``make live-image'' is attempted, RELEASEDIR must be                     Before ``make live-image'' is attempted, RELEASEDIR must be
Line 677  BUILDING
Line 672  BUILDING
      regression-tests       regression-tests
                    Can only be run after building the regression tests in the                     Can only be run after building the regression tests in the
                    directory ``regress''.  Runs those compiled regression                     directory ``regress''.  Runs those compiled regression
                    tests on the local host.  Note that most tests are now                     tests on the local host.  Note that most tests are now man-
                    managed instead using atf(7); this target should probably                     aged instead using atf(7); this target should probably run
                    run those as well but currently does not.                     those as well but currently does not.
   
    The "build.sh" script     The "build.sh" script
      This script file is a shell script designed to build the entire NetBSD       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       system on any host with a suitable modern shell and some common utili-
      utilities.  The required shell features are described under the HOST_SH       ties.  The required shell features are described under the HOST_SH vari-
      variable.       able.
   
      If a host system's default shell does support the required features, then       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       we suggest that you explicitly specify a suitable shell using a command
Line 710  BUILDING
Line 705  BUILDING
   
      All cross-compile builds, and most native builds, of the entire system       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,       should make use of build.sh rather than just running ``make''.  This way,
      the make(1) program will be bootstrapped properly, in case the host       the make(1) program will be bootstrapped properly, in case the host sys-
      system has an older or incompatible ``make'' program.       tem has an older or incompatible ``make'' program.
   
      When compiling the entire system via build.sh, many make(1) variables are       When compiling the entire system via build.sh, many make(1) variables are
      set for you in order to help encapsulate the build process.  In the list       set for you in order to help encapsulate the build process.  In the list
Line 732  BUILDING
Line 727  BUILDING
      release       Build a full release as per ``make release''.  This command       release       Build a full release as per ``make release''.  This command
                    first runs the distribution operation.                     first runs the distribution operation.
   
      makewrapper   Create the nbmake-MACHINE wrapper.  This operation is       makewrapper   Create the nbmake-MACHINE wrapper.  This operation is auto-
                    automatically performed for any of the other operations.                     matically performed for any of the other operations.
   
      cleandir      Perform ``make cleandir''.       cleandir      Perform ``make cleandir''.
   
      obj           Perform ``make obj''.       obj           Perform ``make obj''.
   
      tools         Build and install the host tools from src/tools.  This       tools         Build and install the host tools from src/tools.  This com-
                    command will first run ``make obj'' and ``make cleandir''                     mand will first run ``make obj'' and ``make cleandir'' in
                    in the tools subdirectory unless the -o or -u options                     the tools subdirectory unless the -o or -u options (respec-
                    (respectively) are given.                     tively) are given.
   
      install=idir  Install the contents of DESTDIR to idir, using ``make       install=idir  Install the contents of DESTDIR to idir, using ``make
                    installworld''.  Note that files that are part of the                     installworld''.  Note that files that are part of the
Line 771  BUILDING
Line 766  BUILDING
                    Install a gzip(1)ed copy of the kernel previously built by                     Install a gzip(1)ed copy of the kernel previously built by
                    kernel=kconf into                     kernel=kconf into
                    RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as                     RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as
                    netbsd-kconf.gz, although the ``netbsd'' prefix is                     netbsd-kconf.gz, although the ``netbsd'' prefix is deter-
                    determined from the ``config'' directives in kconf.                     mined from the ``config'' directives in kconf.
   
      sets          Perform ``make sets''.       sets          Perform ``make sets''.
   
Line 802  BUILDING
Line 797  BUILDING
                ``nbmake-MACHINE-BUILDID''.                 ``nbmake-MACHINE-BUILDID''.
   
      -C cdextras       -C cdextras
                Append cdextras to the CDEXTRA variable, which is a space-                 Append cdextras to the CDEXTRA variable, which is a space-sepa-
                separated list of files or directories that will be added to                 rated list of files or directories that will be added to the
                the CD-ROM image that may be create by the ``iso-image'' or                 CD-ROM image that may be create by the ``iso-image'' or
                ``iso-image-source'' operations.  Files will be added to the                 ``iso-image-source'' operations.  Files will be added to the
                root of the CD-ROM image, whereas directories will be copied                 root of the CD-ROM image, whereas directories will be copied
                recursively.  If relative paths are specified, they will be                 recursively.  If relative paths are specified, they will be
Line 812  BUILDING
Line 807  BUILDING
                may be specified via multiple -C options, or via a single                 may be specified via multiple -C options, or via a single
                option whose argument contains multiple space-separated paths.                 option whose argument contains multiple space-separated paths.
   
      -D dest   Set the value of DESTDIR to dest.  If a relative path is       -D dest   Set the value of DESTDIR to dest.  If a relative path is speci-
                specified, it will be converted to an absolute path before                 fied, it will be converted to an absolute path before being
                being used.                 used.
   
      -E        Set `expert' mode.  This overrides various sanity checks, and       -E        Set `expert' mode.  This overrides various sanity checks, and
                allows: DESTDIR does not have to be set to a non-root path for                 allows: DESTDIR does not have to be set to a non-root path for
                builds, and MKUNPRIVED=yes does not have to be set when                 builds, and MKUNPRIVED=yes does not have to be set when build-
                building as a non-root user.                 ing as a non-root user.
   
                Note: It is highly recommended that you know what you are doing                 Note: It is highly recommended that you know what you are doing
                when you use this option.                 when you use this option.
Line 828  BUILDING
Line 823  BUILDING
   
      -j njob   Run up to njob make(1) subjobs in parallel; passed through to       -j njob   Run up to njob make(1) subjobs in parallel; passed through to
                make(1).  If you see failures for reasons other than running                 make(1).  If you see failures for reasons other than running
                out of memory while using build.sh with -j, please save                 out of memory while using build.sh with -j, please save com-
                complete build logs so the failures can be analyzed.                 plete build logs so the failures can be analyzed.
   
                To achieve the fastest builds, -j values between (1 + the                 To achieve the fastest builds, -j values between (1 + the num-
                number of CPUs) and (2 * the number of CPUs) are recommended.                 ber of CPUs) and (2 * the number of CPUs) are recommended.  Use
                Use lower values on machines with limited memory or I/O                 lower values on machines with limited memory or I/O bandwidth.
                bandwidth.  
   
      -M obj    Set MAKEOBJDIRPREFIX to obj.  Unsets MAKEOBJDIR.  See ``-O       -M obj    Set MAKEOBJDIRPREFIX to obj.  Unsets MAKEOBJDIR.  See ``-O
                -obj'' for more information.                 -obj'' for more information.
Line 845  BUILDING
Line 839  BUILDING
                /usr/obj/usr/src/usr.bin, and so forth.                 /usr/obj/usr/src/usr.bin, and so forth.
   
                If a relative path is specified, it will be converted to an                 If a relative path is specified, it will be converted to an
                absolute path before being used.  build.sh imposes the                 absolute path before being used.  build.sh imposes the restric-
                restriction that the argument to the -M option must not begin                 tion that the argument to the -M option must not begin with a
                with a ``$'' (dollar sign) character; otherwise it would be too                 ``$'' (dollar sign) character; otherwise it would be too diffi-
                difficult to determine whether the value is an absolute or a                 cult to determine whether the value is an absolute or a rela-
                relative path.  If the directory does not already exist,                 tive path.  If the directory does not already exist, build.sh
                build.sh will create it.                 will create it.
   
      -m mach   Set the value of MACHINE to mach, except in some special cases       -m mach   Set the value of MACHINE to mach, except in some special cases
                listed below.  This will also override any value of                 listed below.  This will also override any value of
Line 894  BUILDING
Line 888  BUILDING
                and so forth.                 and so forth.
   
                If a relative path is specified, it will be converted to an                 If a relative path is specified, it will be converted to an
                absolute path before being used.  build.sh imposes the                 absolute path before being used.  build.sh imposes the restric-
                restriction that the argument to the -O option must not contain                 tion that the argument to the -O option must not contain a
                a ``$'' (dollar sign) character.  If the directory does not                 ``$'' (dollar sign) character.  If the directory does not
                already exist, build.sh will create it.                 already exist, build.sh will create it.
   
                In normal use, exactly one of the -M or -O options should be                 In normal use, exactly one of the -M or -O options should be
Line 922  BUILDING
Line 916  BUILDING
      -S seed   Change the value of BUILDSEED to seed.  This should rarely be       -S seed   Change the value of BUILDSEED to seed.  This should rarely be
                necessary.                 necessary.
   
      -T tools  Set the value of TOOLDIR to tools.  If a relative path is       -T tools  Set the value of TOOLDIR to tools.  If a relative path is spec-
                specified, it will be converted to an absolute path before                 ified, it will be converted to an absolute path before being
                being used.  If set, the bootstrap ``make'' will only be                 used.  If set, the bootstrap ``make'' will only be rebuilt if
                rebuilt if the source files for make(1) have changed.                 the source files for make(1) have changed.
   
      -U        Set MKUNPRIVED=yes.       -U        Set MKUNPRIVED=yes.
   
Line 936  BUILDING
Line 930  BUILDING
                propagated to the nbmake wrapper.                 propagated to the nbmake wrapper.
   
      -w wrapper       -w wrapper
                Create the nbmake wrapper script (see below) in a custom                 Create the nbmake wrapper script (see below) in a custom loca-
                location, specified by wrapper.  This allows, for instance, to                 tion, specified by wrapper.  This allows, for instance, to
                place the wrapper in PATH automatically.  Note that wrapper is                 place the wrapper in PATH automatically.  Note that wrapper is
                the full name of the file, not just a directory name.  If a                 the full name of the file, not just a directory name.  If a
                relative path is specified, it will be converted to an absolute                 relative path is specified, it will be converted to an absolute
Line 959  BUILDING
Line 953  BUILDING
      subtrees on a cross-compile host.       subtrees on a cross-compile host.
   
      nbmake-MACHINE can be invoked in lieu of make(1), and will instead call       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       the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with sev-
      several key variables pre-set, including MACHINE, MACHINE_ARCH, and       eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR.
      TOOLDIR.  nbmake-MACHINE will also set variables specified with -V, and       nbmake-MACHINE will also set variables specified with -V, and unset vari-
      unset variables specified with -Z.       ables specified with -Z.
   
      This script can be symlinked into a directory listed in PATH, or called       This script can be symlinked into a directory listed in PATH, or called
      with an absolute path.       with an absolute path.
Line 981  EXAMPLES
Line 975  EXAMPLES
      3.   # ./build.sh [options] -U install=/       3.   # ./build.sh [options] -U install=/
   
           As root, install to / the distribution that was built by example 2.            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            Even though this is run as root, -U is required so that the permis-
           permissions stored in DESTDIR/METALOG are correctly applied to the            sions stored in DESTDIR/METALOG are correctly applied to the files
           files as they're copied to /.            as they're copied to /.
   
      4.   % ./build.sh [options] -U -u release       4.   % ./build.sh [options] -U -u release
   
Line 1008  HISTORY
Line 1002  HISTORY
      The build.sh based build scheme was introduced for NetBSD 1.6 as       The build.sh based build scheme was introduced for NetBSD 1.6 as
      USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.       USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.
   
 NetBSD                         November 8, 2012                         NetBSD  NetBSD                        September 19, 2012                        NetBSD

Legend:
Removed from v.1.96.2.4  
changed lines
  Added in v.1.102

CVSweb <webmaster@jp.NetBSD.org>