[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.21 and 1.100

version 1.21, 2003/01/04 12:55:32 version 1.100, 2012/05/25 10:47:25
Line 1 
Line 1 
 BUILDING(8)             NetBSD System Manager's Manual             BUILDING(8)  BUILDING(8)                 System Manager's Manual                BUILDING(8)
   
 NAME  NNAAMMEE
      BUILDING - Procedure for building NetBSD from source code.       BBUUIILLDDIINNGG -- Procedure for building NetBSD from source code.
   
 STATUS  RREEQQUUIIRREEMMEENNTTSS
      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 im-  
      plementation 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 <bsd.own.mk>.  
      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.       NetBSD is designed to be buildable on most POSIX-compliant host systems.
      The basic build procedure is the same whether compiling natively (on the       The basic build procedure is the same whether compiling _n_a_t_i_v_e_l_y (on the
      same NetBSD architecture) or cross compiling (on another architecture or       same NetBSD architecture) or _c_r_o_s_s _c_o_m_p_i_l_i_n_g (on another architecture or
      OS).       OS).
   
      This source tree contains a special subtree, ``tools'', which uses the       This source tree contains a special subtree, ``tools'', which uses the
      host system to create a build toolchain for the target architecture.  The       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       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       toolchain (mmaakkee 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.)
            Note: A couple host toolchain components are not yet available in  
            the tools directory.  Also, some tools use non-POSIX, non-ANSI C  FFIILLEESS
            extensions and need to be standardized.  As a result, cross-compil-     SSoouurrccee ttrreeee llaayyoouutt
            ing from systems other than NetBSD is not currently supported.       ddoocc//BBUUIILLDDIINNGG..mmddoocc
   
 FILES  
    Source tree layout  
   
      doc/BUILDING.mdoc  
                     This document (in -mdoc troff format; the original copy).                      This document (in -mdoc troff format; the original copy).
   
      BUILDING       This document (in plaintext).       BBUUIILLDDIINNGG       This document (in plaintext).
   
      Makefile       The main Makefile for NetBSD; should only be run for na-       ttoooollss//ccoommppaatt//RREEAADDMMEE
                     tive builds with an appropriately up-to-date version of                      Special notes for cross-hosting a NetBSD build on non-
                       NetBSD platforms.
   
        MMaakkeeffiillee       The main Makefile for NetBSD; should only be run for
                       native builds with an appropriately up-to-date version of
                     NetBSD make(1).  (For building from out-of-date systems or                      NetBSD make(1).  (For building from out-of-date systems or
                     on a non-native host, see the build.sh shell script.)                      on a non-native host, see the bbuuiilldd..sshh shell script.)
   
      UPDATING       Special notes for updating from an earlier revision of       UUPPDDAATTIINNGG       Special notes for updating from an earlier revision of
                     NetBSD.  It is important to read this file before every                      NetBSD.  It is important to read this file before every
                     build of an updated source tree.                      build of an updated source tree.
   
      build.sh       Bourne-compatible shell script used for building the host       bbuuiilldd..sshh       Bourne-compatible shell script used for building the host
                     build tools and the NetBSD system from scratch.  Can be                      build tools and the NetBSD system from scratch.  Can be
                     used for both native and cross builds, and should be used                      used for both native and cross builds, and should be used
                     instead of make(1) for any source tree that is updated and                      instead of make(1) for any source tree that is updated and
                     recompiled regularly.                      recompiled regularly.
   
      crypto/dist/, dist/, gnu/dist/       ccrryyppttoo//ddiisstt//, ddiisstt//, ggnnuu//ddiisstt//
                     Sources imported verbatim from third parties, without man-                      Sources imported verbatim from third parties, without
                     gling the existing build structure.  Other source trees in                      mangling the existing build structure.  Other source trees
                     bin through usr.sbin use the NetBSD make(1) ``reachover''                      in bbiinn through uussrr..ssbbiinn use the NetBSD make(1)
                     Makefile semantics when building these programs for a na-                      ``reachover'' Makefile semantics when building these
                     tive host.                      programs for a native host.
   
      distrib/, etc/       ddiissttrriibb//, eettcc//
                     Sources for items used when making a full release snap-                      Sources for items used when making a full release
                     shot, such as files installed in /etc on the destination                      snapshot, such as files installed in DDEESSTTDDIIRR_/_e_t_c on the
                     system, boot media, and release notes.                      destination system, boot media, and release notes.
   
      regress/       Regression test harness.  Can be cross-compiled, but only       tteessttss//, rreeggrreessss//
                     run natively.                      Regression test harness.  Can be cross-compiled, but only
                       run natively.  _t_e_s_t_s_/ uses the atf(7) test framework;
      sys/           NetBSD kernel sources.                      _r_e_g_r_e_s_s_/ contains older tests that have not yet been
                       migrated to atf(7).
      tools/         ``Reachover'' build structure for the host build tools.  
                     This has a special method of determining out-of-date sta-       ssyyss//           NetBSD kernel sources.
                     tus.  
        ttoooollss//         ``Reachover'' build structure for the host build tools.
                       This has a special method of determining out-of-date
                       status.
   
      bin/ ... usr.sbin/       bbiinn// ...... uussrr..ssbbiinn//
                     Sources to the NetBSD userland (non-kernel) programs.  If                      Sources to the NetBSD userland (non-kernel) programs.  If
                     any of these directories are missing, they will be skipped                      any of these directories are missing, they will be skipped
                     during the build.                      during the build.
   
    Build tree layout       xx1111//           ``Reachover'' build structure for X11R6; the source is in
                       XX1111SSRRCCDDIIRR.
   
      BBuuiilldd ttrreeee llaayyoouutt
      The NetBSD build tree is described in hier(7), and the release layout is       The NetBSD build tree is described in hier(7), and the release layout is
      described in release(7).       described in release(7).
   
 CONFIGURATION  CCOONNFFIIGGUURRAATTIIOONN
    Environment variables     EEnnvviirroonnmmeenntt vvaarriiaabblleess
      Several environment variables control the behaviour of NetBSD builds.       Several environment variables control the behaviour of NetBSD builds.
   
      MACHINE           Machine type.       HHOOSSTT__SSHH           Path name to a shell available on the host system and
                          suitable for use during the build.  The NetBSD build
      MACHINE_ARCH      Machine architecture.                         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-
                          standardised feature).
   
                          Depending on the host system, a suitable shell may be
                          _/_b_i_n_/_s_h, _/_u_s_r_/_x_p_g_4_/_b_i_n_/_s_h, _/_b_i_n_/_k_s_h (provided it is a
                          variant of ksh that supports the ``local'' keyword,
                          such as ksh88, but not ksh93), or _/_u_s_r_/_l_o_c_a_l_/_b_i_n_/_b_a_s_h.
   
                          Most parts of the build require HHOOSSTT__SSHH to be an
                          absolute path; however, bbuuiilldd..sshh allows it to be a
                          simple command name, which will be converted to an
                          absolute path by searching the PPAATTHH.
   
        HHOOSSTT__CCCC           Path name to C compiler used to create the toolchain.
   
        HHOOSSTT__CCXXXX          Path name to C++ compiler used to create the toolchain.
   
        MMAACCHHIINNEE           Machine type, e.g., ``macppc''.
   
        MMAACCHHIINNEE__AARRCCHH      Machine architecture, e.g., ``powerpc''.
   
        MMAAKKEE              Path name to invoke make(1) as.
   
        MMAAKKEEFFLLAAGGSS         Flags to invoke make(1) with.  Note that bbuuiilldd..sshh
                          ignores the value of MMAAKKEEFFLLAAGGSS passed in the
                          environment, but allows MMAAKKEEFFLLAAGGSS to be set via the --VV
                          option.
   
        MMAAKKEEOOBBJJDDIIRR        Directory to use as the ..OOBBJJDDIIRR for the current
                          directory.  The value is subjected to variable
                          expansion by make(1).  Typical usage is to set this
                          variable to a value involving the use of
                          `${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the
                          value of ..OOBBJJDDIIRR from the value of ..CCUURRDDIIRR.  Used only
                          if MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX is not defined.  MMAAKKEEOOBBJJDDIIRR can be
                          provided only in the environment or via the --OO flag of
                          bbuuiilldd..sshh; it cannot usefully be set inside a Makefile,
                          including _m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}.
   
        MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX  Top level directory of the object directory tree.  The
                          value is subjected to variable expansion by make(1).
                          bbuuiilldd..sshh will create the ${MAKEOBJDIRPREFIX} directory
                          if necessary, but if make(1) is used without bbuuiilldd..sshh,
                          then rules in <bsd.obj.mk> will abort the build if the
                          ${MAKEOBJDIRPREFIX} directory does not exist.  If the
                          value is defined and valid, then
                          ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the ..OOBBJJDDIIRR
                          for the current directory.  The current directory may
                          be read only.  MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX can be provided only in
                          the environment or via the --MM flag of bbuuiilldd..sshh; it
                          cannot usefully be set inside a Makefile, including
                          _m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}.
   
      ""mmaakkee"" vvaarriiaabblleess
        Several variables control the behavior of NetBSD builds.  Unless
        otherwise specified, these variables may be set in either the process
        environment or the make(1) configuration file specified by MMAAKKEECCOONNFF.
   
      MAKE              Path name to invoke make(1) as.       BBUUIILLDDIIDD     Identifier for the build.  The identifier will be appended to
   
      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.  
                        MAKEOBJDIR can only be provided in the environment.  
   
      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.  
   
    "make" variables  
      Several variables control the behavior of NetBSD builds.  Unless other-  
      wise specified, these variables may be set in either the process environ-  
      ment or the make(1) configuration file specified by MAKECONF.  
   
      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 parame-                   configuration file in order to set additional build
                  ters, such as compiler flags.                   parameters, such as compiler flags.
   
        BBUUIILLDDSSEEEEDD   GCC uses random numbers when compiling C++ code.  This
                    variable seeds the gcc random number generator using the
                    -frandom-seed flag with this value.  By default, it is set to
                    NetBSD-(majorversion).  Using a fixed value causes C++
                    binaries to be the same when built from the same sources,
                    resulting in identical (reproducible) builds.  Additional
                    information is available in the GCC documentation of
                    -frandom-seed.
   
        DDEESSTTDDIIRR     Directory to contain the built NetBSD system.  If set,
                    special options are passed to the compilation tools to
                    prevent their default use of the host system's //uussrr//iinncclluuddee,
                    //uussrr//lliibb, and so forth.  This pathname must be an absolute
                    path, and should _n_o_t end with a slash (/) character.  (For
                    installation into the system's root directory, set DDEESSTTDDIIRR to
                    an empty string, not to ``/'').  The directory must reside on
                    a file system which supports long file names and hard links.
   
                    _D_e_f_a_u_l_t: Empty string if UUSSEETTOOOOLLSS is ``yes''; unset
                    otherwise.
   
                    _N_o_t_e: bbuuiilldd..sshh will provide a default of _d_e_s_t_d_i_r_.MMAACCHHIINNEE (in
                    the top-level ..OOBBJJDDIIRR) unless run in `expert' mode.
   
        MMAAKKEECCOONNFF    The name of the make(1) configuration file.  _O_n_l_y _s_e_t_t_a_b_l_e _i_n
                    _t_h_e _p_r_o_c_e_s_s _e_n_v_i_r_o_n_m_e_n_t_.
   
                    _D_e_f_a_u_l_t: ``/etc/mk.conf''
   
        MMAAKKEEVVEERRBBOOSSEE
                    Level of verbosity of status messages.  Supported values:
   
                    0    No descriptive messages or commands executed by make(1)
                         are shown.
   
                    1    Brief messages are shown describing what is being done,
                         but the actual commands executed by make(1) are not
                         displayed.
   
                    2    Descriptive messages are shown as above (prefixed with a
                         `#'), and ordinary commands performed by make(1) are
                         displayed.
   
                    3    In addition to the above, all commands performed by
                         make(1) are displayed, even if they would ordinarily
                         have been hidden through use of the ``@'' prefix in the
                         relevant makefile.
   
      DESTDIR     Directory to contain the built NetBSD system.  If set, spe-                   4    In addition to the above, commands executed by make(1)
                  cial options are passed to the compilation tools to prevent                        are traced through use of the sh(1) ``--xx'' flag.
                  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.  
   
                  Default: Empty string if USETOOLS is ``yes''; unset other-                   _D_e_f_a_u_l_t: 2
                  wise.  
   
      MAKECONF    The name of the make(1) configuration file.  Only settable in       MMKKCCAATTPPAAGGEESS  Can be set to ``yes'' or ``no''.  Indicates whether
                  the process environment.                   preformatted plaintext manual pages will be created during a
                    build.
   
                  Default: ``/etc/mk.conf''                   _D_e_f_a_u_l_t: ``yes''
   
      MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether prefor-       MMKKCCRRYYPPTTOO    Can be set to ``yes'' or ``no''.  Indicates whether
                  matted plaintext manual pages will be created during a build.                   cryptographic code will be included in a build; provided for
                    the benefit of countries that do not allow strong
                    cryptography.  Will not affect use of the standard low-
                    security password encryption system, crypt(3).
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether crypto-       MMKKDDOOCC       Can be set to ``yes'' or ``no''.  Indicates whether system
                  graphic code will be included in a build; provided for the                   documentation destined for DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e_/_d_o_c will be
                  benefit of countries that do not allow strong cryptography.                   installed during a build.
                  Will not affect use of the standard low-security password en-  
                  cryption system, crypt(3).  
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKDOC       Can be set to ``yes'' or ``no''.  Indicates whether system       MMKKHHTTMMLL      Can be set to ``yes'' or ``no''.  Indicates whether
                  documentation destined for /usr/share/doc will be installed                   preformatted HTML manual pages will be built and installed
                  during a build.  
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKHOSTOBJ   Can be set to ``yes'' or ``no''.  If set to ``yes'', then for       MMKKHHOOSSTTOOBBJJ   Can be set to ``yes'' or ``no''.  If set to ``yes'', then for
                  programs intended to be run on the compile host, the name,                   programs intended to be run on the compile host, the name,
                  release, and architecture of the host operating system will                   release, and architecture of the host operating system will
                  be suffixed to the name of the object directory created by                   be suffixed to the name of the object directory created by
Line 165  CONFIGURATION
Line 237  CONFIGURATION
                  built to be run on the compile host will use the same object                   built to be run on the compile host will use the same object
                  directory names as programs built to be run on the target.                   directory names as programs built to be run on the target.
   
                  Default: ``no''                   _D_e_f_a_u_l_t: ``no''
   
      MKINFO      Can be set to ``yes'' or ``no''.  Indicates whether GNU Info       MMKKIINNFFOO      Can be set to ``yes'' or ``no''.  Indicates whether GNU Info
                  files, used for the documentation for most of the compilation                   files, used for the documentation for most of the compilation
                  tools, will be created and installed during a build.                   tools, will be created and installed during a build.
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKLINT      Can be set to ``yes'' or ``no''.  Indicates whether lint(1)       MMKKKKMMOODD      Can be set to ``yes'' or ``no''.  Indicates whether kernel
                    modules are built and installed.
   
                    _D_e_f_a_u_l_t: ``yes''
   
        MMKKLLIINNTT      Can be set to ``yes'' or ``no''.  Indicates whether lint(1)
                  will be run against portions of the NetBSD source code during                   will be run against portions of the NetBSD source code during
                  the build, and whether lint libraries will be installed into                   the build, and whether lint libraries will be installed into
                  /usr/libdata/lint.                   DDEESSTTDDIIRR_/_u_s_r_/_l_i_b_d_a_t_a_/_l_i_n_t.
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKMAN       Can be set to ``yes'' or ``no''.  Indicates whether manual       MMKKMMAANN       Can be set to ``yes'' or ``no''.  Indicates whether manual
                  pages will be installed during a build.                   pages will be installed during a build.
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKNLS       Can be set to ``yes'' or ``no''.  Indicates whether Native       MMKKNNLLSS       Can be set to ``yes'' or ``no''.  Indicates whether Native
                  Language System locale zone files will be compiled and in-                   Language System locale zone files will be compiled and
                  stalled during a build.                   installed during a build.
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKOBJ       Can be set to ``yes'' or ``no''.  Indicates whether object       MMKKOOBBJJ       Can be set to ``yes'' or ``no''.  Indicates whether object
                  directories will be created when running ``make obj''.  If                   directories will be created when running ``make obj''.  If
                  set to ``no'', then all built files will be located inside                   set to ``no'', then all built files will be located inside
                  the regular source tree.                   the regular source tree.
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKPIC       Can be set to ``yes'' or ``no''.  Indicates whether shared                   Note that setting MMKKOOBBJJ to ``no'' is not recommended and may
                    cause problems when updating the tree with cvs(1).
   
        MMKKPPIICC       Can be set to ``yes'' or ``no''.  Indicates whether shared
                  objects and libraries will be created and installed during a                   objects and libraries will be created and installed during a
                  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 plat-                   _D_e_f_a_u_l_t: Platform dependent.  As of this writing, all
                  forms except sh3 default to ``yes''.                   platforms except sshh33 default to ``yes''.
   
      MKPICINSTALL       MMKKPPIICCIINNSSTTAALLLL
                  Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)                   Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)
                  format libraries (lib*_pic.a), used to generate shared li-                   format libraries (lliibb**__ppiicc..aa), used to generate shared
                  braries, are installed during a build.                   libraries, are installed during a build.
   
                  Default: ``yes''                   _D_e_f_a_u_l_t: ``yes''
   
      MKPROFILE   Can be set to ``yes'' or ``no''.  Indicates whether profiled       MMKKPPRROOFFIILLEE   Can be set to ``yes'' or ``no''.  Indicates whether profiled
                  libraries (lib*_p.a) will be built and installed during a                   libraries (lliibb**__pp..aa) will be built and installed during a
                  build.                   build.
   
                  Default: ``yes''; however, some platforms turn off MKPROFILE                   _D_e_f_a_u_l_t: ``yes''; however, some platforms turn off MMKKPPRROOFFIILLEE
                  by default at times due to toolchain problems with profiled                   by default at times due to toolchain problems with profiled
                  code.                   code.
   
      MKSHARE     Can be set to ``yes'' or ``no''.  Indicates whether files       MMKKRREEPPRROO     Can be set to ``yes'' or ``no''.  Create reproducable builds.
                  destined to reside in /usr/share will be built and installed                   This enables different switches to make two builds from the
                  during a build.  If set to ``no'', then all of MKCATPAGES,                   same source tree result in the same build results.
                  MKDOC, MKINFO, MKMAN, and MKNLS will be set to ``no'' uncon-  
                  ditionally.                   _D_e_f_a_u_l_t: ``no''
   
                  Default: ``yes''       MMKKSSHHAARREE     Can be set to ``yes'' or ``no''.  Indicates whether files
                    destined to reside in DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e will be built and
      TOOLDIR     Directory to hold the host tools, once built.  This directory                   installed during a build.  If set to ``no'', then all of
                  should be unique to a given host system and NetBSD source                   MMKKCCAATTPPAAGGEESS, MMKKDDOOCC, MMKKIINNFFOO, MMKKMMAANN, and MMKKNNLLSS will be set to
                  tree.  (However, multiple targets may share the same TOOLDIR;                   ``no'' unconditionally.
                  the target-dependent files have unique names.)  If unset, a  
                  default based on the uname(1) information of the host plat-                   _D_e_f_a_u_l_t: ``yes''
                  form will be created in the .OBJDIR of src/tools.  
        MMKKSSTTRRIIPPIIDDEENNTT
                  Default: Unset.                   Can be set to ``yes'' or ``no''.  Indicates whether program
                    binaries and shared libraries should be built to include RCS
      UNPRIVED    If set, then an unprivileged install will occur.  The user,                   IDs for use with ident(1).
                  group, permissions, and file flags, will not be set on the  
                  installed item; instead the information will be appended to a                   _D_e_f_a_u_l_t: ``no''
                  file called METALOG in DESTDIR.  The contents of METALOG is  
                  used during the generation of the distribution tar files to       MMKKUUNNPPRRIIVVEEDD  Can be set to ``yes'' or ``no''.  Indicates whether an
                  ensure that the appropriate file ownership is stored.                   unprivileged install will occur.  The user, group,
                    permissions, and file flags, will not be set on the installed
                  Default: Unset.                   items; instead the information will be appended to a file
                    called _M_E_T_A_L_O_G in DDEESSTTDDIIRR.  The contents of _M_E_T_A_L_O_G are used
      UPDATE      If set, then all install operations intended to write to                   during the generation of the distribution tar files to ensure
                  DESTDIR will compare file timestamps before installing, and                   that the appropriate file ownership is stored.
                  skip the install phase if the destination files are up-to-  
                  date.  This also has implications on full builds (see next                   _D_e_f_a_u_l_t: ``no''
                  subsection).  
        MMKKUUPPDDAATTEE    Can be set to ``yes'' or ``no''.  Indicates whether all
                    install operations intended to write to DDEESSTTDDIIRR will compare
                    file timestamps before installing, and skip the install phase
                    if the destination files are up-to-date.  This also has
                    implications on full builds (see next subsection).
   
                    _D_e_f_a_u_l_t: ``no''
   
        MMKKXX1111       Can be set to ``yes'' or ``no''.  Indicates whether X11 is
                    built from XX1111SSRRCCDDIIRR.
   
                    _D_e_f_a_u_l_t: ``no''
   
                  Default: Unset.       TTOOOOLLDDIIRR     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,
                    multiple targets may share the same TTOOOOLLDDIIRR; 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 ..OOBBJJDDIIRR of _s_r_c.
   
      USETOOLS    Indicates whether the tools specified by TOOLDIR should be                   _D_e_f_a_u_l_t: Unset.
   
        UUSSEETTOOOOLLSS    Indicates whether the tools specified by TTOOOOLLDDIIRR should be
                  used as part of a build in progress.  Must be set to ``yes''                   used as part of a build in progress.  Must be set to ``yes''
                  if cross-compiling.                   if cross-compiling.
   
                  yes    Use the tools from TOOLDIR.                   yyeess    Use the tools from TTOOOOLLDDIIRR.
   
                  no     Do not use the tools from TOOLDIR, but refuse to build                   nnoo     Do not use the tools from TTOOOOLLDDIIRR, but refuse to build
                         native compilation tool components that are version-                          native compilation tool components that are version-
                         specific for that tool.                          specific for that tool.
   
                  never  Do not use the tools from TOOLDIR, even when building                   nneevveerr  Do not use the tools from TTOOOOLLDDIIRR, even when building
                         native tool components.  This is similar to the tradi-                          native tool components.  This is similar to the
                         tional NetBSD build method, but does not verify that                          traditional NetBSD build method, but does _n_o_t verify
                         the compilation tools in use are up-to-date enough in                          that the compilation tools in use are up-to-date
                         order to build the tree successfully.  This may cause                          enough in order to build the tree successfully.  This
                         build or runtime problems when building the whole                          may cause build or runtime problems when building the
                         NetBSD source tree.                          whole NetBSD source tree.
   
                  Default: ``yes'' if building all or part of a whole NetBSD                   _D_e_f_a_u_l_t: ``yes'', unless TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG is set to ``yes''.
                  source tree (detected automatically); ``no'' otherwise (to  
                  preserve traditional semantics of the <bsd.*.mk> make(1) in-                   UUSSEETTOOOOLLSS is also set to ``no'' when using <bsd.*.mk> outside
                  clude files).                   the NetBSD source tree.
   
        XX1111SSRRCCDDIIRR   Directory containing the X11R6 source.  If specified, must be
                    an absolute path.  The main X11R6 source is found in
                    XX1111SSRRCCDDIIRR_/_x_f_r_e_e_/_x_c.
   
                    _D_e_f_a_u_l_t: NNEETTBBSSDDRRCCDDIIRR_/_._._/_x_s_r_c, if that exists; otherwise
                    _/_u_s_r_/_x_s_r_c.
   
        XX1111FFLLAAVVOOUURR  The style of X11 cross-built, set to either ``Xorg'' or
                    ``XFree86''.
   
                    _D_e_f_a_u_l_t: ``Xorg'' on amd64, i386, macppc, shark and sparc64
                    platforms, ``XFree86'' on everything else.
   
    "make" variables for full builds     ""mmaakkee"" vvaarriiaabblleess ffoorr ffuullll bbuuiillddss
      These variables only affect the top level ``Makefile'' and do not affect       These variables only affect the top level ``Makefile'' and do not affect
      manually building subtrees of the NetBSD source code.       manually building subtrees of the NetBSD source code.
   
      INSTALLWORLDDIR  Location for the ``make installworld'' target to install       IINNSSTTAALLLLWWOORRLLDDDDIIRR  Location for the ``make installworld'' target to install
                       to.                        to.  If specified, must be an absolute path.
   
                       Default: ``/''                        _D_e_f_a_u_l_t: ``/''
   
      MKOBJDIRS        Can be set to ``yes'' or ``no''.  Indicates whether ob-       MMKKOOBBJJDDIIRRSS        Can be set to ``yes'' or ``no''.  Indicates whether
                       ject directories will be created automatically (via a                        object directories will be created automatically (via a
                       ``make obj'' pass) at the start of a build.                        ``make obj'' pass) at the start of a build.
   
                       Default: ``yes''                        _D_e_f_a_u_l_t: ``no''
   
      NBUILDJOBS       Now obsolete.  Use the make(1) option -j, instead (see                        If using bbuuiilldd..sshh, the default is ``yes''.  This may be
                       below)                        set back to ``no'' by giving bbuuiilldd..sshh the --oo option.
   
                       Default: Unset.       MMKKUUPPDDAATTEE         Can be set to ``yes'' or ``no''.  If set, then in
                         addition to the effects described for MMKKUUPPDDAATTEE==yyeess
                         above, this implies the effects of NNOOCCLLEEAANNDDIIRR (i.e.,
                         ``make cleandir'' is avoided).
   
      NOCLEANDIR       If set, avoids the ``make cleandir'' phase of a full                        _D_e_f_a_u_l_t: ``no''
   
                         If using bbuuiilldd..sshh, this may be set by giving the --uu
                         option.
   
        NNBBUUIILLDDJJOOBBSS       Now obsolete.  Use the make(1) option --jj, instead.  See
                         below.
   
                         _D_e_f_a_u_l_t: Unset.
   
        NNOOCCLLEEAANNDDIIRR       If set, avoids the ``make cleandir'' phase of a full
                       build.  This has the effect of allowing only changed                        build.  This has the effect of allowing only changed
                       files in a source tree to be recompiled.  This can speed                        files in a source tree to be recompiled.  This can speed
                       up builds when updating only a few files in the tree.                        up builds when updating only a few files in the tree.
   
                       Default: Unset.                        _D_e_f_a_u_l_t: Unset.
   
      NODISTRIBDIRS    If set, avoids the ``make distrib-dirs'' phase of a full                        See also MMKKUUPPDDAATTEE.
                       build.  This skips running mtree(8) on DESTDIR, useful  
        NNOODDIISSTTRRIIBBDDIIRRSS    If set, avoids the ``make distrib-dirs'' phase of a full
                         build.  This skips running mtree(8) on DDEESSTTDDIIRR, useful
                       on systems where building as an unprivileged user, or                        on systems where building as an unprivileged user, or
                       where it is known that the system-wide mtree files have                        where it is known that the system-wide mtree files have
                       not changed.                        not changed.
   
                       Default: Unset.                        _D_e_f_a_u_l_t: Unset.
   
      NOINCLUDES       If set, avoids the ``make includes'' phase of a full       NNOOIINNCCLLUUDDEESS       If set, avoids the ``make includes'' phase of a full
                       build.  This has the effect of preventing make(1) from                        build.  This has the effect of preventing make(1) from
                       thinking that some programs are out-of-date simply be-                        thinking that some programs are out-of-date simply
                       cause the system include files have changed.  However,                        because the system include files have changed.  However,
                       this option should not be used when updating the entire                        this option should not be used when updating the entire
                       NetBSD source tree arbitrarily; it is suggested to use                        NetBSD source tree arbitrarily; it is suggested to use
                       UPDATE in that case.                        MMKKUUPPDDAATTEE==yyeess instead in that case.
   
                       Default: Unset.                        _D_e_f_a_u_l_t: Unset.
   
      RELEASEDIR       If set, specifies the directory to which a release(7)       RREELLEEAASSEEDDIIRR       If set, specifies the directory to which a release(7)
                       layout will be written at the end of a ``make release''.                        layout will be written at the end of a ``make release''.
                         If specified, must be an absolute path.
   
                       Default: Unset.                        _D_e_f_a_u_l_t: Unset.
   
      UPDATE           If set, then in addition to the effects described for                        _N_o_t_e: bbuuiilldd..sshh will provide a default of _r_e_l_e_a_s_e_d_i_r (in
                       UPDATE above, this implies the effects of NOCLEANDIR.                        the top-level ..OOBBJJDDIIRR) unless run in `expert' mode.
   
 BUILDING  BBUUIILLDDIINNGG
    "make" command line options     ""mmaakkee"" ccoommmmaanndd lliinnee ooppttiioonnss
      This is only a summary of options available to make(1); only the options       This is not a summary of all the options available to make(1); only the
      used most frequently with NetBSD builds are listed here.       options used most frequently with NetBSD builds are listed here.
   
      -j njob    Run up to njob make(1) subjobs in parallel.  Makefiles should       --jj _n_j_o_b    Run up to _n_j_o_b make(1) subjobs in parallel.  Makefiles should
                 use .WAIT or have explicit dependancies as necessary to en-                  use .WAIT or have explicit dependencies as necessary to
                 force build ordering.  If you see build failures with -j,                  enforce build ordering.
                 please save complete build logs so the failures can be ana-  
                 lyzed.       --mm _d_i_r     Specify the default directory for searching for system
                   Makefile segments, mainly the <bsd.*.mk> files.  When building
      -m dir     Specify the default directory for searching for system Make-                  any full NetBSD source tree, this should be set to the
                 file segments, mainly the <bsd.*.mk> files.  When building any                  ``share/mk'' directory in the source tree.  This is set
                 full NetBSD source tree, this should be set to the                  automatically when building from the top level, or when using
                 ``share/mk'' directory in the source tree.  (This is set auto-                  bbuuiilldd..sshh.
                 matically when building from the top level.)  
   
      -n         Display the commands that would have been executed, but do not       --nn         Display the commands that would have been executed, but do not
                 actually execute them.  This will still cause recursion to                  actually execute them.  This will still cause recursion to
                 take place.                  take place.
   
      -v var     Print make(1)'s idea of the value of var.  Does not build any       --VV _v_a_r     Print make(1)'s idea of the value of _v_a_r.  Does not build any
                 targets.                  targets.
   
      var=value  Set the variable var to value, overriding any setting speci-       _v_a_r_=_v_a_l_u_e  Set the variable _v_a_r to _v_a_l_u_e, overriding any setting
                 fied by the process environment, the MAKECONF configuration                  specified by the process environment, the MMAAKKEECCOONNFF
                 file, or the system Makefile segments.                  configuration file, or the system Makefile segments.
   
    "make" targets     ""mmaakkee"" ttaarrggeettss
      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
      the NetBSD source code.  It is recommended that none of these be used       the NetBSD source code.  It is recommended that none of these be used
      from the top level Makefile; as a specific exception, ``make obj'' and       from the top level Makefile; as a specific exception, ``make obj'' and
      ``make cleandir'' are useful in that context.       ``make cleandir'' are useful in that context.
   
      all        Build programs, libraries, and preformatted documentation.       aallll        Build programs, libraries, and preformatted documentation.
   
      clean      Remove program and library object code files.       cclleeaann      Remove program and library object code files.
   
      cleandir   Same as clean, but also remove preformatted documentation, de-       cclleeaannddiirr   Same as cclleeaann, but also remove preformatted documentation,
                 pendency files generated by ``make depend'', and any other                  dependency files generated by ``make depend'', and any other
                 files known to be created at build time.  ``make distclean''                  files known to be created at build time.
                 may be used as a synonym, for familiarity with a similar well-  
                 known convention.  
   
      depend     Create dependency files (.depend) containing more detailed in-       ddeeppeenndd     Create dependency files (..ddeeppeenndd) containing more detailed
                 formation about the dependencies of source code on header                  information about the dependencies of source code on header
                 files.  Allows programs to be recompiled automatically when a                  files.  Allows programs to be recompiled automatically when a
                 dependency changes.                  dependency changes.
   
      dependall  Does a ``make depend'' immediately followed by a ``make all''.       ddeeppeennddaallll  Does a ``make depend'' immediately followed by a ``make all''.
                 This improves cache locality of the build since both passes                  This improves cache locality of the build since both passes
                 read the source files in their entirety.                  read the source files in their entirety.
   
      includes   Build and install system header files.  Typically needed be-       ddiissttcclleeaann  Synonym for cclleeaannddiirr.
                 fore any system libraries or programs can be built.  
        iinncclluuddeess   Build and install system header files.  Typically needed
                   before any system libraries or programs can be built.
   
      install    Install programs, libraries, and documentation into DESTDIR.       iinnssttaallll    Install programs, libraries, and documentation into DDEESSTTDDIIRR.
                 Few files will be installed to /dev, /etc, /root or /var in                  Few files will be installed to DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c,
                 order to prevent user supplied configuration data from being                  DDEESSTTDDIIRR_/_r_o_o_t or DDEESSTTDDIIRR_/_v_a_r in order to prevent user supplied
                 overwritten.                  configuration data from being overwritten.
   
      lint       Run lint(1) against the C source code, where appropriate, and       lliinntt       Run lint(1) against the C source code, where appropriate, and
                 generate system-installed lint libraries.                  generate system-installed lint libraries.
   
      obj        Create object directories to be used for built files, instead       oobbjj        Create object directories to be used for built files, instead
                 of building directly in the source tree.                  of building directly in the source tree.
   
      tags       Create ctags(1) searchable function lists usable by the ex(1)       ttaaggss       Create ctags(1) searchable function lists usable by the ex(1)
                 and vi(1) text editors.                  and vi(1) text editors.
   
    "make" targets for the top level     ""mmaakkee"" ttaarrggeettss ffoorr tthhee ttoopp lleevveell
      Additional make(1) targets are usable specifically from the top source       Additional make(1) targets are usable specifically from the top source
      level to facilitate building the entire NetBSD source tree.       level to facilitate building the entire NetBSD source tree.
   
      build         Build the entire NetBSD system.  This orders portions of       bbuuiilldd         Build the entire NetBSD system (except the kernel).  This
                    the source tree such that prerequisites will be built in                     orders portions of the source tree such that prerequisites
                    the proper order.                     will be built in the proper order.
   
      distribution  Do a ``make build'', and then install a full distribution       ddiissttrriibbuuttiioonn  Do a ``make build'', and then install a full distribution
                    into DESTDIR.                     (which does not include a kernel) into DDEESSTTDDIIRR, including
                      files in DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c, DDEESSTTDDIIRR_/_r_o_o_t and
                      DDEESSTTDDIIRR_/_v_a_r.
   
        bbuuiillddwwoorrlldd    As per ``make distribution'', except that it ensures that
                      DDEESSTTDDIIRR is not the root directory.
   
        iinnssttaallllwwoorrlldd  Install the distribution from DDEESSTTDDIIRR to IINNSSTTAALLLLWWOORRLLDDDDIIRR,
                      which defaults to the root directory.  Ensures that
                      IINNSSTTAALLLLWWOORRLLDDDDIIRR is not the root directory if cross
                      compiling.
   
                      The IINNSSTTAALLLLSSEETTSS 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 IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c will not be
                      installed or modified.
   
                      _N_o_t_e: Before performing this operation with
                      IINNSSTTAALLLLWWOORRLLDDDDIIRR=_/, 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 IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c and that you use
                      postinstall(8) to check for inconsistencies (and possibly
                      to fix them).
   
        sseettss          Create distribution sets from DDEESSTTDDIIRR into
                      RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_e_t_s.  Should be run
                      after ``make distribution'', as ``make build'' alone does
                      not install all of the required files.
   
        ssoouurrcceesseettss    Create source sets of the source tree into
                      RREELLEEAASSEEDDIIRR_/_s_o_u_r_c_e_/_s_e_t_s.
   
        ssyyssppkkggss       Create syspkgs from DDEESSTTDDIIRR into
                      RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_y_s_p_k_g_s.  Should be run
                      after ``make distribution'', as ``make build'' alone does
                      not install all of the required files.
   
        rreelleeaassee       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 RREELLEEAASSEEDDIIRR be
                      set (see above).
   
        iissoo--iimmaaggee     Create a NetBSD installation CD-ROM image in the
                      RREELLEEAASSEEDDIIRR_/_i_s_o 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
                      installation 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 RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m
                      directory by ``make release''.  These smaller images
                      usually contain the same tools as the larger images in
                      RREELLEEAASSEEDDIIRR_/_i_s_o, 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)
                      utility, which is not part of NetBSD, but which can be
                      installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s.
   
        iissoo--iimmaaggee--ssoouurrccee
                      Create a NetBSD installation CD-ROM image in the
                      RREELLEEAASSEEDDIIRR_/_i_s_o 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
                      installation 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
                      equivalent.
   
                      Note that other, smaller, CD-ROM images may be created in
                      the RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m
                      directory by ``make release''.  These smaller images
                      usually contain the same tools as the larger images in
                      RREELLEEAASSEEDDIIRR_/_i_s_o, 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)
                      utility, which is not part of NetBSD, but which can be
                      installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s.
   
        iinnssttaallll--iimmaaggee
                      Create a bootable NetBSD installation disk image in the
                      RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_i_n_s_t_a_l_l_i_m_a_g_e
                      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, RREELLEEAASSEEDDIIRR must
                      be populated by ``make release'' or equivalent.  The build
                      must have been performed with MMKKUUNNPPRRIIVVEEDD==yyeess because ``make
                      install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G.
   
        live-image    Create NetBSD live images in the
                      RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_l_i_v_e_i_m_a_g_e
                      directory.  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
                      virtual 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 MMKKUUNNPPRRIIVVEEDD==yyeess because ``make
                      install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G.
   
      buildworld    As per ``make distribution'', except that it ensures that       rreeggrreessssiioonn--tteessttss
                    DESTDIR is not the root directory.  
   
      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-  
                    ing.  
   
                    Note: It is highly recommended that you upgrade your kernel  
                    and reboot before performing this operation.  
   
      release       Do a ``make build'', then package the system into a stan-  
                    dard release layout as described by release(7).  This re-  
                    quires that RELEASEDIR be set (see above).  
   
      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 the compiled regression tests                     directory ``regress''.  Runs those compiled regression
                    on the local host.                     tests on the local host.  Note that most tests are now
                      managed instead using atf(7); this target should probably
    The "build.sh" script                     run those as well but currently does not.
      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     TThhee ""bbuuiilldd..sshh"" ssccrriipptt
      that are not POSIX compliant.  Note that if a host system's /bin/sh is       This script file is a shell script designed to build the entire NetBSD
      unusually old and broken, the Korn Shell (/bin/ksh), if available, may be       system on any host with a suitable modern shell and some common
      a usable alternative.       utilities.  The required shell features are described under the HHOOSSTT__SSHH
        variable.
   
        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 [_o_p_t_i_o_n_s]
   
        The above command will usually enable bbuuiilldd..sshh to automatically set
        HHOOSSTT__SSHH==_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l, but if that fails, then the following
        set of commands may be used instead:
   
              HOST_SH=_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l
              export HOST_SH
              ${HOST_SH} build.sh [_o_p_t_i_o_n_s]
   
        If bbuuiilldd..sshh detects that it is being executed under an unsuitable shell,
        it attempts to exec a suitable shell instead, or prints an error message.
        If HHOOSSTT__SSHH is not set explicitly, then bbuuiilldd..sshh sets a default using
        heuristics dependent on the host platform, or from the shell under which
        bbuuiilldd..sshh is executed (if that can be determined), or using the first copy
        of _s_h found in PPAATTHH.
   
      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 bbuuiilldd..sshh rather than just running ``make''.  This way,
      the make(1) program will be bootstrapped properly, in case the host sys-       the make(1) program will be bootstrapped properly, in case the host
      tem has an older or incompatible ``make'' program.       system 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 bbuuiilldd..sshh, 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
      of options below, variables that are automatically set by build.sh are       of options below, variables that are automatically set by bbuuiilldd..sshh are
      noted where applicable.       noted where applicable.
   
      The following are available command line options that may be supplied to       The following operations are supported by bbuuiilldd..sshh:
      build.sh:  
   
      -a arch   Set the value of MACHINE_ARCH to arch.  
   
      -B buildid       bbuuiilldd         Build the system as per ``make build''.  Before the main
                Set the value of BUILDID to buildid.  This will also append the                     part of the build commences, this command runs the oobbjj
                build idenfitier to the name of the ``make'' wrapper script so                     operation (unless the --oo option is given), ``make
                that the resulting name is of the form ``nbmake-MACHINE-                     cleandir'' (unless the --uu option is given), and the ttoooollss
                BUILDID''.                     operation.
   
      -b        Bootstrap ``make'' and create a nbmake-MACHINE script (see be-       ddiissttrriibbuuttiioonn  Build a full distribution as per ``make distribution''.
                low).                     This command first runs the bbuuiilldd operation.
   
      -D dest   Set the value of DESTDIR to dest.       rreelleeaassee       Build a full release as per ``make release''.  This command
                      first runs the ddiissttrriibbuuttiioonn operation.
      -d        Build a full distribution.  This differs from a default build  
                in that files will also be installed to /dev, /etc, /root and       mmaakkeewwrraappppeerr   Create the nnbbmmaakkee--MMAACCHHIINNEE wrapper.  This operation is
                /var.  Note this does not build a ``release''; no release sets                     automatically performed for any of the other operations.
                are placed in ${RELEASEDIR}.  -d is implied by -R.  
        cclleeaannddiirr      Perform ``make cleandir''.
      -E        Set `expert' mode; DESTDIR does not have to be set to a non-  
                root path for builds when this is set.       oobbjj           Perform ``make obj''.
   
      -i installworlddir       ttoooollss         Build and install the host tools from _s_r_c_/_t_o_o_l_s.  This
                Install the contents of DESTDIR to installworlddir after all                     command will first run ``make obj'' and ``make cleandir''
                other operations have completed, using the top level                     in the _t_o_o_l_s subdirectory unless the --oo or --uu options
                ``installworld'' target.                     (respectively) are given.
   
      -j njob   Passed through to make(1).  Makefiles should use .WAIT or have       iinnssttaallll=_i_d_i_r  Install the contents of DDEESSTTDDIIRR to _i_d_i_r, using ``make
                explicit dependancies as necessary to enforce build ordering.                     installworld''.  Note that files that are part of the
                If you see build failures with -j, please save complete build                     ``etc'' or ``xetc'' sets will not be installed, unless
                logs so the failures can be analyzed.                     overridden by the INSTALLSETS environment variable.
   
      -k kernel       kkeerrnneell=_k_c_o_n_f  Build a new kernel.  The _k_c_o_n_f argument is the name of a
                Build a new kernel.  The kernel argument is the name of a con-                     configuration file suitable for use by config(1).  If _k_c_o_n_f
                figuration file suitable for use by config(8).  If kernel does                     does not contain any `/' characters, the configuration file
                not contain any `/' characters, the configuration file is ex-                     is expected to be found in the KKEERRNNCCOONNFFDDIIRR directory, which
                pected to be found in the KERNCONFDIR directory, which is typi-                     is typically ssyyss//aarrcchh//MMAACCHHIINNEE//ccoonnff.  The new kernel will be
                cally sys/arch/MACHINE/conf.  The new kernel will be built in a                     built in a subdirectory of KKEERRNNOOBBJJDDIIRR, which is typically
                subdirectory of KERNOBJDIR, which is typically                     ssyyss//aarrcchh//MMAACCHHIINNEE//ccoommppiillee or an associated object directory.
                sys/arch/MACHINE/compile or an associated object directory.  In  
                order to ensure that the kernel is built using up-to-date                     This command does _n_o_t imply the ttoooollss command; run the
                tools, it is strongly recommended that the tools be rebuilt                     ttoooollss command first unless it is _c_e_r_t_a_i_n that the tools
                (using the -t option) in a separate invocation of build.sh pri-                     already exist and are up to date.
                or to using the -k option, or that the -t and -k options be  
                used together in a single invocation of build.sh.                     This command will run ``make cleandir'' on the kernel in
                      question first unless the --uu option is given.
      -M obj    Set MAKEOBJDIRPREFIX to obj.  
        mmoodduulleess       This command will build kernel modules and install them
      -m mach   Set the value of MACHINE to mach.  This will also override any                     into DDEESSTTDDIIRR.
                value of MACHINE_ARCH in the process environment with a value  
                deduced from mach, unless -a is specified.  All cross builds       rreelleeaasseekkeerrnneell=_k_c_o_n_f
                require -m, but if unset on a NetBSD host, the host's value of                     Install a gzip(1)ed copy of the kernel previously built by
                MACHINE will be detected and used automatically.                     kkeerrnneell=_k_c_o_n_f into
                      RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_k_e_r_n_e_l, usually as
                      _n_e_t_b_s_d_-_k_c_o_n_f_._g_z, although the ``_n_e_t_b_s_d'' prefix is
                      determined from the ``ccoonnffiigg'' directives in _k_c_o_n_f.
   
        sseettss          Perform ``make sets''.
   
        ssoouurrcceesseettss    Perform ``make sourcesets''.
   
        ssyyssppkkggss       Perform ``make syspkgs''.
   
        iissoo--iimmaaggee     Perform ``make iso-image''.
   
        iissoo--iimmaaggee--ssoouurrccee
                      Perform ``make iso-image-source''.
   
        iinnssttaallll--iimmaaggee
                      Perform ``make install-image''.
   
        lliivvee--iimmaaggee    Perform ``make live-image''.
   
        The following command line options alter the behaviour of the bbuuiilldd..sshh
        operations described above:
   
        --aa _a_r_c_h   Set the value of MMAACCHHIINNEE__AARRCCHH to _a_r_c_h.
   
        --BB _b_u_i_l_d_i_d
                  Set the value of BBUUIILLDDIIDD to _b_u_i_l_d_i_d.  This will also append the
                  build identifier to the name of the ``make'' wrapper script so
                  that the resulting name is of the form
                  ``nnbbmmaakkee--MMAACCHHIINNEE--BBUUIILLDDIIDD''.
   
        --CC _c_d_e_x_t_r_a_s
                  Append _c_d_e_x_t_r_a_s to the CCDDEEXXTTRRAA variable, which is a space-
                  separated list of files or directories that will be added to
                  the CD-ROM image that may be create by the ``iso-image'' or
                  ``iso-image-source'' operations.  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.  Multiple paths
                  may be specified via multiple --CC options, or via a single
                  option whose argument contains multiple space-separated paths.
   
        --DD _d_e_s_t   Set the value of DDEESSTTDDIIRR to _d_e_s_t.  If a relative path is
                  specified, it will be converted to an absolute path before
                  being used.
   
        --EE        Set `expert' mode.  This overrides various sanity checks, and
                  allows: DDEESSTTDDIIRR does not have to be set to a non-root path for
                  builds, and MMKKUUNNPPRRIIVVEEDD==yyeess does not have to be set when
                  building as a non-root user.
   
                  _N_o_t_e: It is highly recommended that you know what you are doing
                  when you use this option.
   
        --hh        Print a help message.
   
        --jj _n_j_o_b   Run up to _n_j_o_b make(1) subjobs in parallel; passed through to
                  make(1).  If you see failures for reasons other than running
                  out of memory while using bbuuiilldd..sshh with --jj, please save
                  complete build logs so the failures can be analyzed.
   
                  To achieve the fastest builds, --jj values between (1 + the
                  number of CPUs) and (2 * the number of CPUs) are recommended.
                  Use lower values on machines with limited memory or I/O
                  bandwidth.
   
        --MM _o_b_j    Set MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX to _o_b_j.  Unsets MMAAKKEEOOBBJJDDIIRR.  See ``--OO
                  --oobbjj'' for more information.
   
                  For instance, if the source directory is _/_u_s_r_/_s_r_c, a setting of
                  ``--MM _/_u_s_r_/_o_b_j'' will place build-time files under
                  _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_b_i_n, _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_l_i_b,
                  _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_u_s_r_._b_i_n, and so forth.
   
                  If a relative path is specified, it will be converted to an
                  absolute path before being used.  bbuuiilldd..sshh imposes the
                  restriction that the argument to the --MM option must not begin
                  with a ``$'' (dollar sign) character; otherwise it would be too
                  difficult to determine whether the value is an absolute or a
                  relative path.  If the directory does not already exist,
                  bbuuiilldd..sshh will create it.
   
        --mm _m_a_c_h   Set the value of MMAACCHHIINNEE to _m_a_c_h, except in some special cases
                  listed below.  This will also override any value of
                  MMAACCHHIINNEE__AARRCCHH in the process environment with a value deduced
                  from _m_a_c_h, unless --aa is specified.  All cross builds require
                  --mm, 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 MMAACCHHIINNEE__AARRCCHH.  The
                  following special cases for the _m_a_c_h argument are defined to
                  set the listed values of MMAACCHHIINNEE and MMAACCHHIINNEE__AARRCCHH:
   
                        mmaacchh          MMAACCHHIINNEE    MMAACCHHIINNEE__AARRCCHH
                        evbarm        evbarm     (not set)
                        evbarm-eb     evbarm     armeb
                        evbarm-el     evbarm     arm
                        evbmips       evbmips    (not set)
                        evbmips-eb    evbmips    mipseb
                        evbmips-el    evbmips    mipsel
                        evbsh3        evbsh3     (not set)
                        evbsh3-eb     evbsh3     sh3eb
                        evbsh3-el     evbsh3     sh3el
                        sbmips        sbmips     (not set)
                        sbmips-eb     sbmips     mipseb
                        sbmips-el     sbmips     mipsel
   
        --NN _n_o_i_s_e_l_e_v_e_l
                  Set the ``noisyness'' level of the build, by setting
                  MMAAKKEEVVEERRBBOOSSEE to _n_o_i_s_e_l_e_v_e_l.
   
      -n        Show the commands that would be executed by build.sh, but do       --nn        Show the commands that would be executed by bbuuiilldd..sshh, but do
                not make any changes.  This is similar in concept to ``make                 not make any changes.  This is similar in concept to ``make
                -n''.                 -n''.
   
      -O obj    Create an appropriate transform macro for MAKEOBJDIR that will       --OO _o_b_j    Create an appropriate transform macro for MMAAKKEEOOBBJJDDIIRR that will
                place the built object files under obj.  For instance, a set-                 place the built object files under _o_b_j.  Unsets
                ting of /usr/obj will place build-time files under                 MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX.
                /usr/obj/bin, /usr/obj/lib, and so forth.  
                  For instance, a setting of ``--OO _/_u_s_r_/_o_b_j'' will place build-
      -o        Set the value of MKOBJDIRS to ``no''.                 time files under _/_u_s_r_/_o_b_j_/_b_i_n, _/_u_s_r_/_o_b_j_/_l_i_b, _/_u_s_r_/_o_b_j_/_u_s_r_._b_i_n,
                  and so forth.
      -R rel    Set the value of RELEASEDIR to rel.  Setting this option will  
                cause build.sh to run ``make release'' instead of ``make                 If a relative path is specified, it will be converted to an
                build''.                 absolute path before being used.  bbuuiilldd..sshh imposes the
                  restriction that the argument to the --OO option must not contain
                  a ``$'' (dollar sign) character.  If the directory does not
                  already exist, bbuuiilldd..sshh will create it.
   
                  In normal use, exactly one of the --MM or --OO options should be
                  specified.  If neither --MM nor --OO is specified, then a default
                  object directory will be chosen according to rules in
                  <bsd.obj.mk>.  Relying on this default is not recommended
                  because it is determined by complex rules that are influenced
                  by the values of several variables and by the location of the
                  source directory.
   
        --oo        Set the value of MMKKOOBBJJDDIIRRSS to ``no''.  Otherwise, it will be
                  automatically set to ``yes''.  This default is opposite to the
                  behaviour when not using bbuuiilldd..sshh.
   
        --RR _r_e_l    Set the value of RREELLEEAASSEEDDIIRR to _r_e_l.  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       --rr        Remove the contents of DDEESSTTDDIIRR and TTOOOOLLDDIIRR before building
                (provides a clean starting point).  This will skip deleting                 (provides a clean starting point).  This will skip deleting
                DESTDIR if building on a native system to the root directory.                 DDEESSTTDDIIRR if building on a native system to the root directory.
   
        --SS _s_e_e_d   Change the value of BBUUIILLDDSSEEEEDD to _s_e_e_d.  This should rarely be
                  necessary.
   
      -T tools  Set the value of TOOLDIR to tools.  If set, the bootstrap       --TT _t_o_o_l_s  Set the value of TTOOOOLLDDIIRR to _t_o_o_l_s.  If a relative path is
                ``make'' will only be rebuilt as needed (when the source files                 specified, it will be converted to an absolute path before
                for make(1) change).                 being used.  If set, the bootstrap ``make'' will only be
                  rebuilt if the source files for make(1) have changed.
   
      -t        Build and install the host tools from src/tools only.  This op-       --UU        Set MMKKUUNNPPRRIIVVEEDD==yyeess.
                tion implies -b.  
   
      -U        Set the UNPRIVED variable.       --uu        Set MMKKUUPPDDAATTEE==yyeess.
   
      -u        Set the UPDATE variable.       --VV _v_a_r=[_v_a_l_u_e]
                  Set the environment variable _v_a_r to an optional _v_a_l_u_e.  This is
                  propagated to the nnbbmmaakkee wrapper.
   
      -V var=[value]       --ww _w_r_a_p_p_e_r
                Set the variable var to value (which is optional).  This is                 Create the nnbbmmaakkee wrapper script (see below) in a custom
                useful for setting RELEASEDIR without actually building a re-                 location, specified by _w_r_a_p_p_e_r.  This allows, for instance, to
                lease.                 place the wrapper in PPAATTHH automatically.  Note that _w_r_a_p_p_e_r is
                  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.
   
      -w wrapper       --XX _x_1_1_s_r_c
                Create the nbmake wrapper script (see below) in a custom loca-                 Set the value of XX1111SSRRCCDDIIRR to _x_1_1_s_r_c.  If a relative path is
                tion, specified by wrapper.  This allows, for instance, to                 specified, it will be converted to an absolute path before
                place the wrapper in PATH automatically.  Note that wrapper is                 being used.
                the full name of the file, not just a directory name.  
   
    The "nbmake-MACHINE" wrapper script       --xx        Set MMKKXX1111==yyeess.
      If using the build.sh script to build NetBSD, a nbmake-MACHINE script  
      will be created in TOOLDIR/bin upon the first build to assist in building       --ZZ _v_a_r    Unset ("zap") the environment variable _v_a_r.  This is propagated
                  to the nnbbmmaakkee wrapper.
   
      TThhee ""nnbbmmaakkee--MMAACCHHIINNEE"" wwrraappppeerr ssccrriipptt
        If using the bbuuiilldd..sshh script to build NetBSD, a nnbbmmaakkee--MMAACCHHIINNEE script
        will be created in TTOOOOLLDDIIRR//bbiinn upon the first build to assist in 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       nnbbmmaakkee--MMAACCHHIINNEE can be invoked in lieu of make(1), and will instead call
      the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with sev-       the up-to-date version of ``nbmake'' installed into TTOOOOLLDDIIRR//bbiinn with
      eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR.       several key variables pre-set, including MMAACCHHIINNEE, MMAACCHHIINNEE__AARRCCHH, and
      This script can be symlinked into a directory listed in PATH, or called       TTOOOOLLDDIIRR.  nnbbmmaakkee--MMAACCHHIINNEE will also set variables specified with --VV, and
        unset variables specified with --ZZ.
   
        This script can be symlinked into a directory listed in PPAATTHH, or called
      with an absolute path.       with an absolute path.
   
 EXAMPLES  EEXXAAMMPPLLEESS
      ./build.sh -t       1.   % ./build.sh [options] tools kernel=GENERIC
                Build a new toolchain.  
   
      cd ${KERNCONFDIR} ; ${TOOLDIR}/bin/nbconfig GENERIC            Build a new toolchain, and use the new toolchain to configure and
                Use the new version of config(8) to prepare to build a new            build a new GENERIC kernel.
                GENERIC kernel.  
   
      cd ${KERNOBJDIR}/GENERIC ; ${TOOLDIR}/bin/nbmake-${MACHINE} dependall       2.   % ./build.sh [options] -U distribution
                Use the new toolchain to build a new GENERIC kernel.  
   
      ./build.sh -t -k GENERIC            Using unprivileged mode, build a complete distribution to a DDEESSTTDDIIRR
                Build a new toolchain, and use the new toolchain to configure            directory that bbuuiilldd..sshh selects (and will display).
                and build a new GENERIC kernel.  
   
      ./build.sh -U -d       3.   # ./build.sh [options] -U install=/
                Using unprivileged mode, build a complete distribution in  
                DESTDIR.  
   
      ./build.sh -U -R /some/dir/RELEASE            As root, install to _/ the distribution that was built by example 2.
                Using unprivileged mode, build a complete release in the speci-            Even though this is run as root, --UU is required so that the
                fied release directory.            permissions stored in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G are correctly applied to the
             files as they're copied to _/.
   
 OBSOLETE VARIABLES       4.   % ./build.sh [options] -U -u release
      NBUILDJOBS  Use the make(1) option -j, instead.  
   
      USE_NEW_TOOLCHAIN            Using unprivileged mode, build a complete release to DDEESSTTDDIIRR and
                  The new toolchain is now the default.  To disable, use            RREELLEEAASSEEDDIIRR directories that bbuuiilldd..sshh selects (and will display).
                  TOOLCHAIN_MISSING=yes.            MMKKUUPPDDAATTEE==yyeess (--uu) is set to prevent the ``make cleandir'', so that
             if this is run after example 2, it doesn't need to redo that portion
             of the release build.
   
   OOBBSSOOLLEETTEE VVAARRIIAABBLLEESS
        NNBBUUIILLDDJJOOBBSS  Use the make(1) option --jj instead.
   
 SEE ALSO       UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN
      make(1), hier(7), release(7)                   The new toolchain is now the default.  To disable, use
                    TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG==yyeess.
   
 HISTORY  SSEEEE AALLSSOO
      The build.sh based build scheme was introduced for NetBSD 1.6 as       make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8),
      USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.       _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s
   
 BUGS  HHIISSTTOORRYY
      A few platforms are not yet using this build system.       The bbuuiilldd..sshh based build scheme was introduced for NetBSD 1.6 as
        UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN, and re-worked to TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG after that.
   
 NetBSD                          January 4, 2003                             10  NetBSD                           May 25, 2012                           NetBSD

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.100

CVSweb <webmaster@jp.NetBSD.org>