[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.51 and 1.59.2.3

version 1.51, 2004/06/25 15:04:20 version 1.59.2.3, 2007/09/29 11:10:56
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 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.)
   
 FILES  FILES
    Source tree layout     Source tree layout
Line 93  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_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]
   
        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 102  CONFIGURATION
Line 119  CONFIGURATION
      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
                          make(1).  Used only if MAKEOBJDIRPREFIX is not defined.
                        MAKEOBJDIR can only be provided in the environment or                         MAKEOBJDIR can only be provided in the environment or
                        via the -O flag of build.sh.                         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                         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 or via the -M flag of                         tory may be read only.  MAKEOBJDIRPREFIX can only be
                          provided in the environment or via the -M flag of
                        build.sh.                         build.sh.
   
    "make" variables     "make" variables
Line 126  CONFIGURATION
Line 145  CONFIGURATION
      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.
Line 255  CONFIGURATION
Line 274  CONFIGURATION
   
      MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an       MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an
                  unprivileged install will occur.  The user, group, permis-                   unprivileged install will occur.  The user, group, permis-
                  sions, and file flags, will not be set on the installed item;                   sions, and file flags, will not be set on the installed
                  instead the information will be appended to a file called                   items; instead the information will be appended to a file
                  METALOG in DESTDIR.  The contents of METALOG is used during                   called METALOG in DESTDIR.  The contents of METALOG are used
                  the generation of the distribution tar files to ensure that                   during the generation of the distribution tar files to ensure
                  the appropriate file ownership is stored.                   that the appropriate file ownership is stored.
   
                  Default: ``no''                   Default: ``no''
   
Line 276  CONFIGURATION
Line 295  CONFIGURATION
   
                  Default: ``no''                   Default: ``no''
   
      TOOLDIR     Directory to hold the host tools, once built.  This directory       TOOLDIR     Directory to hold the host tools, once built.  If specified,
                  should be unique to a given host system and NetBSD source                   must be an absolute path.  This directory should be unique to
                  tree.  (However, multiple targets may share the same TOOLDIR;                   a given host system and NetBSD source tree.  (However, multi-
                  the target-dependent files have unique names.)  If unset, a                   ple targets may share the same TOOLDIR; the target-dependent
                  default based on the uname(1) information of the host plat-                   files have unique names.)  If unset, a default based on the
                  form will be created in the .OBJDIR of src.                   uname(1) information of the host platform will be created in
                    the .OBJDIR of src.
   
                  Default: Unset.                   Default: Unset.
   
Line 308  CONFIGURATION
Line 328  CONFIGURATION
                  preserve traditional semantics of the <bsd.*.mk> make(1)                   preserve traditional semantics of the <bsd.*.mk> make(1)
                  include files).                   include files).
   
      X11SRCDIR   Directory containing the X11R6 source.  The main X11R6 source       X11SRCDIR   Directory containing the X11R6 source.  If specified, must be
                  is found in X11SRCDIR/xfree/xc.                   an absolute path.  The main X11R6 source is found in
                    X11SRCDIR/xfree/xc.
   
                  Default: ``/usr/xsrc''                   Default: ``/usr/xsrc''
   
Line 318  CONFIGURATION
Line 339  CONFIGURATION
      manually building subtrees of the NetBSD source code.       manually building subtrees of the NetBSD source code.
   
      INSTALLWORLDDIR  Location for the ``make installworld'' target to install       INSTALLWORLDDIR  Location for the ``make installworld'' target to install
                       to.                        to.  If specified, must be an absolute path.
   
                       Default: ``/''                        Default: ``/''
   
Line 367  CONFIGURATION
Line 388  CONFIGURATION
   
      RELEASEDIR       If set, specifies the directory to which a release(7)       RELEASEDIR       If set, specifies the directory to which a release(7)
                       layout will be written at the end of a ``make release''.                        layout will be written at the end of a ``make release''.
                         If specified, must be an absolute path.
   
                       Default: Unset.                        Default: Unset.
   
Line 375  CONFIGURATION
Line 397  CONFIGURATION
   
 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                  use .WAIT or have explicit dependencies as necessary to
                 enforce build ordering.  If you see build failures with -j,                  enforce build ordering.  If you see build failures with -j,
                 please save complete build logs so the failures can be ana-                  please save complete build logs so the failures can be ana-
                 lyzed.                  lyzed.
Line 460  BUILDING
Line 482  BUILDING
   
      installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR       installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR
                    (which defaults to the root directory).  Ensures that                     (which defaults to the root directory).  Ensures that
                    INSTALLWORLDDIR is the not root directory if cross compil-                     INSTALLWORLDDIR is not the root directory if cross compil-
                    ing.                     ing.
   
                    Note: It is highly recommended that you upgrade your kernel                     The INSTALLSETS environment variable may be set to a list
                    and reboot before performing this operation.                     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       sets          Create distribution sets from DESTDIR into
                    RELEASEDIR/MACHINE/binary/sets.  Should be run after ``make                     RELEASEDIR/MACHINE/binary/sets.  Should be run after ``make
