[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.101.2.3 and 1.134

version 1.101.2.3, 2014/08/19 23:45:10 version 1.134, 2018/07/29 20:53:41
Line 1 
Line 1 
 BUILDING(8)                 System Manager's Manual                BUILDING(8)  BUILDING(8)                 System Manager's Manual                BUILDING(8)
   
 NAME  NAME
      BUILDING -- Procedure for building NetBSD from source code.       BUILDING - Procedure for building NetBSD from source code.
   
 REQUIREMENTS  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.
Line 9  REQUIREMENTS
Line 9  REQUIREMENTS
      same NetBSD architecture) or cross compiling (on another architecture or       same NetBSD architecture) or cross compiling (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
      host system to create a build toolchain for the target architecture.  The       system to create a build toolchain for the target architecture.  The host
      host system must have at least C and C++ compilers in order to create the       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 (make is not required); all other tools are created as part of
      the NetBSD build process.  (See the environment variables section below       the NetBSD build process.  (See the environment variables section below
      if you need to override or manually select your compilers.)       if you need to override or manually select your compilers.)
Line 29  FILES
Line 29  FILES
   
      Makefile       The main Makefile for NetBSD; should only be run for       Makefile       The main Makefile for NetBSD; should only be run for
                     native builds with an appropriately up-to-date version of                      native builds with an appropriately up-to-date version of
                     NetBSD make(1).  (For building from out-of-date systems or                      NetBSD make(1).  Intended for expert use with knowlege of
                     on a non-native host, see the build.sh shell script.)                      its shortcomings, it has been superseded by the build.sh
                       shell script as the recommended means for building NetBSD.
   
      UPDATING       Special notes for updating from an earlier revision of       UPDATING       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
Line 39  FILES
Line 40  FILES
      build.sh       Bourne-compatible shell script used for building the host       build.sh       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) as it performs additional checks to
                     recompiled regularly.                      prevent common issues going undetected, such as building
                       with an outdated version of make(1).
   
      crypto/dist/, dist/, gnu/dist/       crypto/dist/, dist/, gnu/dist/
                     Sources imported verbatim from third parties, without                      Sources imported verbatim from third parties, without
                     mangling the existing build structure.  Other source trees                      mangling the existing build structure.  Other source trees
                     in bin through usr.sbin use the NetBSD make(1)                      in 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.
   
      external, sys/external       external, sys/external
                     Sources and build infrastructure for components imported                      Sources and build infrastructure for components imported
Line 68  FILES
Line 70  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
                     status.                      status.
   
Line 77  FILES
Line 79  FILES
                     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.
   
      x11/           ``Reachover'' build structure for X11R6; the source is in       external/mit/xorg/
                     X11SRCDIR.                      "Reachover" build structure for modular Xorg; the source
                       is in X11SRCDIR.
   
        extsrc/        "Reachover" build structure for externally added programs
                       and libraries; the source is in EXTSRCSRCDIR.
   
    Build tree layout     Build tree layout
      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
Line 92  CONFIGURATION
Line 98  CONFIGURATION
                        suitable for use during the build.  The NetBSD build                         suitable for use during the build.  The NetBSD build
                        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-
                        standardised feature).                         standardised 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
                        such as ksh88, but not ksh93), or /usr/local/bin/bash.                         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
                        absolute path; however, build.sh allows it to be a                         absolute path; however, build.sh allows it to be a
Line 110  CONFIGURATION
Line 116  CONFIGURATION
   
      HOST_CXX          Path name to C++ compiler used to create the toolchain.       HOST_CXX          Path name to C++ compiler used to create the toolchain.
   
      MACHINE           Machine type, e.g., ``macppc''.       MACHINE           Machine type, e.g., "macppc".
   
      MACHINE_ARCH      Machine architecture, e.g., ``powerpc''.       MACHINE_ARCH      Machine architecture, e.g., "powerpc".
   
      MAKE              Path name to invoke make(1) as.       MAKE              Path name to invoke make(1) as.
   
Line 158  CONFIGURATION
Line 164  CONFIGURATION
                  configuration file in order to set additional build                   configuration file in order to set additional build
                  parameters, such as compiler flags.  It will also be used as                   parameters, such as compiler flags.  It will also be used as
                  part of the kernel version string, which can be printed by                   part of the kernel version string, which can be printed by
                  ``uname -v''.                   "uname -v".
   
                  Default: Unset.                   Default: Unset.
   
Line 167  CONFIGURATION
Line 173  CONFIGURATION
                  will be stored in the buildinfo variable in any kernels that                   will be stored in the buildinfo variable in any kernels that
                  are built.  When such kernels are booted, the sysctl(7)                   are built.  When such kernels are booted, the sysctl(7)
                  kern.buildinfo variable will report this value.  The string                   kern.buildinfo variable will report this value.  The string
                  may contain backslash escape sequences, such as ``\\''                   may contain backslash escape sequences, such as "\\"
                  (representing a backslash character) and ``\n'' (representing                   (representing a backslash character) and "\n" (representing a
                  a newline).                   newline).
   
                  Default: Unset.                   Default: Unset.
   
