[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.17 and 1.79

version 1.17, 2002/11/25 19:18:44 version 1.79, 2008/11/09 23:02:28
Line 1 
Line 1 
 BUILDING(8)             NetBSD System Manager's Manual             BUILDING(8)  BUILDING(8)             NetBSD System Manager's Manual             BUILDING(8)
   
 NAME  NAME
      BUILDING - Procedure for building NetBSD from source code.       BUILDING -- Procedure for building NetBSD from source code.
   
 STATUS  
      This document is a work-in-progress.  As such, the information described  
      here may not match the reality of the build system as of this writing.  
      Once this document is completely in sync with reality, this paragraph  
      will be removed.  
   
      Discrepancies between this documentation and the current reality of 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  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 28  REQUIREMENTS
Line 13  REQUIREMENTS
      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 (make 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  
            extensions and need to be standardized.  As a result, cross-compil-  
            ing from systems other than NetBSD is not currently supported.  
   
 FILES  FILES
    Source tree layout     Source tree layout
   
      doc/BUILDING.mdoc       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).       BUILDING       This document (in plaintext).
   
      Makefile       The main Makefile for NetBSD; should only be run for na-       tools/compat/README
                     tive builds with an appropriately up-to-date version of                      Special notes for cross-hosting a NetBSD build on non-
                       NetBSD platforms.
   
        Makefile       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 build.sh shell script.)
   
Line 62  FILES
Line 46  FILES
                     Sources imported verbatim from third parties, without man-                      Sources imported verbatim from third parties, without man-
                     gling the existing build structure.  Other source trees in                      gling the existing build structure.  Other source trees in
                     bin through usr.sbin use the NetBSD make(1) ``reachover''                      bin through usr.sbin use the NetBSD make(1) ``reachover''
                     Makefile semantics when building these programs for a na-                      Makefile semantics when building these programs for a
                     tive host.                      native host.
   
      distrib/, etc/       distrib/, etc/
                     Sources for items used when making a full release snap-                      Sources for items used when making a full release snap-
                     shot, such as files installed in /etc on the destination                      shot, such as files installed in DESTDIR/etc on the desti-
                     system, boot media, and release notes.                      nation system, boot media, and release notes.
   
      regress/       Regression test harness.  Can be cross-compiled, but only       tests/, regress/
                     run natively.                      Regression test harness.  Can be cross-compiled, but only
                       run natively.  tests/ uses the atf(7) test framework;
                       regress/ contains older tests that have not yet been
                       migrated to atf(7).
   
      sys/           NetBSD kernel sources.       sys/           NetBSD kernel sources.
   
Line 84  FILES
Line 71  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
                       X11SRCDIR.
   
    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
      described in release(7).       described in release(7).
Line 92  CONFIGURATION
Line 82  CONFIGURATION
    Environment variables     Environment variables
      Several environment variables control the behaviour of NetBSD builds.       Several environment variables control the behaviour of NetBSD builds.
   
      MACHINE           Machine type.       HOST_SH           Path name to a POSIX-compliant shell.  If this is not
                          set explicitly, then the default is set using heuris-
                          tics dependent on the host platform, or from the shell
                          under which build.sh is executed (if that can be deter-
                          mined), or using the first copy of sh found in PATH.
                          If the host system's /bin/sh is not POSIX-compliant, we
                          suggest that you build using commands like
   
                                HOST_SH=/path/to/working/shell
                                export HOST_SH
                                ${HOST_SH} build.sh [options]
   
      MACHINE_ARCH      Machine architecture.       HOST_CC           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_ARCH      Machine architecture, e.g., ``powerpc''.
   
      MAKE              Path name to invoke make(1) as.       MAKE              Path name to invoke make(1) as.
   
      MAKEFLAGS         Flags to invoke make(1) with.       MAKEFLAGS         Flags to invoke make(1) with.
   
      MAKEOBJDIR        Directory to use as the .OBJDIR for the current direc-       MAKEOBJDIR        Directory to use as the .OBJDIR for the current direc-
                        tory.  Used only if MAKEOBJDIRPREFIX is not defined.                         tory.  The value is subjected to variable expansion by
                        MAKEOBJDIR can only be provided in the environment.                         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 .OBJDIR from
                          the value of .CURDIR.  Used only if MAKEOBJDIRPREFIX is
                          not defined.  MAKEOBJDIR can be provided only in the
                          environment or via the -O flag of build.sh; it cannot
                          usefully be set inside a Makefile.
   
      MAKEOBJDIRPREFIX  Top level directory of the object directory tree.  If       MAKEOBJDIRPREFIX  Top level directory of the object directory tree.  If
                        this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used                         specified, must be an absolute path.  If this is
                        as the .OBJDIR for the current directory.  The current                         defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the
                        directory may be read only.  MAKEOBJDIRPREFIX can only                         .OBJDIR for the current directory.  The current direc-
                        be provided in the environment.                         tory may be read only.  MAKEOBJDIRPREFIX can be pro-
                          vided only in the environment or via the -M flag of
                          build.sh; it cannot usefully be set inside a Makefile.
   
    "make" variables     "make" variables
      Several variables control the behavior of NetBSD builds.  Unless other-       Several variables control the behavior of NetBSD builds.  Unless other-