Line 474  BUILDING
Line 506  BUILDING
      sourcesets    Create source sets of the source tree into       sourcesets    Create source sets of the source tree into
                    RELEASEDIR/source/sets.                     RELEASEDIR/source/sets.
   
        syspkgs       Create syspkgs from DESTDIR into
                      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       release       Do a ``make distribution'', build kernels, distribution
                    media, and install sets (this as per ``make sets''), and                     media, and install sets (this as per ``make sets''), and
                    then package the system into a standard release layout as                     then package the system into a standard release layout as
                    described by release(7).  This requires that RELEASEDIR be                     described by release(7).  This requires that RELEASEDIR be
                    set (see above).                     set (see above).
   
        iso-image     Create a NetBSD installation CD-ROM image in the
                      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/MACHINE/installation/cdrom directory 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/MACHINE/installation/cdrom directory 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                     Can only be run after building the regression tests in the
                    directory ``regress''.  Runs the compiled regression tests                     directory ``regress''.  Runs the compiled regression tests
Line 521  BUILDING
Line 611  BUILDING
      tools         Build and install the host tools from src/tools.       tools         Build and install the host tools from src/tools.
   
      install=idir  Install the contents of DESTDIR to idir, using ``make       install=idir  Install the contents of DESTDIR to idir, using ``make
                    installworld''.                     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       kernel=kconf  Build a new kernel.  The kconf argument is the name of a
                    configuration file suitable for use by config(8).  If kconf                     configuration file suitable for use by config(1).  If kconf
                    does not contain any `/' characters, the configuration file                     does not contain any `/' characters, the configuration file
                    is expected to be found in the KERNCONFDIR directory, which                     is expected to be found in the KERNCONFDIR directory, which
                    is typically sys/arch/MACHINE/conf.  The new kernel will be                     is typically sys/arch/MACHINE/conf.  The new kernel will be
Line 544  BUILDING
Line 635  BUILDING
   
      sourcesets    Perform ``make sourcesets''.       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       The following command line options alter the behaviour of the build.sh
      operations described above:       operations described above:
   
Line 555  BUILDING
Line 653  BUILDING
                that the resulting name is of the form                 that the resulting name is of the form
                ``nbmake-MACHINE-BUILDID''.                 ``nbmake-MACHINE-BUILDID''.
   
      -D dest   Set the value of DESTDIR to dest.       -C cddir  Set the value of CDEXTRA to cddir.  If a relative path is spec-
                  ified, it will be converted to an absolute path before being
                  used.  When combined with ``iso-image'' or
                  ``iso-image-source'', it will cause the contents of cddir to be
                  added to the CD-ROM image.
   
        -D dest   Set the value of DESTDIR to dest.  If a relative path is speci-
                  fied, it will be converted to an absolute path before being
                  used.
   
      -E        Set `expert' mode.  This overrides various sanity checks, and       -E        Set `expert' mode.  This overrides various sanity checks, and
                allows: DESTDIR does not have to be set to a non-root path for                 allows: DESTDIR does not have to be set to a non-root path for
Line 572  BUILDING
Line 678  BUILDING
                If you see build failures with -j, please save complete build                 If you see build failures with -j, please save complete build
                logs so the failures can be analyzed.                 logs so the failures can be analyzed.
   
      -M obj    Set MAKEOBJDIRPREFIX to obj.  Unsets MAKEOBJDIR.       -M obj    Set MAKEOBJDIRPREFIX to obj.  If a relative path is specified,
                  it will be converted to an absolute path before being used.
                  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
Line 605  BUILDING
Line 713  BUILDING
                -n''.                 -n''.
   
      -O obj    Create an appropriate transform macro for MAKEOBJDIR that will       -O obj    Create an appropriate transform macro for MAKEOBJDIR that will
                place the built object files under obj.  For instance, a set-                 place the built object files under obj.  If a relative path is
                ting of /usr/obj will place build-time files under                 specified, it will be converted to an absolute path before
                /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth.                 being used.  For instance, a setting of /usr/obj will place
                Unsets MAKEOBJDIRPREFIX.                 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       -o        Set the value of MKOBJDIRS to ``no''.  Otherwise, it will be
                automatically set to ``yes'' (which is opposite to the default                 automatically set to ``yes'' (which is opposite to the default
                behaviour).                 behaviour).
   
      -R rel    Set the value of RELEASEDIR to rel.       -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 tools  Set the value of TOOLDIR to tools.  If set, the bootstrap       -T tools  Set the value of TOOLDIR to tools.  If a relative path is spec-
                ``make'' will only be rebuilt as needed (when the source files                 ified, it will be converted to an absolute path before being
                for make(1) change).                 used.  If set, the bootstrap ``make'' will only be rebuilt as
                  needed (when the source files for make(1) change).
   
      -U        Set MKUNPRIVED=yes.       -U        Set MKUNPRIVED=yes.
   
Line 636  BUILDING
Line 748  BUILDING
                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
                  path before being used.
   
      -X x11src       -X x11src
                Set the value of X11SRCDIR to x11src.                 Set the value of X11SRCDIR to x11src.  If a relative path is
                  specified, it will be converted to an absolute path before
                  being used.
   
      -x        Set MKX11=yes.       -x        Set MKX11=yes.
   
Line 694  OBSOLETE VARIABLES
Line 810  OBSOLETE VARIABLES
                  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
Line 703  HISTORY
Line 820  HISTORY
 BUGS  BUGS
      A few platforms are not yet using this build system.       A few platforms are not yet using this build system.
   
 NetBSD                         February 6, 2003                         NetBSD  NetBSD                         September 1, 2007                        NetBSD

Legend:
Removed from v.1.51  
changed lines
  Added in v.1.59.2.3

CVSweb <webmaster@jp.NetBSD.org>