Line 188  CONFIGURATION
Line 194  CONFIGURATION
                  /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
                  a file system which supports long file names and hard links.                   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 otherwise.
                  otherwise.  
   
                  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.
   
        EXTSRCSRCDIR
                    Directory containing sources of externally added programs and
                    libraries.  If specified, must be an absolute path.
   
                    Default: NETBSDRCDIR/../extsrc, if that exists; otherwise
                    /usr/extsrc.
   
      MAKECONF    The name of the make(1) configuration file.  Only settable in       MAKECONF    The name of the make(1) configuration file.  Only settable in
                  the process environment.                   the process environment.
   
                  Default: ``/etc/mk.conf''                   Default: "/etc/mk.conf"
   
      MAKEVERBOSE       MAKEVERBOSE
                  Level of verbosity of status messages.  Supported values:                   Level of verbosity of status messages.  Supported values:
Line 218  CONFIGURATION
Line 230  CONFIGURATION
   
                  3    In addition to the above, all commands performed by                   3    In addition to the above, all commands performed by
                       make(1) are displayed, even if they would ordinarily                        make(1) are displayed, even if they would ordinarily
                       have been hidden through use of the ``@'' prefix in the                        have been hidden through use of the "@" prefix in the
                       relevant makefile.                        relevant makefile.
   
                  4    In addition to the above, commands executed by make(1)                   4    In addition to the above, commands executed by make(1)
                       are traced through use of the sh(1) ``-x'' flag.                        are traced through use of the sh(1) "-x" flag.
   
                  Default: 2                   Default: 2
   
      MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether       MKCATPAGES  Can be set to "yes" or "no".  Indicates whether preformatted
                  preformatted plaintext manual pages will be created during a                   plaintext manual pages will be created during a build.
                  build.  
   
                  Default: ``no''  
   
      MKCROSSGDB  Can be set to ``yes'' or ``no''.  Create a cross-gdb as a                   Default: "no"
                  host tool.  
   
                  Default: ``no''       MKCROSSGDB  Can be set to "yes" or "no".  Create a cross-gdb as a host
                    tool.
   
      MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether                   Default: "no"
                  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''       MKDEBUG     Can be set to "yes" or "no".  Indicates whether debug
   
      MKDEBUG     Can be set to ``yes'' or ``no''.  Indicates whether debug  
                  information should be generated for all userland binaries                   information should be generated for all userland binaries
                  compiled.  The result is collected as an additional debug.tgz                   compiled.  The result is collected as an additional debug.tgz
                  and xdebug.tgz set and installed in /usr/libdata/debug.                   and xdebug.tgz set and installed in /usr/libdata/debug.
   
                  Default: ``no''                   Default: "no"
   
      MKDEBUGLIB  Can be set to ``yes'' or ``no''.  Indicates whether debug       MKDEBUGLIB  Can be set to "yes" or "no".  Indicates whether debug
                  information (see MKDEBUG) should also be generated for all                   information (see MKDEBUG) should also be generated for all
                  libraries build.                   libraries built.
   
                  Default: ``no''                   Default: "no"
   
      MKDOC       Can be set to ``yes'' or ``no''.  Indicates whether system       MKDOC       Can be set to "yes" or "no".  Indicates whether system
                  documentation destined for DESTDIR/usr/share/doc will be                   documentation destined for DESTDIR/usr/share/doc will be
                  installed during a build.                   installed during a build.
   
                  Default: ``yes''                   Default: "yes"
   
        MKEXTSRC    Can be set to "yes" or "no".  Indicates whether extsrc is
                    built from EXTSRCSRCDIR.
   
      MKHTML      Can be set to ``yes'' or ``no''.  Indicates whether                   Default: "no"
                  preformatted HTML manual pages will be built and installed  
   
                  Default: ``yes''       MKHTML      Can be set to "yes" or "no".  Indicates whether preformatted
                    HTML manual pages will be built and installed
   
      MKHOSTOBJ   Can be set to ``yes'' or ``no''.  If set to ``yes'', then for                   Default: "yes"
   
        MKHOSTOBJ   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
                  ``make obj''.  (This allows multiple host systems to compile                   "make obj".  (This allows multiple host systems to compile
                  NetBSD for a single target.)  If set to ``no'', then programs                   NetBSD for a single target.)  If set to "no", then programs
                  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''                   Default: "no"
   
      MKINFO      Can be set to ``yes'' or ``no''.  Indicates whether GNU Info  
                  files, used for the documentation for most of the compilation  
                  tools, will be created and installed during a build.  
   
                  Default: ``yes''       MKINFO      Can be set to "yes" or "no".  Indicates whether GNU Info
                    files will be created and installed during a build.  GNU Info
      MKKDEBUG    Can be set to ``yes'' or ``no''.  Force generation of full-                   files are used for providing documentation by most of the
                  debug symbol versions of all kernels compiled.  Alongside of                   compilation tools.
                  the netbsd kernel file, an unstripped version netbsd.gdb is  
                    Default: "yes"
   
        MKKDEBUG    Can be set to "yes" or "no".  Force generation of full-debug
                    symbol versions of all kernels compiled.  Alongside of the
                    netbsd kernel file, an unstripped version netbsd.gdb is
                  created.  This is useful if a cross-gdb is built as well (see                   created.  This is useful if a cross-gdb is built as well (see
                  MKCROSSGDB).                   MKCROSSGDB).
   
                  Default: ``no''                   Default: "no"
   
      MKKMOD      Can be set to ``yes'' or ``no''.  Indicates whether kernel       MKKMOD      Can be set to "yes" or "no".  Indicates whether kernel
                  modules are built and installed.                   modules are built and installed.
   
                  Default: ``yes''                   Default: "yes"
   
      MKLINT      Can be set to ``yes'' or ``no''.  Indicates whether lint(1)       MKLINT      Can be set to "yes" or "no".  Indicates whether lint(1) will
                  will be run against portions of the NetBSD source code during                   be run against portions of the NetBSD source code during the
                  the build, and whether lint libraries will be installed into                   build, and whether lint libraries will be installed into
                  DESTDIR/usr/libdata/lint.                   DESTDIR/usr/libdata/lint.
   
                  Default: ``yes''                   Default: "yes"
   
      MKMAN       Can be set to ``yes'' or ``no''.  Indicates whether manual       MKMAN       Can be set to "yes" or "no".  Indicates whether manual pages
                  pages will be installed during a build.                   will be installed during a build.
   
                  Default: ``yes''                   Default: "yes"
   
      MKNLS       Can be set to ``yes'' or ``no''.  Indicates whether Native       MKNLS       Can be set to "yes" or "no".  Indicates whether Native
                  Language System locale zone files will be compiled and                   Language System locale zone files will be compiled and
                  installed during a build.                   installed during a build.
   
                  Default: ``yes''                   Default: "yes"
   
      MKOBJ       Can be set to ``yes'' or ``no''.  Indicates whether object       MKOBJ       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
                  set to ``no'', then all built files will be located inside                   to "no", then all built files will be located inside the
                  the regular source tree.                   regular source tree.
   
                  Default: ``yes''                   Default: "yes"
   
                  Note that setting MKOBJ to ``no'' is not recommended and may                   Note that setting MKOBJ to "no" is not recommended and may
                  cause problems when updating the tree with cvs(1).                   cause problems when updating the tree with cvs(1).
   
      MKPIC       Can be set to ``yes'' or ``no''.  Indicates whether shared       MKPIC       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                   Default: Platform dependent.  As of this writing, all
                  platforms except sh3 default to ``yes''.                   platforms except m68000 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)
                  format libraries (lib*_pic.a), used to generate shared                   format libraries (lib*_pic.a), used to generate shared
                  libraries, are installed during a build.                   libraries, are installed during a build.
   
                  Default: ``yes''                   Default: "yes"
   
      MKPROFILE   Can be set to ``yes'' or ``no''.  Indicates whether profiled       MKPROFILE   Can be set to "yes" or "no".  Indicates whether profiled
                  libraries (lib*_p.a) will be built and installed during a                   libraries (lib*_p.a) will be built and installed during a
                  build.                   build.
   
                  Default: ``yes''; however, some platforms turn off MKPROFILE                   Default: "yes"; however, some platforms turn off MKPROFILE by
                  by default at times due to toolchain problems with profiled                   default at times due to toolchain problems with profiled
                  code.                   code.
   
      MKREPRO     Can be set to ``yes'' or ``no''.  Create reproducable builds.       MKREPRO     Can be set to "yes" or "no".  Create reproducible builds.
                  This enables different switches to make two builds from the                   This enables different switches to make two builds from the
                  same source tree result in the same build results.                   same source tree result in the same build results.
   
                  Default: ``no''                   Default: "no" This may be set to "yes" by giving build.sh the
                    -P option.
   
        MKREPRO_TIMESTAMP
                    Unix timestamp.  When MKREPRO is set, the timestamp of all
                    files in the sets will be set to this value.
   
                    Default: Unset.  This may be set automatically to the latest
                    source tree timestamp using cvslatest(1) by giving build.sh
                    the -P option.
   
      MKSHARE     Can be set to ``yes'' or ``no''.  Indicates whether files       MKSHARE     Can be set to "yes" or "no".  Indicates whether files
                  destined to reside in DESTDIR/usr/share will be built and                   destined to reside in DESTDIR/usr/share will be built and
                  installed during a build.  If set to ``no'', then all of                   installed during a build.  If set to "no", then all of
                  MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to                   MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to
                  ``no'' unconditionally.                   "no" unconditionally.
   
                  Default: ``yes''                   Default: "yes"
   
      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
                  for use with ident(1), should be stripped from program                   use with ident(1), should be stripped from program binaries
                  binaries and shared libraries.                   and shared libraries.
   
                    Default: "no"
   
        MKSTRIPSYM  Can be set to "yes" or "no".  Indicates whether all local
                    symbols should be stripped from shared libraries.  If "yes",
                    strip all local symbols from shared libraries; the affect is
                    equivalent to the -x option of ld(1).  If "no", strip only
                    temporary local symbols; the affect is equivalent to the -X
                    option of ld(1).  Keeping non-temporary local symbols such as
                    static function names is useful on using DTrace for userland
                    libraries and getting a backtrace from a rump kernel loading
                    shared libraries.
   
                  Default: ``no''                   Default: "yes"
   
      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,
                  permissions, and file flags, will not be set on the installed                   permissions, 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