Line 120  CONFIGURATION
Line 134  CONFIGURATION
                  configuration file in order to set additional build parame-                   configuration file in order to set additional build parame-
                  ters, such as compiler flags.                   ters, such as compiler flags.
   
        BUILDSEED   GCC uses random numbers when compiling C++ code.  This vari-
                    able seeds the gcc random number generator using the -fran-
                    dom-seed flag with this value.  By default, it is set to
                    NetBSD-(majorversion).  Using a fixed value causes C++ bina-
                    ries to be the same when built from the same sources.  Addi-
                    tional information is available in the GCC documentation of
                    -frandom-seed.
   
      DESTDIR     Directory to contain the built NetBSD system.  If set, spe-       DESTDIR     Directory to contain the built NetBSD system.  If set, spe-
                  cial options are passed to the compilation tools to prevent                   cial options are passed to the compilation tools to prevent
                  their default use of the host system's /usr/include,                   their default use of the host system's /usr/include,
                  /usr/lib, and so forth.  This pathname should not end with a                   /usr/lib, and so forth.  This pathname must be an absolute
                  slash (/) character (for installation into the system's root                   path, and should not end with a slash (/) character.  (For
                  directory, set DESTDIR to an empty string).  The directory                   installation into the system's root directory, set DESTDIR to
                  must reside on a file system which supports long file names                   an empty string, not to ``/'').  The directory must reside on
                  and hard links.                   a file system which supports long file names and hard links.
   
                  Default: Empty string if USETOOLS is ``yes''; unset other-                   Default: Empty string if USETOOLS is ``yes''; unset other-
                  wise.                   wise.
   
                    Note: build.sh will provide a default of destdir.MACHINE (in
                    the top-level .OBJDIR) unless run in `expert' mode.
   
      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
                    Level of verbosity of status messages.  Supported values:
   
                    0    No descriptive messages are shown.
   
                    1    Descriptive messages are shown.
   
                    2    Descriptive messages (prefixed with a `#') and command
                         output is not suppressed.
   
                    Default: 2
   
      MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether prefor-       MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether prefor-
                  matted plaintext manual pages will be created during a build.                   matted plaintext manual pages will be created during a build.
   
Line 145  CONFIGURATION
Line 182  CONFIGURATION
      MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether crypto-       MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether crypto-
                  graphic code will be included in a build; provided for the                   graphic code will be included in a build; provided for the
                  benefit of countries that do not allow strong cryptography.                   benefit of countries that do not allow strong cryptography.
                  Will not affect use of the standard low-security password en-                   Will not affect use of the standard low-security password
                  cryption system, crypt(3).                   encryption system, crypt(3).
   
                  Default: ``yes''                   Default: ``yes''
   
      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 /usr/share/doc will be installed                   documentation destined for DESTDIR/usr/share/doc will be
                  during a build.                   installed during a build.
   
                    Default: ``yes''
   
        MKHTML      Can be set to ``yes'' or ``no''.  Indicates whether prefor-
                    matted HTML manual pages will be built and installed
   
                  Default: ``yes''                   Default: ``yes''
   
Line 176  CONFIGURATION
Line 218  CONFIGURATION
      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 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.                   DESTDIR/usr/libdata/lint.
   
                  Default: ``yes''                   Default: ``yes''
   
Line 186  CONFIGURATION
Line 228  CONFIGURATION
                  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 in-                   Language System locale zone files will be compiled and
                  stalled during a build.                   installed during a build.
   
                  Default: ``yes''                   Default: ``yes''
   
Line 198  CONFIGURATION
Line 240  CONFIGURATION
   
                  Default: ``yes''                   Default: ``yes''
   
                    Note that setting MKOBJ to ``no'' is not recommended and may
                    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
Line 208  CONFIGURATION
Line 253  CONFIGURATION
   
      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 li-                   format libraries (lib*_pic.a), used to generate shared
                  braries, are installed during a build.                   libraries, are installed during a build.
   
                  Default: ``yes''                   Default: ``yes''
   
