[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.8 and 1.55

version 1.8, 2002/03/05 01:15:51 version 1.55, 2006/01/12 21:22:30
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  STATUS
      This document is a work-in-progress.  As such, the information described       This document is a work-in-progress.  As such, the information described
Line 9  STATUS
Line 9  STATUS
      Once this document is completely in sync with reality, this paragraph       Once this document is completely in sync with reality, this paragraph
      will be removed.       will be removed.
   
      Discrepancies between this documentation and the current reality of im-       Discrepancies between this documentation and the current reality of
      plementation are noted specially, as with the note below:       implementation are noted specially, as with the note below:
   
      Note: This document applies only to platforms which use the new toolchain       Note: This document applies only to platforms which use the new toolchain
      as indicated by the default setting of USE_NEW_TOOLCHAIN in <bsd.own.mk>.       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       Platforms which have not yet been switched to the new toolchain should
      continue building traditionally, using the notes specified in the file       continue building traditionally, using the notes specified in the file
      UPDATING.       UPDATING.
Line 28  REQUIREMENTS
Line 28  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
      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 61  FILES
Line 61  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       regress/       Regression test harness.  Can be cross-compiled, but only
                     run natively.                      run natively.
Line 83  FILES
Line 83  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 91  CONFIGURATION
Line 94  CONFIGURATION
    Environment variables     Environment variables
      Several environment variables control the behaviour of NetBSD builds.       Several environment variables control the behaviour of NetBSD builds.
   
        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.       MACHINE           Machine type.
   
      MACHINE_ARCH      Machine architecture.       MACHINE_ARCH      Machine architecture.
Line 101  CONFIGURATION
Line 108  CONFIGURATION
   
      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.  Used only if MAKEOBJDIRPREFIX is not defined.
                        MAKEOBJDIR can only be provided in the environment.                         MAKEOBJDIR can only be provided in the environment or
                          via the -O flag of build.sh.
   
      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                         this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used
                        as the .OBJDIR for the current directory.  The current                         as the .OBJDIR for the current directory.  The current
                        directory may be read only.  MAKEOBJDIRPREFIX can only                         directory may be read only.  MAKEOBJDIRPREFIX can only
                        be provided in the environment.                         be provided in the environment or via the -M flag of
                          build.sh.
   
    "make" variables     "make" variables
      Several variables control the behavior of NetBSD builds.  Unless other-       Several variables control the behavior of NetBSD builds.  Unless other-
      wise specified, these variables may be set in either the process environ-       wise specified, these variables may be set in either the process environ-
      ment or the make(1) configuration file specified by MAKECONF.       ment or the make(1) configuration file specified by MAKECONF.
   
        BUILDID     Identifier for the build.  The identifier will be appended to
                    object directory names, and can be consulted in the make(1)
                    configuration file in order to set additional build parame-
                    ters, such as compiler flags.
   
      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,
Line 126  CONFIGURATION
Line 140  CONFIGURATION
                  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 139  CONFIGURATION
Line 168  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''                   Default: ``yes''
   
Line 170  CONFIGURATION
Line 199  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 180  CONFIGURATION
Line 209  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 202  CONFIGURATION
Line 231  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 216  CONFIGURATION
Line 245  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''
   
        MKTTINTERP  Can be set to ``yes'' or ``no''.  For X builds, decides if
                    the TrueType bytecode interpreter is turned on.  See
                    http://www.freetype.org/patents.html for details.
   
                    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 X11R6 is
                    built from X11SRCDIR.
   
                    Default: ``no''
   
      TOOLDIR     Directory to hold the host tools, once built.  This directory       TOOLDIR     Directory to hold the host tools, once built.  This directory
                  should be unique to a given host system and NetBSD source                   should be unique to a given host system and NetBSD source
                  tree.  (However, multiple targets may share the same TOOLDIR;                   tree.  (However, multiple targets may share the same TOOLDIR;
                  the target-dependent files have unique names.)  If unset, a                   the target-dependent files have unique names.)  If unset, a
                  default based on the uname(1) information of the host plat-                   default based on the uname(1) information of the host plat-
                  form will be created in the .OBJDIR of src/tools.                   form will be created in the .OBJDIR of src.
   
                  Default: Unset.  
   
      UNPRIVED    If set, then an unprivileged install will occur.  The user,  
                  group, permissions, and file flags, will not be set on the  
                  installed item; instead the information will be appended to a  
                  file called METALOG in the .OBJDIR of src.  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.  
   
      UPDATE      If set, then 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: Unset.                   Default: Unset.
   
Line 270  CONFIGURATION
Line 310  CONFIGURATION
   
                  Default: ``yes'' if building all or part of a whole NetBSD                   Default: ``yes'' if building all or part of a whole NetBSD
                  source tree (detected automatically); ``no'' otherwise (to                   source tree (detected automatically); ``no'' otherwise (to
                  preserve traditional semantics of the <bsd.*.mk> make(1) in-                   preserve traditional semantics of the <bsd.*.mk> make(1)
                  clude files).                   include files).
   
        X11SRCDIR   Directory containing the X11R6 source.  The main X11R6 source
                    is found in X11SRCDIR/xfree/xc.
   
                    Default: ``/usr/xsrc''
   
    "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.
                     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''       MKUPDATE         Can be set to ``yes'' or ``no''.  If set, then in addi-
                         tion to the effects described for MKUPDATE=yes above,
                         this implies the effects of NOCLEANDIR (i.e., ``make
                         cleandir'' is avoided).
   
      NBUILDJOBS     If set, specifies the number of parallel make(1) processes                        Default: ``no''
                     that should be run simultaneously.  This can speed up  
                     builds on SMP machines, or machines with much more CPU  
                     power than I/O availability.  This should be used instead  
                     of the make(1) option -j, in order to ensure proper order-  
                     ing of build components.  
   
                     Default: Unset.       NBUILDJOBS       Now obsolete.  Use the make(1) option -j, instead (see
                         below)
   
      NOCLEANDIR     If set, avoids the ``make cleandir'' phase of a full                        Default: Unset.
                     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.  
   
                     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.
   
      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.       NODISTRIBDIRS    If set, avoids the ``make distrib-dirs'' phase of a full
                         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.
   
      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.       NOINCLUDES       If set, avoids the ``make includes'' phase of a full
                         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 in that case.
   
      RELEASEDIR     If set, specifies the directory to which a release(7) lay-                        Default: Unset.
                     out will be written at the end of a ``make release''.  
   
                     Default: Unset.       RELEASEDIR       If set, specifies the directory to which a release(7)
                         layout will be written at the end of a ``make release''.
   
      UPDATE         If set, then in addition to the effects described for UP-                        Default: Unset.
                     DATE above, this implies the effects of NOCLEANDIR.  
                         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
                   use .WAIT or have explicit dependencies as necessary to
                   enforce build ordering.  If you see build failures with -j,
                   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
Line 340  BUILDING
Line 399  BUILDING
                 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 357  BUILDING
Line 416  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.
   
      dependall  Does a ``make depend'' immediately followed by a ``make all''.       dependall  Does a ``make depend'' immediately followed by a ``make all''.
                 This combined target recurses as an atomic unit, so that the                  This improves cache locality of the build since both passes
                 ``make depend'' phase can participate in make -j parallelism.                  read the source files in their entirety.
   
        distclean  Synonym for cleandir.
   
      includes   Build and install system header files.  Typically needed be-       includes   Build and install system header files.  Typically needed
                 fore any system libraries or programs can be built.                  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 DESTDIR/dev, DESTDIR/etc,
                   DESTDIR/root or DESTDIR/var in order to prevent user supplied
                   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 390  BUILDING
Line 452  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.  This orders portions of
                 source tree such that prerequisites will be built in the prop-                     the source tree such that prerequisites will be built in
                 er order.                     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                     into DESTDIR, including files in DESTDIR/dev, DESTDIR/etc,
                 RELEASEDIR be set (see above).                     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.
   
                      Note: It is highly recommended that you upgrade your kernel
                      and reboot before performing this operation.
   
        sets          Create distribution sets from DESTDIR into
                      RELEASEDIR/MACHINE/binary/sets.  Should be run after ``make
                      distribution'' (as ``make build'' 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/MACHINE/binary/syspkgs.  Should be run after
                      ``make distribution'' (as ``make build'' 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).
   
      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 the compiled regression tests
                 the local host.                     on the local host.
   
    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 420  BUILDING
Line 512  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''.  This option
                      implies the obj and tools operations.
   
        distribution  Build a full distribution as per ``make distribution''.
                      This option implies the build operation.
   
        release       Build a full release as per ``make release''.  This option
                      implies the distribution operation.
   
        makewrapper   Create the nbmake-MACHINE wrapper.  This operation is auto-
                      matically performed for any of the other operations.
   
        obj           Perform ``make obj''.
   
        tools         Build and install the host tools from src/tools.
   
        install=idir  Install the contents of DESTDIR to idir, using ``make
                      installworld''.
   
        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.
                      In order to ensure that the kernel is built using up-to-
                      date tools, it is strongly recommended that the tools be
                      rebuilt (using the tools operation).
   
        releasekernel=kconf
                      Install a gzip(1)ed copy of the kernel built by
                      kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually
                      as netbsd-kconf.gz, although the ``netbsd'' prefix is
                      determined from the ``config'' directives in kconf.
   
        sets          Perform ``make sets''.
   
        sourcesets    Perform ``make sourcesets''.
   
        syspkgs       Perform ``make syspkgs''.
   
        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        Bootstrap ``make'' and create a nbmake-MACHINE script (see be-       -B buildid
                low).                 Set the value of BUILDID to buildid.  This will also append the
                  build idenfitier to the name of the ``make'' wrapper script so
                  that the resulting name is of the form
                  ``nbmake-MACHINE-BUILDID''.
   
      -d        Build a full distribution.  This differs from a normal build in       -D dest   Set the value of DESTDIR to dest.
                that etc files will also be installed.  Note this does not  
                build a ``release''; no release sets are placed in ${RE-       -E        Set `expert' mode.  This overrides various sanity checks, and
                LEASEDIR}.                 allows: DESTDIR does not have to be set to a non-root path for
                  builds, and MKUNPRIVED=yes does not have to be set when build-
      -j njob   Set the value of NBUILDJOBS to njob.  This provides similar                 ing as a non-root user.
                functionality to the familiar ``make -j'', but preserves the  
                ordering of the top level ``make build''.                 Note: It is highly recommended that you know what you are doing
                  when you use this option.
   
        -h        Print a help message.
   
        -j njob   Passed through to make(1).  Makefiles should use .WAIT or have
                  explicit dependancies as necessary to enforce build ordering.
                  If you see build failures with -j, please save complete build
                  logs so the failures can be analyzed.
   
        -M obj    Set MAKEOBJDIRPREFIX to obj.  Unsets MAKEOBJDIR.
   
      -m mach   Set the value of MACHINE to mach.  This will also override any       -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                 value of MACHINE_ARCH in the process environment with a value
                deduced from mach, unless -a is specified.  All cross builds                 deduced from mach, unless -a is specified, or mach is a special
                require -m, but if unset on a NetBSD host, the host's value of                 case listed below.  All cross builds require -m, but if unset
                MACHINE will be detected and used automatically.                 on a NetBSD host, the host's value of MACHINE will be detected
                  and used automatically.
   
                  Some machines support multiple values for MACHINE_ARCH.  For a
                  given value of mach, the following MACHINE and MACHINE_ARCH
                  values will result:
   
                        mach          MACHINE    MACHINE_ARCH
                        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 /usr/obj will place build-time files under
                  /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth.
                  Unsets MAKEOBJDIRPREFIX.
   
        -o        Set the value of MKOBJDIRS to ``no''.  Otherwise, it will be
                  automatically set to ``yes'' (which is opposite to the default
                  behaviour).
   
        -R rel    Set the value of RELEASEDIR to rel.
   
      -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-       -T tools  Set the value of TOOLDIR to tools.  If set, the bootstrap
                tion implies -b.                 ``make'' will only be rebuilt as needed (when the source files
                  for make(1) change).
   
        -U        Set MKUNPRIVED=yes.
   
      -u        Set the UPDATE variable.       -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-
Line 464  BUILDING
Line 650  BUILDING
                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.
   
      -D dest   Set the value of DESTDIR to dest.       -X x11src
                  Set the value of X11SRCDIR to x11src.
      -O obj    Create an appropriate transform macro for MAKEOBJDIR that will  
                place the built object files under obj.  For instance, a set-  
                ting of /usr/obj will place build-time files files under  
                /usr/obj/bin, /usr/obj/lib, and so forth.  
   
      -R rel    Set the value of RELEASEDIR to rel.  Setting this option will  
                cause build.sh to run ``make release'' instead of ``make  
                build''.  
   
      -T tools  Set the value of TOOLDIR to tools.  If set, the bootstrap       -x        Set MKX11=yes.
                ``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 489  BUILDING
Line 666  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.
        build.sh will also set variables specified with -V, and unset variables
        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
        1.   % ./build.sh tools kernel=GENERIC
   
             Build a new toolchain, and use the new toolchain to configure and
             build a new GENERIC kernel.
   
        2.   % ./build.sh -U distribution
   
             Using unprivileged mode, build a complete distribution to a DESTDIR
             directory that build.sh selects (and will display).
   
        3.   # ./build.sh -U install=/
   
             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-
             sions stored in DESTDIR/METALOG are correctly applied to the files
             as they're copied to /.
   
        4.   % ./build.sh -U -u release
   
             Using unprivileged mode, build a complete release to DESTDIR and
             RELEASEDIR directories that build.sh selects (and will display).
             MKUPDATE=yes (-u) is set to prevent the ``make cleandir'', so that
             if this is run after example 2, it doesn't need to redo that portion
             of the release build.
   
   OBSOLETE VARIABLES
        NBUILDJOBS  Use the make(1) option -j, instead.
   
        USE_NEW_TOOLCHAIN
                    The new toolchain is now the default.  To disable, use
                    TOOLCHAIN_MISSING=yes.
   
 SEE ALSO  SEE ALSO
      make(1), hier(7), release(7)       make(1), hier(7), release(7)
   
 HISTORY  HISTORY
      The USE_NEW_TOOLCHAIN based build scheme was introduced in the ``NetBSD-       The build.sh based build scheme was introduced for NetBSD 1.6 as
      current'' development sources between NetBSD 1.5 and NetBSD 1.6.       USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.
   
 BUGS  BUGS
      Many platforms are not yet using the USE_NEW_TOOLCHAIN system.       A few platforms are not yet using this build system.
   
 NetBSD                           March 5, 2002                               8  NetBSD                          January 4, 2006                         NetBSD

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.55

CVSweb <webmaster@jp.NetBSD.org>