Line 379  CONFIGURATION
Line 409  CONFIGURATION
                  during the generation of the distribution tar files to ensure                   during the generation of the distribution tar files to ensure
                  that the appropriate file ownership is stored.                   that the appropriate file ownership is stored.
   
                  Default: ``no''                   Default: "no"
   
      MKUPDATE    Can be set to ``yes'' or ``no''.  Indicates whether all       MKUPDATE    Can be set to "yes" or "no".  Indicates whether all install
                  install operations intended to write to DESTDIR will compare                   operations intended to write to DESTDIR will compare file
                  file timestamps before installing, and skip the install phase                   timestamps before installing, and skip the install phase if
                  if the destination files are up-to-date.  This also has                   the destination files are up-to-date.  This also has
                  implications on full builds (see next subsection).                   implications on full builds (see next subsection).
   
                  Default: ``no''                   Default: "no"
   
      MKX11       Can be set to ``yes'' or ``no''.  Indicates whether X11 is       MKX11       Can be set to "yes" or "no".  Indicates whether X11 is built
                  built from X11SRCDIR.                   from X11SRCDIR.
   
                  Default: ``no''                   Default: "no"
   
      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
Line 405  CONFIGURATION
Line 435  CONFIGURATION
                  Default: Unset.                   Default: Unset.
   
      USETOOLS    Indicates whether the tools specified by TOOLDIR should be       USETOOLS    Indicates whether the tools specified by TOOLDIR 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
                  if cross-compiling.                   cross-compiling.
   
                  yes    Use the tools from TOOLDIR.                   yes    Use the tools from TOOLDIR.
   