Line 222  CONFIGURATION
Line 267  CONFIGURATION
                  code.                   code.
   
      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 /usr/share will be built and installed                   destined to reside in DESTDIR/usr/share will be built and
                  during a build.  If set to ``no'', then all of MKCATPAGES,                   installed during a build.  If set to ``no'', then all of
                  MKDOC, MKINFO, MKMAN, and MKNLS will be set to ``no'' uncon-                   MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to
                  ditionally.                   ``no'' unconditionally.
   
                  Default: ``yes''                   Default: ``yes''
   
      TOOLDIR     Directory to hold the host tools, once built.  This directory       MKSTRIPIDENT
                  should be unique to a given host system and NetBSD source                   Can be set to ``yes'' or ``no''.  Indicates whether program
                  tree.  (However, multiple targets may share the same TOOLDIR;                   binaries and shared libraries should be built to include RCS
                  the target-dependent files have unique names.)  If unset, a                   IDs for use with ident(1).
                  default based on the uname(1) information of the host plat-  
                  form will be created in the .OBJDIR of src/tools.  
   
                  Default: Unset.                   Default: ``no''
   
      UNPRIVED    If set, then an unprivileged install will occur.  The user,       MKTTINTERP  Can be set to ``yes'' or ``no''.  For X builds, decides if
                  group, permissions, and file flags, will not be set on the                   the TrueType bytecode interpreter is turned on.  See
                  installed item; instead the information will be appended to a                   http://www.freetype.org/patents.html for details.
                  file called METALOG in DESTDIR.  The contents of METALOG is  
                  used during the generation of the distribution tar files to  
                  ensure that the appropriate file ownership is stored.  
   
                  Default: Unset.                   Default: ``no''
   
        MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an
                    unprivileged install will occur.  The user, group, permis-
                    sions, and file flags, will not be set on the installed
                    items; instead the information will be appended to a file
                    called METALOG in DESTDIR.  The contents of METALOG are used
                    during the generation of the distribution tar files to ensure
                    that the appropriate file ownership is stored.
   
                    Default: ``no''
   
        MKUPDATE    Can be set to ``yes'' or ``no''.  Indicates whether all
                    install operations intended to write to DESTDIR 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).
   
                    Default: ``no''
   
        MKX11       Can be set to ``yes'' or ``no''.  Indicates whether X11 is
                    built from X11SRCDIR.
   
      UPDATE      If set, then all install operations intended to write to                   Default: ``no''
                  DESTDIR will compare file timestamps before installing, and  
                  skip the install phase if the destination files are up-to-       TOOLDIR     Directory to hold the host tools, once built.  If specified,
                  date.  This also has implications on full builds (see next                   must be an absolute path.  This directory should be unique to
                  subsection).                   a given host system and NetBSD source tree.  (However, multi-
                    ple targets may share the same TOOLDIR; 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 .OBJDIR of src.
   
                  Default: Unset.                   Default: Unset.
   
Line 273  CONFIGURATION
Line 338  CONFIGURATION
                         build or runtime problems when building the whole                          build or runtime problems when building the whole
                         NetBSD source tree.                          NetBSD source tree.
   
                  Default: ``yes'' if building all or part of a whole NetBSD                   Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''.
                  source tree (detected automatically); ``no'' otherwise (to  
                  preserve traditional semantics of the <bsd.*.mk> make(1) in-                   USETOOLS is also set to ``no'' when using <bsd.*.mk> outside
                  clude files).                   the NetBSD source tree.
   
        X11SRCDIR   Directory containing the X11R6 source.  If specified, must be
                    an absolute path.  The main X11R6 source is found in
                    X11SRCDIR/xfree/xc.
   
                    Default: ``/usr/xsrc''
   
        X11FLAVOUR  The style of X11 cross-built, set to either ``Xorg'' or
                    ``XFree86''.
   
                    Default: ``Xorg'' on amd64, i386, macppc, shark, sparc 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.
   
      MKOBJDIRS      Can be set to ``yes'' or ``no''.  Indicates whether object       INSTALLWORLDDIR  Location for the ``make installworld'' target to install
                     directories will be created automatically (via a ``make                        to.  If specified, must be an absolute path.
                     obj'' pass) at the start of a build.  
                         Default: ``/''
   
        MKOBJDIRS        Can be set to ``yes'' or ``no''.  Indicates whether
                         object directories will be created automatically (via a
                         ``make obj'' pass) at the start of a build.
   
                         Default: ``no''
   
                     Default: ``yes''                        If using build.sh, the default is ``yes''.  This may be
                         set back to ``no'' by giving build.sh the -o option.
   
      NBUILDJOBS     Now obsolete.  Use the make(1) option -j, instead (see be-       MKUPDATE         Can be set to ``yes'' or ``no''.  If set, then in addi-
                     low)                        tion to the effects described for MKUPDATE=yes above,
                         this implies the effects of NOCLEANDIR (i.e., ``make
                         cleandir'' is avoided).
   
                     Default: Unset.                        Default: ``no''
   
      NOCLEANDIR     If set, avoids the ``make cleandir'' phase of a full                        If using build.sh, this may be set by giving the -u
                     build.  This has the effect of allowing only changed files                        option.
                     in a source tree to be recompiled.  This can speed up  
                     builds when updating only a few files in the tree.  
   
                     Default: Unset.       NBUILDJOBS       Now obsolete.  Use the make(1) option -j, instead.  See
                         below.
   
      NODISTRIBDIRS  If set, avoids the ``make distrib-dirs'' phase of a full                        Default: Unset.
                     build.  This skips running mtree(8) on DESTDIR, useful on  
                     systems where building as an unprivileged user, or where  
                     it is known that the system-wide mtree files have not  
                     changed.  
   
                     Default: Unset.       NOCLEANDIR       If set, avoids the ``make cleandir'' phase of a full
                         build.  This has the effect of allowing only changed
                         files in a source tree to be recompiled.  This can speed
                         up builds when updating only a few files in the tree.
   
      NOINCLUDES     If set, avoids the ``make includes'' phase of a full                        Default: Unset.
                     build.  This has the effect of preventing make(1) from  
                     thinking that some programs are out-of-date simply because  
                     the system include files have changed.  However, this op-  
                     tion should not be used when updating the entire NetBSD  
                     source tree arbitrarily; it is suggested to use UPDATE in  
                     that case.  
   
                     Default: Unset.                        See also MKUPDATE.
   
      RELEASEDIR     If set, specifies the directory to which a release(7) lay-       NODISTRIBDIRS    If set, avoids the ``make distrib-dirs'' phase of a full
                     out will be written at the end of a ``make release''.                        build.  This skips running mtree(8) on DESTDIR, useful
                         on systems where building as an unprivileged user, or
                         where it is known that the system-wide mtree files have
                         not changed.
   
                     Default: Unset.                        Default: Unset.
   
      UPDATE         If set, then in addition to the effects described for UP-       NOINCLUDES       If set, avoids the ``make includes'' phase of a full
                     DATE above, this implies the effects of NOCLEANDIR.                        build.  This has the effect of preventing make(1) from
                         thinking that some programs are out-of-date simply
                         because the system include files have changed.  However,
                         this option should not be used when updating the entire
                         NetBSD source tree arbitrarily; it is suggested to use
                         MKUPDATE=yes instead in that case.
   
                         Default: Unset.
   
        RELEASEDIR       If set, specifies the directory to which a release(7)
                         layout will be written at the end of a ``make release''.
                         If specified, must be an absolute path.
   
                         Default: Unset.
   
                         Note: build.sh will provide a default of releasedir (in
                         the top-level .OBJDIR) unless run in `expert' mode.
   
 BUILDING  BUILDING
    "make" command line options     "make" command line options
      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       -j njob    Run up to njob 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.  
   
      -m dir     Specify the default directory for searching for system Make-       -m dir     Specify the default directory for searching for system Make-
                 file segments, mainly the <bsd.*.mk> files.  When building any                  file segments, mainly the <bsd.*.mk> files.  When building any
                 full NetBSD source tree, this should be set to the                  full NetBSD source tree, this should be set to the
                 ``share/mk'' directory in the source tree.  (This is set auto-                  ``share/mk'' directory in the source tree.  This is set auto-
                 matically when building from the top level.)                  matically when building from the top level, or when using
                   build.sh.
   
      -n         Display the commands that would have been executed, but do not       -n         Display the commands that would have been executed, but do not
                 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       -V var     Print make(1)'s idea of the value of var.  Does not build any
                 targets.                  targets.
   
      var=value  Set the variable var to value, overriding any setting speci-       var=value  Set the variable var to value, overriding any setting speci-
Line 364  BUILDING
Line 461  BUILDING
   
      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, de-       cleandir   Same as clean, 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-       depend     Create dependency files (.depend) 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.
   
Line 379  BUILDING
Line 474  BUILDING
                 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-       distclean  Synonym for cleandir.
                 fore any system libraries or programs can be built.  
        includes   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.       install    Install programs, libraries, and documentation into DESTDIR.
                 Few files will be installed to /dev, /etc, /root or /var in                  Few files will be installed to DESTDIR/dev, DESTDIR/etc,
                 order to prevent user supplied configuration data from being                  DESTDIR/root or DESTDIR/var in order to prevent user supplied
                 overwritten.                  configuration data from being overwritten.
   
      lint       Run lint(1) against the C source code, where appropriate, and       lint       Run lint(1) against the C source code, where appropriate, and
                 generate system-installed lint libraries.                  generate system-installed lint libraries.
Line 400  BUILDING
Line 497  BUILDING
      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 the       build         Build the entire NetBSD system (except the kernel).  This
                 source tree such that prerequisites will be built in the prop-                     orders portions of the source tree such that prerequisites
                 er order.                     will be built in the proper order.
   
      release    Do a ``make build'', then package the system into a standard       distribution  Do a ``make build'', and then install a full distribution
                 release layout as described by release(7).  This requires that                     (which does not include a kernel) into DESTDIR, including
                 RELEASEDIR be set (see above).                     files in DESTDIR/dev, DESTDIR/etc, DESTDIR/root and
                      DESTDIR/var.
   
        buildworld    As per ``make distribution'', except that it ensures that
                      DESTDIR is not the root directory.
   
        installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR,
                      which defaults to the root directory.  Ensures that
                      INSTALLWORLDDIR is not the root directory if cross compil-
                      ing.
   
                      The INSTALLSETS environment variable may be set to a list
                      of distribution sets to be installed.  By default, all sets
                      except ``etc'' and ``xetc'' are installed, so most files in
                      INSTALLWORLDDIR/etc will not be installed or modified.
   
                      Note: Before performing this operation with
                      INSTALLWORLDDIR=/, it is highly recommended that you
                      upgrade your kernel and reboot.  After performing this
                      operation, it is recommended that you use etcupdate(8) to
                      update files in INSTALLWORLDDIR/etc and that you use
                      postinstall(8) to check for inconsistencies (and possibly
                      to fix them).
   
        sets          Create distribution sets from DESTDIR into
                      RELEASEDIR/RELEASEMACHINEDIR/binary/sets.  Should be run
                      after ``make distribution'', as ``make build'' alone does
                      not install all of the required files.
   
        sourcesets    Create source sets of the source tree into
                      RELEASEDIR/source/sets.
   
        syspkgs       Create syspkgs from DESTDIR into
                      RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs.  Should be run
                      after ``make distribution'', as ``make build'' alone does
                      not install all of the required files.
   
        release       Do a ``make distribution'', build kernels, distribution
                      media, and install sets (this as per ``make sets''), and
                      then package the system into a standard release layout as
                      described by release(7).  This requires that RELEASEDIR be
                      set (see above).
   
        iso-image     Create a NetBSD installation CD-ROM image in the
                      RELEASEDIR/iso directory.  The CD-ROM file system will have
                      a layout as described in release(7).
   
                      For most machine types, the CD-ROM will be bootable, and
                      will automatically run the sysinst(8) menu-based installa-
                      tion program, which can be used to install or upgrade a
                      NetBSD system.  Bootable CD-ROMs also contain tools that
                      may be useful in repairing a damaged NetBSD installation.
   
                      Before ``make iso-image'' is attempted, RELEASEDIR must be
                      populated by ``make release'' or equivalent.
   
                      Note that other, smaller, CD-ROM images may be created in
                      the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc-
                      tory by ``make release''.  These smaller images usually
                      contain the same tools as the larger images in
                      RELEASEDIR/iso, but do not contain additional content such
                      as the distribution sets.
   
                      Note that the mac68k port still uses an older method of
                      creating CD-ROM images.  This requires the mkisofs(1) util-
                      ity, which is not part of NetBSD, but which can be
                      installed from pkgsrc/sysutils/cdrtools.
   
        iso-image-source
                      Create a NetBSD installation CD-ROM image in the
                      RELEASEDIR/iso directory.  The CD-ROM file system will have
                      a layout as described in release(7).  It will have top
                      level directories for the machine type and source.
   
                      For most machine types, the CD-ROM will be bootable, and
                      will automatically run the sysinst(8) menu-based installa-
                      tion program, which can be used to install or upgrade a
                      NetBSD system.  Bootable CD-ROMs also contain tools that
                      may be useful in repairing a damaged NetBSD installation.
   
                      Before ``make iso-image-source'' is attempted, RELEASEDIR
                      must be populated by ``make sourcesets release'' or equiva-
                      lent.
   
                      Note that other, smaller, CD-ROM images may be created in
                      the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom direc-
                      tory by ``make release''.  These smaller images usually
                      contain the same tools as the larger images in
                      RELEASEDIR/iso, but do not contain additional content such
                      as the distribution sets.
   
                      Note that the mac68k port still uses an older method of
                      creating CD-ROM images.  This requires the mkisofs(1) util-
                      ity, which is not part of NetBSD, but which can be
                      installed from pkgsrc/sysutils/cdrtools.
   
      regression-tests       regression-tests
                 Can only be run after building the regression tests in the di-                     Can only be run after building the regression tests in the
                 rectory ``regress''.  Runs the compiled regression tests on                     directory ``regress''.  Runs those compiled regression
                 the local host.                     tests on the local host.  Note that most tests are now man-
                      aged instead using atf(7); this target should probably run
                      those as well but currently does not.
   
    The "build.sh" script     The "build.sh" script
      This script file is a Bourne shell script designed to build the entire       This script file is a Bourne shell script designed to build the entire
Line 430  BUILDING
Line 623  BUILDING
      of options below, variables that are automatically set by build.sh are       of options below, variables that are automatically set by build.sh 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 build.sh:
      build.sh:  
        build         Build the system as per ``make build''.  Before the main
                      part of the build commences, this command runs the obj
                      operation (unless the -o option is given), ``make
                      cleandir'' (unless the -u option is given), and the tools
                      operation.
   
        distribution  Build a full distribution as per ``make distribution''.
                      This command first runs the build operation.
   
        release       Build a full release as per ``make release''.  This command
                      first runs the distribution operation.
   
        makewrapper   Create the nbmake-MACHINE wrapper.  This operation is auto-
                      matically performed for any of the other operations.
   
        cleandir      Perform ``make cleandir''.
   
        obj           Perform ``make obj''.
   
        tools         Build and install the host tools from src/tools.  This com-
                      mand will first run ``make obj'' and ``make cleandir'' in
                      the tools subdirectory unless the -o or -u options (respec-
                      tively) are given.
   
        install=idir  Install the contents of DESTDIR to idir, using ``make
                      installworld''.  Note that files that are part of the
                      ``etc'' or ``xetc'' sets will not be installed.
   
        kernel=kconf  Build a new kernel.  The kconf argument is the name of a
                      configuration file suitable for use by config(1).  If kconf
                      does not contain any `/' characters, the configuration file
                      is expected to be found in the KERNCONFDIR directory, which
                      is typically sys/arch/MACHINE/conf.  The new kernel will be
                      built in a subdirectory of KERNOBJDIR, which is typically
                      sys/arch/MACHINE/compile or an associated object directory.
   
                      This command does not imply the tools command; run the
                      tools command first unless it is certain that the tools
                      already exist and are up to date.
   
                      This command will run ``make cleandir'' on the kernel in
                      question first unless the -u option is given.
   
        releasekernel=kconf
                      Install a gzip(1)ed copy of the kernel previously built by
                      kernel=kconf into
                      RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as
                      netbsd-kconf.gz, although the ``netbsd'' prefix is deter-
                      mined from the ``config'' directives in kconf.
   
        sets          Perform ``make sets''.
   
        sourcesets    Perform ``make sourcesets''.
   
        syspkgs       Perform ``make syspkgs''.
   
        iso-image     Perform ``make iso-image''.
   
        iso-image-source
                      Perform ``make iso-image-source''.
   
        The following command line options alter the behaviour of the build.sh
        operations described above:
   
      -a arch   Set the value of MACHINE_ARCH to arch.       -a arch   Set the value of MACHINE_ARCH to arch.
   
      -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 idenfitier to the name of the ``make'' wrapper script so                 build identifier to the name of the ``make'' wrapper script so
                that the resulting name is of the form ``nbmake-MACHINE-                 that the resulting name is of the form
                BUILDID''.                 ``nbmake-MACHINE-BUILDID''.
   
      -b        Bootstrap ``make'' and create a nbmake-MACHINE script (see be-       -C cdextras
                low).                 Set the value of CDEXTRA to cdextras which is a space-separated
                  list of files or directories which will be added in order to
      -d        Build a full distribution.  This differs from a default build                 the CD-ROM image when used in conjunction with ``iso-image'' or
                in that files will also be installed to /dev, /etc, /root and                 ``iso-image-source''.  Files will be added to the root of the
                /var.  Note this does not build a ``release''; no release sets                 CD-ROM image, whereas directories will be copied recursively.
                are placed in ${RELEASEDIR}.  -d is implied by -R.                 If relative paths are specified, they will be converted to
                  absolute paths before being used.
      -j njob   Passed through to make(1).  Makefiles should use .WAIT or have  
                explicit dependancies as necessary to enforce build ordering.       -D dest   Set the value of DESTDIR to dest.  If a relative path is speci-
                If you see build failures with -j, please save complete build                 fied, it will be converted to an absolute path before being
                logs so the failures can be analyzed.                 used.
   
      -k kernel       -E        Set `expert' mode.  This overrides various sanity checks, and
                Build a new kernel.  The kernel argument is the name of a con-                 allows: DESTDIR does not have to be set to a non-root path for
                figuration file suitable for use by config(8).  If kernel does                 builds, and MKUNPRIVED=yes does not have to be set when build-
                not contain any `/' characters, the configuration file is ex-                 ing as a non-root user.
                pected to be found in the KERNCONFDIR directory, which is typi-  
                cally sys/arch/MACHINE/conf.  The new kernel will be built in a                 Note: It is highly recommended that you know what you are doing
                subdirectory of KERNOBJDIR, which is typically                 when you use this option.
                sys/arch/MACHINE/compile or an associated object directory.  In  
                order to ensure that the kernel is built using up-to-date       -h        Print a help message.
                tools, it is strongly recommended that the tools be rebuilt  
                (using the -t option) in a separate invocation of build.sh pri-       -j njob   Run up to njob make(1) subjobs in parallel; passed through to
                or to using the -k option, or that the -t and -k options be                 make(1).  If you see failures for reasons other than running
                used together in a single invocation of build.sh.                 out of memory while using build.sh with -j, please save com-
                  plete build logs so the failures can be analyzed.
      -m mach   Set the value of MACHINE to mach.  This will also override any  
                value of MACHINE_ARCH in the process environment with a value                 To achieve the fastest builds, -j values between (1 + the num-
                deduced from mach, unless -a is specified.  All cross builds                 ber of CPUs) and (2 * the number of CPUs) are recommended.  Use
                require -m, but if unset on a NetBSD host, the host's value of                 lower values on machines with limited memory or I/O bandwidth.
                MACHINE will be detected and used automatically.  
        -M obj    Set MAKEOBJDIRPREFIX to obj.  For instance, if the source
                  directory is /usr/src, a setting of ``-M /usr/obj'' will place
                  build-time files under /usr/obj/usr/src/bin,
                  /usr/obj/usr/src/lib, /usr/obj/usr/src/usr.bin, and so forth.
                  If a relative path is specified, it will be converted to an
                  absolute path before being used.  Unsets MAKEOBJDIR.  See ``-O
                  -obj'' for more information.
   
        -m mach   Set the value of MACHINE to mach, except in some special cases
                  listed below.  This will also override any value of
                  MACHINE_ARCH in the process environment with a value deduced
                  from mach, unless -a is specified.  All cross builds require
                  -m, 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 MACHINE_ARCH.  The
                  following special cases for the mach argument are defined to
                  set the listed values of MACHINE and MACHINE_ARCH:
   
                        mach          MACHINE    MACHINE_ARCH
                        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
   
        -N noiselevel
                  Set the ``noisyness'' level of the build, by setting
                  MAKEVERBOSE 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        Set the value of MKOBJDIRS to ``no''.       -O obj    Create an appropriate transform macro for MAKEOBJDIR that will
                  place the built object files under obj.  For instance, a set-
                  ting of ``-O /usr/obj'' will place build-time files under
                  /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth.  If
                  a relative path is specified, it will be converted to an abso-
                  lute path before being used.  Unsets MAKEOBJDIRPREFIX.
   
                  In normal use, exactly one of the -M or -O options should be
                  specified.  If neither -M nor -O 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.
   
        -o        Set the value of MKOBJDIRS to ``no''.  Otherwise, it will be
                  automatically set to ``yes''.  This default is opposite to the
                  behaviour when not using build.sh.
   
        -R rel    Set the value of RELEASEDIR to rel.  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       -r        Remove the contents of DESTDIR and TOOLDIR 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.                 DESTDIR if building on a native system to the root directory.
   
      -t        Build and install the host tools from src/tools only.  This op-       -S seed   Change the value of BUILDSEED to seed.  This should rarely be
                tion implies -b.                 necessary.
   
        -T tools  Set the value of TOOLDIR to tools.  If a relative path is spec-
                  ified, it will be converted to an absolute path before being
                  used.  If set, the bootstrap ``make'' will only be rebuilt if
                  the source files for make(1) have changed.
   
      -u        Set the UPDATE variable.       -U        Set MKUNPRIVED=yes.
   
        -u        Set MKUPDATE=yes.
   
        -V var=[value]
                  Set the environment variable var to an optional value.  This is
                  propagated to the nbmake wrapper.
   
      -w wrapper       -w wrapper
                Create the nbmake wrapper script (see below) in a custom loca-                 Create the nbmake wrapper script (see below) in a custom loca-
                tion, specified by wrapper.  This allows, for instance, to                 tion, specified by wrapper.  This allows, for instance, to
                place the wrapper in PATH automatically.  Note that wrapper is                 place the wrapper in PATH automatically.  Note that wrapper is
                the full name of the file, not just a directory name.                 the full name of the file, not just a directory name.  If a
                  relative path is specified, it will be converted to an absolute
      -D dest   Set the value of DESTDIR to dest.                 path before being used.
   
      -M obj    Set MAKEOBJDIRPREFIX to obj.       -X x11src
                  Set the value of X11SRCDIR to x11src.  If a relative path is
      -O obj    Create an appropriate transform macro for MAKEOBJDIR that will                 specified, it will be converted to an absolute path before
                place the built object files under obj.  For instance, a set-                 being used.
                ting of /usr/obj will place build-time files under  
                /usr/obj/bin, /usr/obj/lib, and so forth.  
   
      -R rel    Set the value of RELEASEDIR to rel.  Setting this option will       -x        Set MKX11=yes.
                cause build.sh to run ``make release'' instead of ``make  
                build''.  
   
      -T tools  Set the value of TOOLDIR to tools.  If set, the bootstrap  
                ``make'' will only be rebuilt as needed (when the source files  
                for make(1) change).  
   
      -U        Set the UNPRIVED variable.       -Z var    Unset ("zap") the environment variable var.  This is propagated
                  to the nbmake wrapper.
   
    The "nbmake-MACHINE" wrapper script     The "nbmake-MACHINE" wrapper script
      If using the build.sh script to build NetBSD, a nbmake-MACHINE script       If using the build.sh script to build NetBSD, a nbmake-MACHINE script
Line 522  BUILDING
Line 839  BUILDING
      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 sev-       the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with sev-
      eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR.       eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR.
        nbmake-MACHINE will also set variables specified with -V, and unset vari-
        ables specified with -Z.
   
      This script can be symlinked into a directory listed in PATH, or called       This script can be symlinked into a directory listed in PATH, or called
      with an absolute path.       with an absolute path.
   
 EXAMPLES  EXAMPLES
      ./build.sh -t       1.   % ./build.sh [options] tools kernel=GENERIC
                Build a new toolchain.  
             Build a new toolchain, and use the new toolchain to configure and
             build a new GENERIC kernel.
   
        2.   % ./build.sh [options] -U distribution
   
      cd ${KERNCONFDIR} ; ${TOOLDIR}/bin/nbconfig GENERIC            Using unprivileged mode, build a complete distribution to a DESTDIR
                Use the new version of config(8) to prepare to build a new            directory that build.sh selects (and will display).
                GENERIC kernel.  
        3.   # ./build.sh [options] -U install=/
      cd ${KERNOBJDIR}/GENERIC ; ${TOOLDIR}/bin/nbmake-${MACHINE} dependall  
                Use the new toolchain to build a new GENERIC kernel.            As root, install to / the distribution that was built by example 2.
             Even though this is run as root, -U is required so that the permis-
      ./build.sh -t -k GENERIC            sions stored in DESTDIR/METALOG are correctly applied to the files
                Build a new toolchain, and use the new toolchain to configure            as they're copied to /.
                and build a new GENERIC kernel.  
        4.   % ./build.sh [options] -U -u release
      ./build.sh -U -d  
                Using unprivileged mode, build a complete distribution in            Using unprivileged mode, build a complete release to DESTDIR and
                DESTDIR.            RELEASEDIR directories that build.sh selects (and will display).
             MKUPDATE=yes (-u) is set to prevent the ``make cleandir'', so that
      ./build.sh -U -R /some/dir/RELEASE            if this is run after example 2, it doesn't need to redo that portion
                Using unprivileged mode, build a complete release in the speci-            of the release build.
                fied release directory.  
   
 OBSOLETE VARIABLES  OBSOLETE VARIABLES
      NBUILDJOBS  Use the make(1) option -j, instead.       NBUILDJOBS  Use the make(1) option -j instead.
   
      USE_NEW_TOOLCHAIN       USE_NEW_TOOLCHAIN
                  The new toolchain is now the default.  To disable, use                   The new toolchain is now the default.  To disable, use
                  TOOLCHAIN_MISSING=yes.                   TOOLCHAIN_MISSING=yes.
   
 SEE ALSO  SEE ALSO
      make(1), hier(7), release(7)       make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8),
        pkgsrc/sysutils/cdrtools
   
 HISTORY  HISTORY
      The build.sh based build scheme was introduced for NetBSD 1.6 as       The build.sh based build scheme was introduced for NetBSD 1.6 as
      USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.       USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.
   
 BUGS  NetBSD                        September 10, 2008                        NetBSD
      A few platforms are not yet using this build system.  
   
 NetBSD                         October 21, 2002                              9  

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.79

CVSweb <webmaster@jp.NetBSD.org>