[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.42 and 1.51

version 1.42, 2003/08/19 10:00:29 version 1.51, 2004/06/25 15:04:20
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 TOOLCHAIN_MISSING in <bsd.own.mk>.       as indicated by the default setting of TOOLCHAIN_MISSING in <bsd.own.mk>.
Line 30  REQUIREMENTS
Line 30  REQUIREMENTS
      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.
   
            Note: A couple of 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
Line 42  FILES
Line 37  FILES
   
      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 60  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-
Line 83  FILES
Line 82  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 141  CONFIGURATION
Line 143  CONFIGURATION
   
                  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 149  CONFIGURATION
Line 163  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 DESTDIR/usr/share/doc will be in-                   documentation destined for DESTDIR/usr/share/doc will be
                  stalled during a build.                   installed during a build.
   
                  Default: ``yes''                   Default: ``yes''
   
Line 190  CONFIGURATION
Line 204  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 212  CONFIGURATION
Line 226  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 226  CONFIGURATION
Line 240  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 DESTDIR/usr/share will be built and in-                   destined to reside in DESTDIR/usr/share will be built and
                  stalled during a build.  If set to ``no'', then all of                   installed during a build.  If set to ``no'', then all of
                  MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to                   MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to
                  ``no'' unconditionally.                   ``no'' unconditionally.
   
                  Default: ``yes''                   Default: ``yes''
   
      MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an un-       MKTTINTERP  Can be set to ``yes'' or ``no''.  For X builds, decides if
                  privileged install will occur.  The user, group, permissions,                   the TrueType bytecode interpreter is turned on.  See
                  and file flags, will not be set on the installed item; in-                   http://www.freetype.org/patents.html for details.
                  stead the information will be appended to a file called  
                    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 item;
                    instead the information will be appended to a file called
                  METALOG in DESTDIR.  The contents of METALOG is used during                   METALOG in DESTDIR.  The contents of METALOG is used during
                  the generation of the distribution tar files to ensure that                   the generation of the distribution tar files to ensure that
                  the appropriate file ownership is stored.                   the appropriate file ownership is stored.
   
                  Default: ``no''                   Default: ``no''
   
      MKUPDATE    Can be set to ``yes'' or ``no''.  Indicates whether all in-       MKUPDATE    Can be set to ``yes'' or ``no''.  Indicates whether all
                  stall operations intended to write to DESTDIR will compare                   install operations intended to write to DESTDIR will compare
                  file timestamps before installing, and skip the install phase                   file timestamps before installing, and skip the install phase
                  if the destination files are up-to-date.  This also has im-                   if the destination files are up-to-date.  This also has
                  plications on full builds (see next subsection).                   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''                   Default: ``no''
   
Line 280  CONFIGURATION
Line 305  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
Line 292  CONFIGURATION
Line 322  CONFIGURATION
   
                       Default: ``/''                        Default: ``/''
   
      MKOBJDIRS        Can be set to ``yes'' or ``no''.  Indicates whether ob-       MKOBJDIRS        Can be set to ``yes'' or ``no''.  Indicates whether
                       ject directories will be created automatically (via a                        object directories will be created automatically (via a
                       ``make obj'' pass) at the start of a build.                        ``make obj'' pass) at the start of a build.
   
                       Default: ``no''                        Default: ``no''
Line 327  CONFIGURATION
Line 357  CONFIGURATION
   
      NOINCLUDES       If set, avoids the ``make includes'' phase of a full       NOINCLUDES       If set, avoids the ``make includes'' phase of a full
                       build.  This has the effect of preventing make(1) from                        build.  This has the effect of preventing make(1) from
                       thinking that some programs are out-of-date simply be-                        thinking that some programs are out-of-date simply
                       cause the system include files have changed.  However,                        because the system include files have changed.  However,
                       this option should not be used when updating the entire                        this option should not be used when updating the entire
                       NetBSD source tree arbitrarily; it is suggested to use                        NetBSD source tree arbitrarily; it is suggested to use
                       MKUPDATE=yes in that case.                        MKUPDATE=yes in that case.
Line 349  BUILDING
Line 379  BUILDING
      used most frequently with NetBSD builds are listed here.       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 dependancies as necessary to
                 force 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 364  BUILDING
Line 394  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 381  BUILDING
Line 411  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 396  BUILDING
Line 424  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 DESTDIR/dev, DESTDIR/etc,                  Few files will be installed to DESTDIR/dev, DESTDIR/etc,
Line 444  BUILDING
Line 474  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.
   
      release       Do a ``make distribution'', build kernels, distribution me-       release       Do a ``make distribution'', build kernels, distribution
                    dia, and install sets (this as per ``make sets''), and then                     media, and install sets (this as per ``make sets''), and
                    package the system into a standard release layout as de-                     then package the system into a standard release layout as
                    scribed by release(7).  This requires that RELEASEDIR be                     described by release(7).  This requires that RELEASEDIR be
                    set (see above).                     set (see above).
   
      regression-tests       regression-tests
Line 474  BUILDING
Line 504  BUILDING
   
      The following operations are supported by build.sh:       The following operations are supported by build.sh:
   
      build         Build the system as per ``make build''.  This option im-       build         Build the system as per ``make build''.  This option
                    plies the obj and tools operations.                     implies the obj and tools operations.
   
      distribution  Build a full distribution as per ``make distribution''.       distribution  Build a full distribution as per ``make distribution''.
                    This option implies the build operation.                     This option implies the build operation.
Line 507  BUILDING
Line 537  BUILDING
      releasekernel=kconf       releasekernel=kconf
                    Install a gzip(1)ed copy of the kernel built by                     Install a gzip(1)ed copy of the kernel built by
                    kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually                     kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually
                    as netbsd-kconf.gz, although the ``netbsd'' prefix is de-                     as netbsd-kconf.gz, although the ``netbsd'' prefix is
                    termined from the ``config'' directives in kconf.                     determined from the ``config'' directives in kconf.
   
      sets          Perform ``make sets''.       sets          Perform ``make sets''.
   
      sourcesets    Perform ``make sourcesets''.       sourcesets    Perform ``make sourcesets''.
   
      The following command line options alter the behaviour of the above oper-       The following command line options alter the behaviour of the build.sh
      ations: The following command line options alter the behaviour of the       operations described above:
      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.
   
Line 536  BUILDING
Line 565  BUILDING
                Note: It is highly recommended that you know what you are doing                 Note: It is highly recommended that you know what you are doing
                when you use this option.                 when you use this option.
   
        -h        Print a help message.
   
      -j njob   Passed through to make(1).  Makefiles should use .WAIT or have       -j njob   Passed through to make(1).  Makefiles should use .WAIT or have
                explicit dependancies as necessary to enforce build ordering.                 explicit dependancies as necessary to enforce build ordering.
                If you see build failures with -j, please save complete build                 If you see build failures with -j, please save complete build
Line 565  BUILDING
Line 596  BUILDING
                      sbmips-eb     sbmips     mipseb                       sbmips-eb     sbmips     mipseb
                      sbmips-el     sbmips     mipsel                       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''.
Line 603  BUILDING
Line 638  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.
   
        -X x11src
                  Set the value of X11SRCDIR to x11src.
   
        -x        Set MKX11=yes.
   
      -Z var    Unset ("zap") the environment variable var.  This is propagated       -Z var    Unset ("zap") the environment variable var.  This is propagated
                to the nbmake wrapper.                 to the nbmake wrapper.
   
Line 621  BUILDING
Line 661  BUILDING
      with an absolute path.       with an absolute path.
   
 EXAMPLES  EXAMPLES
      1.   ./build.sh tools kernel=GENERIC       1.   % ./build.sh tools kernel=GENERIC
   
           Build a new toolchain, and use the new toolchain to configure and            Build a new toolchain, and use the new toolchain to configure and
           build a new GENERIC kernel.            build a new GENERIC kernel.
   
      2.   ./build.sh -U distribution       2.   % ./build.sh -U distribution
   
           Using unprivileged mode, build a complete distribution to a DESTDIR            Using unprivileged mode, build a complete distribution to a DESTDIR
           directory that build.sh selects (and will display).            directory that build.sh selects (and will display).
   
      3.   ./build.sh -U install=/       3.   # ./build.sh -U install=/
   
           As root, install to / the distribution that was built by example 2.            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-            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            sions stored in DESTDIR/METALOG are correctly applied to the files
           as they're copied to /.            as they're copied to /.
   
      4.   ./build.sh -U -u release       4.   % ./build.sh -U -u release
   
           Using unprivileged mode, build a complete release to DESTDIR and            Using unprivileged mode, build a complete release to DESTDIR and
           RELEASEDIR directories that build.sh selects (and will display).            RELEASEDIR directories that build.sh selects (and will display).
Line 663  HISTORY
Line 703  HISTORY
 BUGS  BUGS
      A few platforms are not yet using this build system.       A few platforms are not yet using this build system.
   
 NetBSD                          August 7, 2003                          NetBSD  NetBSD                         February 6, 2003                         NetBSD

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

CVSweb <webmaster@jp.NetBSD.org>