Line 422  CONFIGURATION
Line 452  CONFIGURATION
                         may cause build or runtime problems when building the                          may cause build or runtime problems when building the
                         whole NetBSD source tree.                          whole NetBSD source tree.
   
                  Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''.                   Default: "yes", unless TOOLCHAIN_MISSING is set to "yes".
   
                  USETOOLS is also set to ``no'' when using <bsd.*.mk> outside                   USETOOLS is also set to "no" when using <bsd.*.mk> outside
                  the NetBSD source tree.                   the NetBSD source tree.
   
      X11SRCDIR   Directory containing the X11R6 source.  If specified, must be       X11SRCDIR   Directory containing the modular Xorg source.  If specified,
                  an absolute path.  The main X11R6 source is found in                   must be an absolute path.  The main modular Xorg source is
                  X11SRCDIR/xfree/xc.                   found in X11SRCDIR/external/mit.
   
                  Default: NETBSDRCDIR/../xsrc, if that exists; otherwise                   Default: NETBSDRCDIR/../xsrc, if that exists; otherwise
                  /usr/xsrc.                   /usr/xsrc.
   
      X11FLAVOUR  The style of X11 cross-built, set to either ``Xorg'' or  
                  ``XFree86''.  
   
                  Default: ``Xorg'' on amd64, i386, macppc, shark and sparc64  
                  platforms, ``XFree86'' on everything else.  
   
    "make" variables for full builds     "make" variables for full builds
      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       INSTALLWORLDDIR  Location for the "make installworld" target to install
                       to.  If specified, must be an absolute path.                        to.  If specified, must be an absolute path.
   
                       Default: ``/''                        Default: "/"
   
      MKOBJDIRS        Can be set to ``yes'' or ``no''.  Indicates whether       MKOBJDIRS        Can be set to "yes" or "no".  Indicates whether object
                       object directories will be created automatically (via a                        directories will be created automatically (via a "make
                       ``make obj'' pass) at the start of a build.                        obj" pass) at the start of a build.
   
                       Default: ``no''                        Default: "no"
   
                       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 addition
                       addition to the effects described for MKUPDATE=yes                        to the effects described for MKUPDATE=yes above, this
                       above, this implies the effects of NOCLEANDIR (i.e.,                        implies the effects of NOCLEANDIR (i.e., "make cleandir"
                       ``make cleandir'' is avoided).                        is avoided).
   
                       Default: ``no''                        Default: "no"
   
                       If using build.sh, this may be set by giving the -u                        If using build.sh, this may be set by giving the -u
                       option.                        option.
Line 473  CONFIGURATION
Line 497  CONFIGURATION
   
                       Default: Unset.                        Default: Unset.
   
      NOCLEANDIR       If set, avoids the ``make cleandir'' phase of a full       NOCLEANDIR       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.
Line 482  CONFIGURATION
Line 506  CONFIGURATION
   
                       See also MKUPDATE.                        See also MKUPDATE.
   
      NODISTRIBDIRS    If set, avoids the ``make distrib-dirs'' phase of a full       NODISTRIBDIRS    If set, avoids the "make distrib-dirs" phase of a full
                       build.  This skips running mtree(8) on DESTDIR, useful                        build.  This skips running mtree(8) on DESTDIR, 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
Line 490  CONFIGURATION
Line 514  CONFIGURATION
   
                       Default: Unset.                        Default: Unset.
   
      NOINCLUDES       If set, avoids the ``make includes'' phase of a full       NOINCLUDES       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                        thinking that some programs are out-of-date simply
                       because the system include files have changed.  However,                        because the system include files have changed.  However,
Line 501  CONFIGURATION
Line 525  CONFIGURATION
                       Default: Unset.                        Default: Unset.
   
      RELEASEDIR       If set, specifies the directory to which a release(7)       RELEASEDIR       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.                        If specified, must be an absolute path.
   
                       Default: Unset.                        Default: Unset.
Line 521  BUILDING
Line 545  BUILDING
      -m dir     Specify the default directory for searching for system       -m dir     Specify the default directory for searching for system
                 Makefile segments, mainly the <bsd.*.mk> files.  When building                  Makefile segments, mainly the <bsd.*.mk> files.  When building
                 any full NetBSD source tree, this should be set to the                  any 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
                 automatically when building from the top level, or when using                  automatically when building from the top level, or when using
                 build.sh.                  build.sh.
   
Line 539  BUILDING
Line 563  BUILDING
    "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
      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.       all        Build programs, libraries, and preformatted documentation.
   
      clean      Remove program and library object code files.       clean      Remove program and library object code files.
   
      cleandir   Same as clean, but also remove preformatted documentation,       cleandir   Same as clean, but also remove preformatted documentation,
                 dependency 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.                  files known to be created at build time.
   
      depend     Create dependency files (.depend) containing more detailed       depend     Create dependency files (.depend) containing more detailed
Line 555  BUILDING
Line 579  BUILDING
                 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''.       dependall  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.
   
Line 586  BUILDING
Line 610  BUILDING
                    orders portions of the source tree such that prerequisites                     orders portions of the source tree such that prerequisites
                    will be built in the proper order.                     will be built in the proper order.
   
      distribution  Do a ``make build'', and then install a full distribution       distribution  Do a "make build", and then install a full distribution
                    (which does not include a kernel) into DESTDIR, including                     (which does not include a kernel) into DESTDIR, including
                    files in DESTDIR/dev, DESTDIR/etc, DESTDIR/root and                     files in DESTDIR/dev, DESTDIR/etc, DESTDIR/root and
                    DESTDIR/var.                     DESTDIR/var.
   
      buildworld    As per ``make distribution'', except that it ensures that       buildworld    As per "make distribution", except that it ensures that
                    DESTDIR is not the root directory.                     DESTDIR is not the root directory.
   
      installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR,       installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR,
Line 601  BUILDING
Line 625  BUILDING
   
                    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
                    default, all sets except ``etc'' and ``xetc'' are                     default, all sets except "etc" and "xetc" are installed, so
                    installed, so most files in INSTALLWORLDDIR/etc will not be                     most files in INSTALLWORLDDIR/etc will not be installed or
                    installed or modified.                     modified.
   
                    Note: Before performing this operation with                     Note: Before performing this operation with
                    INSTALLWORLDDIR=/, it is highly recommended that you                     INSTALLWORLDDIR=/, it is highly recommended that you
Line 614  BUILDING
Line 638  BUILDING
   
      sets          Create distribution sets from DESTDIR into       sets          Create distribution sets from DESTDIR into
                    RELEASEDIR/RELEASEMACHINEDIR/binary/sets.  Should be run                     RELEASEDIR/RELEASEMACHINEDIR/binary/sets.  Should be run
                    after ``make distribution'', as ``make build'' alone does                     after "make distribution", as "make build" alone does not
                    not install all of the required files.                     install all of the required files.
   
      sourcesets    Create source sets of the source tree into       sourcesets    Create source sets of the source tree into
                    RELEASEDIR/source/sets.                     RELEASEDIR/source/sets.
   
      syspkgs       Create syspkgs from DESTDIR into       syspkgs       Create syspkgs from DESTDIR into
                    RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs.  Should be run                     RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs.  Should be run
                    after ``make distribution'', as ``make build'' alone does                     after "make distribution", as "make build" alone does not
                    not install all of the required files.                     install all of the required files.
   
      release       Do a ``make distribution'', build kernels, distribution       release       Do a "make distribution", build kernels, distribution
                    media, and install sets (this as per ``make sets''), and                     media, and install sets (this as per "make sets"), and then
                    then package the system into a standard release layout as                     package the system into a standard release layout as
                    described by release(7).  This requires that RELEASEDIR be                     described by release(7).  This requires that RELEASEDIR be
                    set (see above).                     set (see above).
   
      iso-image     Create a NetBSD installation CD-ROM image in the       iso-image     Create a NetBSD installation CD-ROM image in the
                    RELEASEDIR/iso directory.  The CD-ROM file system will have                     RELEASEDIR/images directory.  The CD-ROM file system will
                    a layout as described in release(7).                     have 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
Line 642  BUILDING
Line 666  BUILDING
                    tools that may be useful in repairing a damaged NetBSD                     tools that 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
                    directory by ``make release''.  These smaller images                     directory 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/images, but do not contain additional content
                    as the distribution sets.                     such 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)
Line 659  BUILDING
Line 683  BUILDING
   
      iso-image-source       iso-image-source
                    Create a NetBSD installation CD-ROM image in the                     Create a NetBSD installation CD-ROM image in the
                    RELEASEDIR/iso directory.  The CD-ROM file system will have                     RELEASEDIR/images directory.  The CD-ROM file system will
                    a layout as described in release(7).  It will have top                     have a layout as described in release(7).  It will have top
                    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
Line 670  BUILDING
Line 694  BUILDING
                    tools that may be useful in repairing a damaged NetBSD                     tools that 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
                    equivalent.                     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
                    directory by ``make release''.  These smaller images                     directory 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/images, but do not contain additional content
                    as the distribution sets.                     such 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)
Line 688  BUILDING
Line 712  BUILDING
   
      install-image       install-image
                    Create a bootable NetBSD installation disk image in the                     Create a bootable NetBSD installation disk image in the
                    RELEASEDIR/RELEASEMACHINEDIR/installation/installimage                     RELEASEDIR/images directory.  The installation disk image
                    directory.  The installation disk image is suitable for                     is suitable for copying to bootable USB flash memory
                    copying to bootable USB flash memory sticks, etc., for                     sticks, etc., for machines which are able to boot from such
                    machines which are able to boot from such devices.  The                     devices.  The file system in the bootable disk image will
                    file system in the bootable disk image will have a layout                     have a layout as described in release(7).
                    as described in release(7).  
   
                    The installation image is bootable, and will automatically                     The installation image is bootable, and will automatically
                    run the sysinst(8) menu-based installation program, which                     run the sysinst(8) menu-based installation program, which
Line 701  BUILDING
Line 724  BUILDING
                    image also contains tools that may be useful in repairing a                     image also contains tools that may be useful in repairing a
                    damaged NetBSD installation.                     damaged NetBSD installation.
   
                    Before ``make install-image'' is attempted, RELEASEDIR must                     Before "make install-image" is attempted, RELEASEDIR must
                    be populated by ``make release'' or equivalent.  The build                     be populated by "make release" or equivalent.  The build
                    must have been performed with MKUNPRIVED=yes because ``make                     must have been performed with MKUNPRIVED=yes because "make
                    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/images
                    RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage  
                    directory.  The live image contains all necessary files to                     directory.  The live image contains all necessary files to
                    boot NetBSD up to multi-user mode, including all files                     boot NetBSD up to multi-user mode, including all files
                    which should be extracted during installation, NetBSD                     which should be extracted during installation, NetBSD
Line 718  BUILDING
Line 740  BUILDING
                    to boot NetBSD from a USB flash memory stick on a real                     to 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
                    populated by ``make release'' or equivalent.  The build                     populated by "make release" or equivalent.  The build must
                    must have been performed with MKUNPRIVED=yes because ``make                     have been performed with MKUNPRIVED=yes because "make
                    install-image'' relies on information in DESTDIR/METALOG.                     install-image" relies on information in DESTDIR/METALOG.
   
      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
                    tests on the local host.  Note that most tests are now                     on the local host.  Note that most tests are now managed
                    managed instead using atf(7); this target should probably                     instead using atf(7); this target should probably run those
                    run those as well but currently does not.                     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
Line 758  BUILDING
Line 780  BUILDING
      of sh found in PATH.       of sh found in PATH.
   
      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
      system 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 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 769  BUILDING
Line 791  BUILDING
   
      The following operations are supported by build.sh:       The following operations are supported by build.sh:
   
      build         Build the system as per ``make build''.  Before the main       build         Build the system as per "make build".  Before the main part
                    part of the build commences, this command runs the obj                     of the build commences, this command runs the obj operation
                    operation (unless the -o option is given), ``make                     (unless the -o option is given), "make cleandir" (unless
                    cleandir'' (unless the -u option is given), and the tools                     the -u option is given), and the tools operation.
                    operation.  
   
      distribution  Build a full distribution as per ``make distribution''.       distribution  Build a full distribution as per "make distribution".  This
                    This command first runs the build operation.                     command first runs the build operation.
   
      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
                    automatically performed for any of the other operations.                     automatically 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
                    command will first run ``make obj'' and ``make cleandir''                     command 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
                    (respectively) are given.                     (respectively) 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 "etc"
                    ``etc'' or ``xetc'' sets will not be installed, unless                     or "xetc" sets will not be installed, unless overridden by
                    overridden by the INSTALLSETS environment variable.                     the INSTALLSETS environment variable.
   
      kernel=kconf  Build a new kernel.  The kconf argument is the name of a       kernel=kconf  Build a new kernel.  The kconf argument is the name of a
                    configuration file suitable for use by config(1).  If kconf                     configuration file suitable for use by config(1).  If kconf
Line 810  BUILDING
Line 831  BUILDING
                    tools command first unless it is certain that the tools                     tools command first unless it is certain that the tools
                    already exist and are up to date.                     already exist and are up to date.
   
                    This command will run ``make cleandir'' on the kernel in                     This command will run "make cleandir" on the kernel in
                    question first unless the -u option is given.                     question first unless the -u option is given.
   
      kernel.gdb=kconf       kernel.gdb=kconf
Line 820  BUILDING
Line 841  BUILDING
                    symbol table and can be used for debugging (for example                     symbol table and can be used for debugging (for example
                    with a cross-gdb built by MKCROSSGDB).                     with a cross-gdb built by MKCROSSGDB).
   
        kernels       This command will build all kernels defined in port
                      specific release build procedure.
   
                      This command internally calls the kernel=kconf operation
                      for each found kernel configuration file.
   
      modules       This command will build kernel modules and install them       modules       This command will build kernel modules and install them
                    into DESTDIR.                     into DESTDIR.
   
Line 827  BUILDING
Line 854  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 determined
                    determined from the ``config'' directives in kconf.                     from the "config" directives in kconf.
   
      sets          Perform ``make sets''.       sets          Perform "make sets".
   
      sourcesets    Perform ``make sourcesets''.       sourcesets    Perform "make sourcesets".
   
      syspkgs       Perform ``make syspkgs''.       syspkgs       Perform "make syspkgs".
   
      iso-image     Perform ``make iso-image''.       iso-image     Perform "make iso-image".
   
      iso-image-source       iso-image-source
                    Perform ``make iso-image-source''.                     Perform "make iso-image-source".
   
      install-image       install-image
                    Perform ``make install-image''.                     Perform "make install-image".
   
      live-image    Perform ``make live-image''.       live-image    Perform "make live-image".
   
      list-arch     Prints a list of valid MACHINE and MACHINE_ARCH settings,       list-arch     Prints a list of valid MACHINE and MACHINE_ARCH settings,
                    the default MACHINE_ARCH for each MACHINE, and aliases for                     the default MACHINE_ARCH for each MACHINE, and aliases for
                    MACHINE/MACHINE_ARCH pairs, and then exits.  The -m or -a                     MACHINE/MACHINE_ARCH pairs, and then exits.  The -m or -a
                    options (or both) may be used to specify glob patterns that                     options (or both) may be used to specify glob patterns that
                    will be used to narrow the list of results; for example,                     will be used to narrow the list of results; for example,
                    ``build.sh -m 'evm*' -a '*arm*' list-arch'' will list all                     "build.sh -m 'evb*' -a '*arm*' list-arch" will list all
                    known MACHINE/MACHINE_ARCH values in which either MACHINE                     known MACHINE/MACHINE_ARCH values in which either MACHINE
                    or ALIAS matches the pattern `evb*', and MACHINE_ARCH                     or ALIAS matches the pattern `evb*', and MACHINE_ARCH
                    matches the pattern `*arm*'.                     matches the pattern `*arm*'.
Line 864  BUILDING
Line 891  BUILDING
   
      -B buildid       -B buildid
                Set the value of BUILDID to buildid.  This will also append the                 Set the value of BUILDID to buildid.  This will also append the
                build identifier to the name of the ``make'' wrapper script so                 build identifier to the name of the "make" wrapper script so
                that the resulting name is of the form                 that the resulting name is of the form
                ``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-
                separated list of files or directories that will be added to                 separated list of files or directories that will be added to
                the CD-ROM image that may be create by the ``iso-image'' or                 the 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
                root of the CD-ROM image, whereas directories will be copied                 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
                converted to absolute paths before being used.  Multiple paths                 converted to absolute paths before being used.  Multiple paths
                may be specified via multiple -C options, or via a single                 may be specified via multiple -C options, or via a single
Line 903  BUILDING
Line 930  BUILDING
                Use lower values on machines with limited memory or I/O                 Use 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"
                obj'' for more information.                 for more information.
   
                For instance, if the source directory is /usr/src, a setting of                 For instance, if the source directory is /usr/src, a setting of
                ``-M /usr/obj'' will place build-time files under                 "-M /usr/obj" will place build-time files under
                /usr/obj/usr/src/bin, /usr/obj/usr/src/lib,                 /usr/obj/usr/src/bin, /usr/obj/usr/src/lib,
                /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
                restriction that the argument to the -M option must not begin                 restriction that the argument to the -M option must not begin
                with a ``$'' (dollar sign) character; otherwise it would be too                 with a "$" (dollar sign) character; otherwise it would be too
                difficult to determine whether the value is an absolute or a                 difficult to determine whether the value is an absolute or a
                relative path.  If the directory does not already exist,                 relative path.  If the directory does not already exist,
                build.sh will create it.                 build.sh will create it.
Line 934  BUILDING
Line 961  BUILDING
                MACHINE and MACHINE_ARCH settings.                 MACHINE and MACHINE_ARCH settings.
   
      -N noiselevel       -N noiselevel
                Set the ``noisyness'' level of the build, by setting                 Set the "noisyness" level of the build, by setting MAKEVERBOSE
                MAKEVERBOSE to noiselevel.                 to noiselevel.
   
      -n        Show the commands that would be executed by build.sh, but do       -n        Show the commands that would be executed by build.sh, 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       -O obj    Create an appropriate transform macro for MAKEOBJDIR that will
                place the built object files under obj.  Unsets                 place the built object files under obj.  Unsets
                MAKEOBJDIRPREFIX.                 MAKEOBJDIRPREFIX.
   
                For instance, a setting of ``-O /usr/obj'' will place build-                 For instance, a setting of "-O /usr/obj" will place build-time
                time files under /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin,                 files under /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and
                and so forth.                 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
                restriction that the argument to the -O option must not contain                 restriction that the argument to the -O option must not contain
                a ``$'' (dollar sign) character.  If the directory does not                 a "$" (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 965  BUILDING
Line 991  BUILDING
   
                Note that placing the obj directory location outside of the                 Note that placing the obj directory location outside of the
                default source tree hierarchy makes it easier to manually clear                 default source tree hierarchy makes it easier to manually clear
                out old files in the event the ``make cleandir'' operation is                 out old files in the event the "make cleandir" operation is
                unable to do so.  (See CAVEATS below.)                 unable to do so.  (See CAVEATS below.)
   
                Note also that use of one of -M or -O is the only means of                 Note also that use of one of -M or -O is the only means of
Line 973  BUILDING
Line 999  BUILDING
                source tree without cleaning between builds (in which case, one                 source tree without cleaning between builds (in which case, one
                would specify distinct obj locations for each).                 would specify distinct obj locations for each).
   
      -o        Set the value of MKOBJDIRS to ``no''.  Otherwise, it will be       -o        Set the value of MKOBJDIRS to "no".  Otherwise, it will be
                automatically set to ``yes''.  This default is opposite to the                 automatically set to "yes".  This default is opposite to the
                behaviour when not using build.sh.                 behaviour when not using build.sh.
   
      -R rel    Set the value of RELEASEDIR to rel.  If a relative path is       -R rel    Set the value of RELEASEDIR to rel.  If a relative path is
Line 990  BUILDING
Line 1016  BUILDING
   
      -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
                specified, it will be converted to an absolute path before                 specified, it will be converted to an absolute path before
                being used.  If set, the bootstrap ``make'' will only be                 being used.  If set, the bootstrap "make" will only be rebuilt
                rebuilt if the source files for make(1) have changed.                 if the source files for make(1) have changed.
   
      -U        Set MKUNPRIVED=yes.       -U        Set MKUNPRIVED=yes.
   
Line 1016  BUILDING
Line 1042  BUILDING
   
      -x        Set MKX11=yes.       -x        Set MKX11=yes.
   
        -Y extsrcdir
                  Set the value of EXTSRCSRCDIR to extsrcdir.  If a relative path
                  is specified, it will be converted to an absolute path before
                  being used.
   
        -y        Set MKEXTSRC=yes.
   
      -Z var    Unset ("zap") the environment variable var.  This is propagated       -Z var    Unset ("zap") the environment variable var.  This is propagated
                to the nbmake wrapper.                 to the nbmake wrapper.
   
Line 1025  BUILDING
Line 1058  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
      several key variables pre-set, including MACHINE, MACHINE_ARCH, and       several key variables pre-set, including MACHINE, MACHINE_ARCH, and
      TOOLDIR.  nbmake-MACHINE will also set variables specified with -V, and       TOOLDIR.  nbmake-MACHINE will also set variables specified with -V, and
      unset variables specified with -Z.       unset variables specified with -Z.
Line 1055  EXAMPLES
Line 1088  EXAMPLES
   
           Using unprivileged mode, build a complete release to DESTDIR and            Using unprivileged mode, build a complete release to DESTDIR and
           RELEASEDIR directories that build.sh selects (and will display).            RELEASEDIR directories that build.sh selects (and will display).
           MKUPDATE=yes (-u) is set to prevent the ``make cleandir'', so that            MKUPDATE=yes (-u) is set to prevent the "make cleandir", so that if
           if this is run after example 2, it doesn't need to redo that portion            this is run after example 2, it doesn't need to redo that portion of
           of the release build.            the release build.
   
 OBSOLETE VARIABLES  OBSOLETE VARIABLES
      NBUILDJOBS  Use the make(1) option -j instead.       NBUILDJOBS  Use the make(1) option -j instead.
Line 1076  HISTORY
Line 1109  HISTORY
   
 CAVEATS  CAVEATS
      After significant updates to third-party components in the source tree,       After significant updates to third-party components in the source tree,
      the ``make cleandir'' operation may be insufficient to clean out old       the "make cleandir" operation may be insufficient to clean out old files
      files in object directories.  Instead, one may have to manually remove       in object directories.  Instead, one may have to manually remove the
      the files.  Consult the UPDATING file for notices concerning this.       files.  Consult the UPDATING file for notices concerning this.
   
 NetBSD                          August 7, 2014                          NetBSD  NetBSD                           July 29, 2018                          NetBSD

Legend:
Removed from v.1.101.2.3  
changed lines
  Added in v.1.134

CVSweb <webmaster@jp.NetBSD.org>