Home | History | Annotate | Line # | Download | only in src
BUILDING revision 1.58
      1   1.1        tv BUILDING(8)             NetBSD System Manager's Manual             BUILDING(8)
      2   1.1        tv 
      3   1.1        tv NAME
      4  1.52       jmc      BUILDING -- Procedure for building NetBSD from source code.
      5   1.1        tv 
      6   1.1        tv STATUS
      7   1.1        tv      This document is a work-in-progress.  As such, the information described
      8   1.1        tv      here may not match the reality of the build system as of this writing.
      9   1.1        tv      Once this document is completely in sync with reality, this paragraph
     10   1.1        tv      will be removed.
     11   1.1        tv 
     12  1.44     lukem      Discrepancies between this documentation and the current reality of
     13  1.44     lukem      implementation are noted specially, as with the note below:
     14   1.1        tv 
     15   1.1        tv      Note: This document applies only to platforms which use the new toolchain
     16  1.15     lukem      as indicated by the default setting of TOOLCHAIN_MISSING in <bsd.own.mk>.
     17   1.5        tv      Platforms which have not yet been switched to the new toolchain should
     18   1.5        tv      continue building traditionally, using the notes specified in the file
     19   1.5        tv      UPDATING.
     20   1.1        tv 
     21   1.1        tv REQUIREMENTS
     22   1.1        tv      NetBSD is designed to be buildable on most POSIX-compliant host systems.
     23   1.1        tv      The basic build procedure is the same whether compiling natively (on the
     24   1.1        tv      same NetBSD architecture) or cross compiling (on another architecture or
     25   1.1        tv      OS).
     26   1.1        tv 
     27   1.1        tv      This source tree contains a special subtree, ``tools'', which uses the
     28   1.1        tv      host system to create a build toolchain for the target architecture.  The
     29   1.1        tv      host system must have at least C and C++ compilers in order to create the
     30   1.1        tv      toolchain (make is not required); all other tools are created as part of
     31  1.53      reed      the NetBSD build process.  (See the environment variables section below
     32  1.53      reed      if you need to override or manually select your compilers.)
     33   1.1        tv 
     34   1.1        tv FILES
     35   1.1        tv    Source tree layout
     36  1.17       wiz      doc/BUILDING.mdoc
     37  1.17       wiz                     This document (in -mdoc troff format; the original copy).
     38   1.1        tv 
     39   1.2       wiz      BUILDING       This document (in plaintext).
     40   1.1        tv 
     41  1.48       jmc      tools/compat/README
     42  1.48       jmc                     Special notes for cross-hosting a NetBSD build on non-
     43  1.48       jmc                     NetBSD platforms.
     44  1.48       jmc 
     45  1.44     lukem      Makefile       The main Makefile for NetBSD; should only be run for
     46  1.44     lukem                     native builds with an appropriately up-to-date version of
     47   1.1        tv                     NetBSD make(1).  (For building from out-of-date systems or
     48   1.1        tv                     on a non-native host, see the build.sh shell script.)
     49   1.1        tv 
     50   1.1        tv      UPDATING       Special notes for updating from an earlier revision of
     51   1.1        tv                     NetBSD.  It is important to read this file before every
     52   1.1        tv                     build of an updated source tree.
     53   1.1        tv 
     54   1.1        tv      build.sh       Bourne-compatible shell script used for building the host
     55   1.1        tv                     build tools and the NetBSD system from scratch.  Can be
     56   1.1        tv                     used for both native and cross builds, and should be used
     57   1.1        tv                     instead of make(1) for any source tree that is updated and
     58   1.1        tv                     recompiled regularly.
     59   1.1        tv 
     60   1.1        tv      crypto/dist/, dist/, gnu/dist/
     61   1.1        tv                     Sources imported verbatim from third parties, without man-
     62   1.1        tv                     gling the existing build structure.  Other source trees in
     63   1.1        tv                     bin through usr.sbin use the NetBSD make(1) ``reachover''
     64  1.44     lukem                     Makefile semantics when building these programs for a
     65  1.44     lukem                     native host.
     66   1.1        tv 
     67   1.1        tv      distrib/, etc/
     68   1.1        tv                     Sources for items used when making a full release snap-
     69  1.27     lukem                     shot, such as files installed in DESTDIR/etc on the desti-
     70  1.27     lukem                     nation system, boot media, and release notes.
     71   1.1        tv 
     72   1.1        tv      regress/       Regression test harness.  Can be cross-compiled, but only
     73   1.1        tv                     run natively.
     74   1.1        tv 
     75   1.1        tv      sys/           NetBSD kernel sources.
     76   1.1        tv 
     77   1.1        tv      tools/         ``Reachover'' build structure for the host build tools.
     78   1.1        tv                     This has a special method of determining out-of-date sta-
     79   1.1        tv                     tus.
     80   1.1        tv 
     81   1.1        tv      bin/ ... usr.sbin/
     82   1.1        tv                     Sources to the NetBSD userland (non-kernel) programs.  If
     83   1.1        tv                     any of these directories are missing, they will be skipped
     84   1.1        tv                     during the build.
     85   1.1        tv 
     86  1.49     lukem      x11/           ``Reachover'' build structure for X11R6; the source is in
     87  1.49     lukem                     X11SRCDIR.
     88  1.49     lukem 
     89   1.1        tv    Build tree layout
     90   1.1        tv      The NetBSD build tree is described in hier(7), and the release layout is
     91   1.1        tv      described in release(7).
     92   1.1        tv 
     93   1.1        tv CONFIGURATION
     94   1.8     lukem    Environment variables
     95   1.8     lukem      Several environment variables control the behaviour of NetBSD builds.
     96   1.8     lukem 
     97  1.58       apb      HOST_SH           Path name to a POSIX-compliant shell.  If this is not
     98  1.58       apb                        set explicitly, then the default is set using heuris-
     99  1.58       apb                        tics dependent on the host platform, or from the shell
    100  1.58       apb                        under which build.sh is executed (if that can be deter-
    101  1.58       apb                        mined), or using the first copy of sh found in PATH.
    102  1.58       apb                        If the host system's /bin/sh is not POSIX-compliant, we
    103  1.58       apb                        suggest that you build using commands like
    104  1.58       apb 
    105  1.58       apb                              HOST_SH=/path/to/working/shell
    106  1.58       apb                              export HOST_SH
    107  1.58       apb                              ${HOST_SH} build.sh [options]
    108  1.58       apb 
    109  1.53      reed      HOST_CC           Path name to C compiler used to create the toolchain.
    110  1.53      reed 
    111  1.53      reed      HOST_CXX          Path name to C++ compiler used to create the toolchain.
    112  1.53      reed 
    113   1.8     lukem      MACHINE           Machine type.
    114   1.8     lukem 
    115   1.8     lukem      MACHINE_ARCH      Machine architecture.
    116   1.8     lukem 
    117   1.8     lukem      MAKE              Path name to invoke make(1) as.
    118   1.8     lukem 
    119   1.8     lukem      MAKEFLAGS         Flags to invoke make(1) with.
    120   1.8     lukem 
    121   1.8     lukem      MAKEOBJDIR        Directory to use as the .OBJDIR for the current direc-
    122   1.8     lukem                        tory.  Used only if MAKEOBJDIRPREFIX is not defined.
    123  1.36     lukem                        MAKEOBJDIR can only be provided in the environment or
    124  1.41     lukem                        via the -O flag of build.sh.
    125   1.8     lukem 
    126   1.8     lukem      MAKEOBJDIRPREFIX  Top level directory of the object directory tree.  If
    127   1.8     lukem                        this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used
    128   1.8     lukem                        as the .OBJDIR for the current directory.  The current
    129   1.8     lukem                        directory may be read only.  MAKEOBJDIRPREFIX can only
    130  1.36     lukem                        be provided in the environment or via the -M flag of
    131  1.36     lukem                        build.sh.
    132   1.8     lukem 
    133   1.1        tv    "make" variables
    134   1.1        tv      Several variables control the behavior of NetBSD builds.  Unless other-
    135   1.1        tv      wise specified, these variables may be set in either the process environ-
    136   1.1        tv      ment or the make(1) configuration file specified by MAKECONF.
    137   1.1        tv 
    138   1.9   thorpej      BUILDID     Identifier for the build.  The identifier will be appended to
    139   1.9   thorpej                  object directory names, and can be consulted in the make(1)
    140   1.9   thorpej                  configuration file in order to set additional build parame-
    141   1.9   thorpej                  ters, such as compiler flags.
    142   1.9   thorpej 
    143   1.1        tv      DESTDIR     Directory to contain the built NetBSD system.  If set, spe-
    144   1.1        tv                  cial options are passed to the compilation tools to prevent
    145   1.1        tv                  their default use of the host system's /usr/include,
    146   1.1        tv                  /usr/lib, and so forth.  This pathname should not end with a
    147   1.1        tv                  slash (/) character (for installation into the system's root
    148   1.7     lukem                  directory, set DESTDIR to an empty string).  The directory
    149   1.7     lukem                  must reside on a file system which supports long file names
    150   1.7     lukem                  and hard links.
    151   1.1        tv 
    152   1.1        tv                  Default: Empty string if USETOOLS is ``yes''; unset other-
    153   1.1        tv                  wise.
    154   1.1        tv 
    155  1.30     lukem                  Note: build.sh will provide a default of destdir.MACHINE (in
    156  1.30     lukem                  the top-level .OBJDIR) unless run in `expert' mode
    157  1.30     lukem 
    158   1.1        tv      MAKECONF    The name of the make(1) configuration file.  Only settable in
    159   1.1        tv                  the process environment.
    160   1.1        tv 
    161   1.1        tv                  Default: ``/etc/mk.conf''
    162   1.1        tv 
    163  1.45     lukem      MAKEVERBOSE
    164  1.45     lukem                  Level of verbosity of status messages.  Supported values:
    165  1.45     lukem 
    166  1.45     lukem                  0    No descriptive messages are shown.
    167  1.45     lukem 
    168  1.45     lukem                  1    Descriptive messages are shown.
    169  1.45     lukem 
    170  1.45     lukem                  2    Descriptive messages (prefixed with a `#') and command
    171  1.45     lukem                       output is not suppressed.
    172  1.45     lukem 
    173  1.45     lukem                  Default: 2
    174  1.45     lukem 
    175   1.1        tv      MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether prefor-
    176   1.1        tv                  matted plaintext manual pages will be created during a build.
    177   1.1        tv 
    178   1.1        tv                  Default: ``yes''
    179   1.1        tv 
    180   1.1        tv      MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether crypto-
    181   1.1        tv                  graphic code will be included in a build; provided for the
    182   1.1        tv                  benefit of countries that do not allow strong cryptography.
    183  1.44     lukem                  Will not affect use of the standard low-security password
    184  1.44     lukem                  encryption system, crypt(3).
    185   1.1        tv 
    186   1.1        tv                  Default: ``yes''
    187   1.1        tv 
    188   1.1        tv      MKDOC       Can be set to ``yes'' or ``no''.  Indicates whether system
    189  1.44     lukem                  documentation destined for DESTDIR/usr/share/doc will be
    190  1.44     lukem                  installed during a build.
    191   1.1        tv 
    192   1.1        tv                  Default: ``yes''
    193   1.1        tv 
    194   1.4        tv      MKHOSTOBJ   Can be set to ``yes'' or ``no''.  If set to ``yes'', then for
    195   1.4        tv                  programs intended to be run on the compile host, the name,
    196   1.4        tv                  release, and architecture of the host operating system will
    197   1.4        tv                  be suffixed to the name of the object directory created by
    198   1.4        tv                  ``make obj''.  (This allows multiple host systems to compile
    199   1.4        tv                  NetBSD for a single target.)  If set to ``no'', then programs
    200   1.4        tv                  built to be run on the compile host will use the same object
    201   1.4        tv                  directory names as programs built to be run on the target.
    202   1.4        tv 
    203   1.4        tv                  Default: ``no''
    204   1.4        tv 
    205   1.1        tv      MKINFO      Can be set to ``yes'' or ``no''.  Indicates whether GNU Info
    206   1.1        tv                  files, used for the documentation for most of the compilation
    207   1.1        tv                  tools, will be created and installed during a build.
    208   1.1        tv 
    209   1.1        tv                  Default: ``yes''
    210   1.1        tv 
    211   1.1        tv      MKLINT      Can be set to ``yes'' or ``no''.  Indicates whether lint(1)
    212   1.1        tv                  will be run against portions of the NetBSD source code during
    213   1.1        tv                  the build, and whether lint libraries will be installed into
    214  1.27     lukem                  DESTDIR/usr/libdata/lint.
    215   1.1        tv 
    216   1.1        tv                  Default: ``yes''
    217   1.1        tv 
    218   1.1        tv      MKMAN       Can be set to ``yes'' or ``no''.  Indicates whether manual
    219   1.1        tv                  pages will be installed during a build.
    220   1.1        tv 
    221   1.1        tv                  Default: ``yes''
    222   1.1        tv 
    223   1.1        tv      MKNLS       Can be set to ``yes'' or ``no''.  Indicates whether Native
    224  1.44     lukem                  Language System locale zone files will be compiled and
    225  1.44     lukem                  installed during a build.
    226   1.1        tv 
    227   1.1        tv                  Default: ``yes''
    228   1.1        tv 
    229   1.1        tv      MKOBJ       Can be set to ``yes'' or ``no''.  Indicates whether object
    230   1.1        tv                  directories will be created when running ``make obj''.  If
    231   1.1        tv                  set to ``no'', then all built files will be located inside
    232   1.1        tv                  the regular source tree.
    233   1.1        tv 
    234   1.1        tv                  Default: ``yes''
    235   1.1        tv 
    236   1.1        tv      MKPIC       Can be set to ``yes'' or ``no''.  Indicates whether shared
    237   1.1        tv                  objects and libraries will be created and installed during a
    238   1.1        tv                  build.  If set to ``no'', the entire built system will be
    239   1.1        tv                  statically linked.
    240   1.1        tv 
    241   1.1        tv                  Default: Platform dependent.  As of this writing, all plat-
    242   1.1        tv                  forms except sh3 default to ``yes''.
    243   1.1        tv 
    244   1.1        tv      MKPICINSTALL
    245   1.1        tv                  Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)
    246  1.44     lukem                  format libraries (lib*_pic.a), used to generate shared
    247  1.44     lukem                  libraries, are installed during a build.
    248   1.1        tv 
    249   1.1        tv                  Default: ``yes''
    250   1.1        tv 
    251   1.1        tv      MKPROFILE   Can be set to ``yes'' or ``no''.  Indicates whether profiled
    252   1.1        tv                  libraries (lib*_p.a) will be built and installed during a
    253   1.1        tv                  build.
    254   1.1        tv 
    255   1.1        tv                  Default: ``yes''; however, some platforms turn off MKPROFILE
    256   1.1        tv                  by default at times due to toolchain problems with profiled
    257   1.1        tv                  code.
    258   1.1        tv 
    259   1.1        tv      MKSHARE     Can be set to ``yes'' or ``no''.  Indicates whether files
    260  1.44     lukem                  destined to reside in DESTDIR/usr/share will be built and
    261  1.44     lukem                  installed during a build.  If set to ``no'', then all of
    262  1.27     lukem                  MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to
    263  1.27     lukem                  ``no'' unconditionally.
    264   1.1        tv 
    265   1.1        tv                  Default: ``yes''
    266   1.1        tv 
    267  1.50       wiz      MKTTINTERP  Can be set to ``yes'' or ``no''.  For X builds, decides if
    268  1.50       wiz                  the TrueType bytecode interpreter is turned on.  See
    269  1.50       wiz                  http://www.freetype.org/patents.html for details.
    270  1.50       wiz 
    271  1.50       wiz                  Default: ``no''
    272  1.50       wiz 
    273  1.44     lukem      MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an
    274  1.44     lukem                  unprivileged install will occur.  The user, group, permis-
    275  1.52       jmc                  sions, and file flags, will not be set on the installed
    276  1.52       jmc                  items; instead the information will be appended to a file
    277  1.52       jmc                  called METALOG in DESTDIR.  The contents of METALOG are used
    278  1.52       jmc                  during the generation of the distribution tar files to ensure
    279  1.52       jmc                  that the appropriate file ownership is stored.
    280  1.38     lukem 
    281  1.38     lukem                  Default: ``no''
    282  1.38     lukem 
    283  1.44     lukem      MKUPDATE    Can be set to ``yes'' or ``no''.  Indicates whether all
    284  1.44     lukem                  install operations intended to write to DESTDIR will compare
    285  1.38     lukem                  file timestamps before installing, and skip the install phase
    286  1.44     lukem                  if the destination files are up-to-date.  This also has
    287  1.44     lukem                  implications on full builds (see next subsection).
    288  1.38     lukem 
    289  1.38     lukem                  Default: ``no''
    290  1.38     lukem 
    291  1.49     lukem      MKX11       Can be set to ``yes'' or ``no''.  Indicates whether X11R6 is
    292  1.49     lukem                  built from X11SRCDIR.
    293  1.49     lukem 
    294  1.49     lukem                  Default: ``no''
    295  1.49     lukem 
    296   1.1        tv      TOOLDIR     Directory to hold the host tools, once built.  This directory
    297   1.1        tv                  should be unique to a given host system and NetBSD source
    298   1.1        tv                  tree.  (However, multiple targets may share the same TOOLDIR;
    299   1.1        tv                  the target-dependent files have unique names.)  If unset, a
    300   1.1        tv                  default based on the uname(1) information of the host plat-
    301  1.39     lukem                  form will be created in the .OBJDIR of src.
    302   1.1        tv 
    303   1.1        tv                  Default: Unset.
    304   1.1        tv 
    305   1.1        tv      USETOOLS    Indicates whether the tools specified by TOOLDIR should be
    306   1.1        tv                  used as part of a build in progress.  Must be set to ``yes''
    307   1.1        tv                  if cross-compiling.
    308   1.1        tv 
    309   1.1        tv                  yes    Use the tools from TOOLDIR.
    310   1.1        tv 
    311   1.1        tv                  no     Do not use the tools from TOOLDIR, but refuse to build
    312   1.1        tv                         native compilation tool components that are version-
    313   1.1        tv                         specific for that tool.
    314   1.1        tv 
    315   1.1        tv                  never  Do not use the tools from TOOLDIR, even when building
    316   1.1        tv                         native tool components.  This is similar to the tradi-
    317   1.1        tv                         tional NetBSD build method, but does not verify that
    318   1.1        tv                         the compilation tools in use are up-to-date enough in
    319   1.1        tv                         order to build the tree successfully.  This may cause
    320   1.1        tv                         build or runtime problems when building the whole
    321   1.1        tv                         NetBSD source tree.
    322   1.1        tv 
    323   1.1        tv                  Default: ``yes'' if building all or part of a whole NetBSD
    324   1.1        tv                  source tree (detected automatically); ``no'' otherwise (to
    325  1.44     lukem                  preserve traditional semantics of the <bsd.*.mk> make(1)
    326  1.44     lukem                  include files).
    327   1.1        tv 
    328  1.49     lukem      X11SRCDIR   Directory containing the X11R6 source.  The main X11R6 source
    329  1.49     lukem                  is found in X11SRCDIR/xfree/xc.
    330  1.49     lukem 
    331  1.49     lukem                  Default: ``/usr/xsrc''
    332  1.49     lukem 
    333   1.1        tv    "make" variables for full builds
    334   1.7     lukem      These variables only affect the top level ``Makefile'' and do not affect
    335   1.7     lukem      manually building subtrees of the NetBSD source code.
    336   1.1        tv 
    337  1.20     lukem      INSTALLWORLDDIR  Location for the ``make installworld'' target to install
    338  1.20     lukem                       to.
    339   1.1        tv 
    340  1.20     lukem                       Default: ``/''
    341   1.1        tv 
    342  1.44     lukem      MKOBJDIRS        Can be set to ``yes'' or ``no''.  Indicates whether
    343  1.44     lukem                       object directories will be created automatically (via a
    344  1.20     lukem                       ``make obj'' pass) at the start of a build.
    345   1.1        tv 
    346  1.34     lukem                       Default: ``no''
    347   1.1        tv 
    348  1.38     lukem      MKUPDATE         Can be set to ``yes'' or ``no''.  If set, then in addi-
    349  1.38     lukem                       tion to the effects described for MKUPDATE=yes above,
    350  1.38     lukem                       this implies the effects of NOCLEANDIR (i.e., ``make
    351  1.38     lukem                       cleandir'' is avoided).
    352  1.38     lukem 
    353  1.38     lukem                       Default: ``no''
    354  1.38     lukem 
    355  1.20     lukem      NBUILDJOBS       Now obsolete.  Use the make(1) option -j, instead (see
    356  1.20     lukem                       below)
    357   1.1        tv 
    358  1.20     lukem                       Default: Unset.
    359   1.1        tv 
    360  1.20     lukem      NOCLEANDIR       If set, avoids the ``make cleandir'' phase of a full
    361  1.20     lukem                       build.  This has the effect of allowing only changed
    362  1.20     lukem                       files in a source tree to be recompiled.  This can speed
    363  1.20     lukem                       up builds when updating only a few files in the tree.
    364   1.1        tv 
    365  1.20     lukem                       Default: Unset.
    366   1.1        tv 
    367  1.20     lukem      NODISTRIBDIRS    If set, avoids the ``make distrib-dirs'' phase of a full
    368  1.20     lukem                       build.  This skips running mtree(8) on DESTDIR, useful
    369  1.20     lukem                       on systems where building as an unprivileged user, or
    370  1.20     lukem                       where it is known that the system-wide mtree files have
    371  1.20     lukem                       not changed.
    372   1.1        tv 
    373  1.20     lukem                       Default: Unset.
    374   1.1        tv 
    375  1.20     lukem      NOINCLUDES       If set, avoids the ``make includes'' phase of a full
    376  1.20     lukem                       build.  This has the effect of preventing make(1) from
    377  1.44     lukem                       thinking that some programs are out-of-date simply
    378  1.44     lukem                       because the system include files have changed.  However,
    379  1.20     lukem                       this option should not be used when updating the entire
    380  1.20     lukem                       NetBSD source tree arbitrarily; it is suggested to use
    381  1.38     lukem                       MKUPDATE=yes in that case.
    382   1.1        tv 
    383  1.20     lukem                       Default: Unset.
    384   1.1        tv 
    385  1.20     lukem      RELEASEDIR       If set, specifies the directory to which a release(7)
    386  1.20     lukem                       layout will be written at the end of a ``make release''.
    387  1.20     lukem 
    388  1.20     lukem                       Default: Unset.
    389  1.20     lukem 
    390  1.30     lukem                       Note: build.sh will provide a default of releasedir (in
    391  1.30     lukem                       the top-level .OBJDIR) unless run in `expert' mode
    392  1.30     lukem 
    393   1.1        tv BUILDING
    394   1.1        tv    "make" command line options
    395  1.52       jmc      This is not a summary of all the options available to make(1); only the
    396  1.52       jmc      options used most frequently with NetBSD builds are listed here.
    397   1.1        tv 
    398  1.10  sommerfe      -j njob    Run up to njob make(1) subjobs in parallel.  Makefiles should
    399  1.52       jmc                 use .WAIT or have explicit dependencies as necessary to
    400  1.44     lukem                 enforce build ordering.  If you see build failures with -j,
    401  1.10  sommerfe                 please save complete build logs so the failures can be ana-
    402  1.10  sommerfe                 lyzed.
    403  1.10  sommerfe 
    404   1.1        tv      -m dir     Specify the default directory for searching for system Make-
    405   1.1        tv                 file segments, mainly the <bsd.*.mk> files.  When building any
    406   1.1        tv                 full NetBSD source tree, this should be set to the
    407   1.1        tv                 ``share/mk'' directory in the source tree.  (This is set auto-
    408   1.1        tv                 matically when building from the top level.)
    409   1.1        tv 
    410   1.1        tv      -n         Display the commands that would have been executed, but do not
    411   1.1        tv                 actually execute them.  This will still cause recursion to
    412   1.1        tv                 take place.
    413   1.1        tv 
    414  1.47    zuntum      -V var     Print make(1)'s idea of the value of var.  Does not build any
    415   1.1        tv                 targets.
    416   1.1        tv 
    417   1.1        tv      var=value  Set the variable var to value, overriding any setting speci-
    418   1.1        tv                 fied by the process environment, the MAKECONF configuration
    419   1.1        tv                 file, or the system Makefile segments.
    420   1.1        tv 
    421   1.1        tv    "make" targets
    422   1.1        tv      These default targets may be built by running make(1) in any subtree of
    423   1.1        tv      the NetBSD source code.  It is recommended that none of these be used
    424   1.1        tv      from the top level Makefile; as a specific exception, ``make obj'' and
    425   1.1        tv      ``make cleandir'' are useful in that context.
    426   1.1        tv 
    427   1.1        tv      all        Build programs, libraries, and preformatted documentation.
    428   1.1        tv 
    429   1.1        tv      clean      Remove program and library object code files.
    430   1.1        tv 
    431  1.44     lukem      cleandir   Same as clean, but also remove preformatted documentation,
    432  1.44     lukem                 dependency files generated by ``make depend'', and any other
    433  1.49     lukem                 files known to be created at build time.
    434   1.1        tv 
    435  1.44     lukem      depend     Create dependency files (.depend) containing more detailed
    436  1.44     lukem                 information about the dependencies of source code on header
    437   1.1        tv                 files.  Allows programs to be recompiled automatically when a
    438   1.1        tv                 dependency changes.
    439   1.1        tv 
    440   1.1        tv      dependall  Does a ``make depend'' immediately followed by a ``make all''.
    441  1.10  sommerfe                 This improves cache locality of the build since both passes
    442  1.10  sommerfe                 read the source files in their entirety.
    443   1.1        tv 
    444  1.49     lukem      distclean  Synonym for cleandir.
    445  1.49     lukem 
    446  1.44     lukem      includes   Build and install system header files.  Typically needed
    447  1.44     lukem                 before any system libraries or programs can be built.
    448   1.1        tv 
    449   1.1        tv      install    Install programs, libraries, and documentation into DESTDIR.
    450  1.27     lukem                 Few files will be installed to DESTDIR/dev, DESTDIR/etc,
    451  1.27     lukem                 DESTDIR/root or DESTDIR/var in order to prevent user supplied
    452  1.27     lukem                 configuration data from being overwritten.
    453   1.1        tv 
    454   1.1        tv      lint       Run lint(1) against the C source code, where appropriate, and
    455   1.1        tv                 generate system-installed lint libraries.
    456   1.1        tv 
    457   1.1        tv      obj        Create object directories to be used for built files, instead
    458   1.1        tv                 of building directly in the source tree.
    459   1.1        tv 
    460   1.1        tv      tags       Create ctags(1) searchable function lists usable by the ex(1)
    461   1.1        tv                 and vi(1) text editors.
    462   1.1        tv 
    463   1.1        tv    "make" targets for the top level
    464   1.1        tv      Additional make(1) targets are usable specifically from the top source
    465   1.1        tv      level to facilitate building the entire NetBSD source tree.
    466   1.1        tv 
    467  1.20     lukem      build         Build the entire NetBSD system.  This orders portions of
    468  1.20     lukem                    the source tree such that prerequisites will be built in
    469  1.20     lukem                    the proper order.
    470  1.20     lukem 
    471  1.20     lukem      distribution  Do a ``make build'', and then install a full distribution
    472  1.27     lukem                    into DESTDIR, including files in DESTDIR/dev, DESTDIR/etc,
    473  1.27     lukem                    DESTDIR/root and DESTDIR/var.
    474  1.20     lukem 
    475  1.20     lukem      buildworld    As per ``make distribution'', except that it ensures that
    476  1.20     lukem                    DESTDIR is not the root directory.
    477  1.20     lukem 
    478  1.20     lukem      installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR
    479  1.20     lukem                    (which defaults to the root directory).  Ensures that
    480  1.52       jmc                    INSTALLWORLDDIR is not the root directory if cross compil-
    481  1.20     lukem                    ing.
    482  1.20     lukem 
    483  1.20     lukem                    Note: It is highly recommended that you upgrade your kernel
    484  1.20     lukem                    and reboot before performing this operation.
    485  1.20     lukem 
    486  1.25     lukem      sets          Create distribution sets from DESTDIR into
    487  1.25     lukem                    RELEASEDIR/MACHINE/binary/sets.  Should be run after ``make
    488  1.25     lukem                    distribution'' (as ``make build'' does not install all of
    489  1.25     lukem                    the required files).
    490  1.25     lukem 
    491  1.31     lukem      sourcesets    Create source sets of the source tree into
    492  1.31     lukem                    RELEASEDIR/source/sets.
    493  1.31     lukem 
    494  1.54       apb      syspkgs       Create syspkgs from DESTDIR into
    495  1.54       apb                    RELEASEDIR/MACHINE/binary/syspkgs.  Should be run after
    496  1.54       apb                    ``make distribution'' (as ``make build'' does not install
    497  1.54       apb                    all of the required files).
    498  1.54       apb 
    499  1.44     lukem      release       Do a ``make distribution'', build kernels, distribution
    500  1.44     lukem                    media, and install sets (this as per ``make sets''), and
    501  1.44     lukem                    then package the system into a standard release layout as
    502  1.44     lukem                    described by release(7).  This requires that RELEASEDIR be
    503  1.25     lukem                    set (see above).
    504   1.1        tv 
    505  1.56       apb      iso-image     Create a CD-ROM image in
    506  1.56       apb                    RELEASEDIR/MACHINE/installation/cdrom.  RELEASEDIR must
    507  1.56       apb                    already have been populated by ``make release'' or equiva-
    508  1.56       apb                    lent.  This requires the mkisofs(1) utility, which is not
    509  1.56       apb                    part of NetBSD, but which can be installed from
    510  1.57       apb                    pkgsrc/sysutils/cdrtools.
    511  1.56       apb 
    512   1.1        tv      regression-tests
    513  1.20     lukem                    Can only be run after building the regression tests in the
    514  1.20     lukem                    directory ``regress''.  Runs the compiled regression tests
    515  1.20     lukem                    on the local host.
    516   1.1        tv 
    517   1.1        tv    The "build.sh" script
    518   1.1        tv      This script file is a Bourne shell script designed to build the entire
    519   1.1        tv      NetBSD system on any host with a Bourne shell in /bin/sh, including many
    520   1.1        tv      that are not POSIX compliant.  Note that if a host system's /bin/sh is
    521   1.1        tv      unusually old and broken, the Korn Shell (/bin/ksh), if available, may be
    522   1.1        tv      a usable alternative.
    523   1.1        tv 
    524   1.1        tv      All cross-compile builds, and most native builds, of the entire system
    525   1.1        tv      should make use of build.sh rather than just running ``make''.  This way,
    526   1.1        tv      the make(1) program will be bootstrapped properly, in case the host sys-
    527   1.1        tv      tem has an older or incompatible ``make'' program.
    528   1.1        tv 
    529   1.1        tv      When compiling the entire system via build.sh, many make(1) variables are
    530   1.1        tv      set for you in order to help encapsulate the build process.  In the list
    531   1.1        tv      of options below, variables that are automatically set by build.sh are
    532   1.1        tv      noted where applicable.
    533   1.1        tv 
    534  1.22     lukem      The following operations are supported by build.sh:
    535  1.22     lukem 
    536  1.44     lukem      build         Build the system as per ``make build''.  This option
    537  1.44     lukem                    implies the obj and tools operations.
    538  1.22     lukem 
    539  1.22     lukem      distribution  Build a full distribution as per ``make distribution''.
    540  1.22     lukem                    This option implies the build operation.
    541  1.22     lukem 
    542  1.22     lukem      release       Build a full release as per ``make release''.  This option
    543  1.22     lukem                    implies the distribution operation.
    544  1.22     lukem 
    545  1.23     lukem      makewrapper   Create the nbmake-MACHINE wrapper.  This operation is auto-
    546  1.23     lukem                    matically performed for any of the other operations.
    547  1.23     lukem 
    548  1.22     lukem      obj           Perform ``make obj''.
    549  1.22     lukem 
    550  1.22     lukem      tools         Build and install the host tools from src/tools.
    551  1.22     lukem 
    552  1.35     lukem      install=idir  Install the contents of DESTDIR to idir, using ``make
    553  1.35     lukem                    installworld''.
    554  1.35     lukem 
    555  1.22     lukem      kernel=kconf  Build a new kernel.  The kconf argument is the name of a
    556  1.54       apb                    configuration file suitable for use by config(1).  If kconf
    557  1.22     lukem                    does not contain any `/' characters, the configuration file
    558  1.22     lukem                    is expected to be found in the KERNCONFDIR directory, which
    559  1.22     lukem                    is typically sys/arch/MACHINE/conf.  The new kernel will be
    560  1.22     lukem                    built in a subdirectory of KERNOBJDIR, which is typically
    561  1.22     lukem                    sys/arch/MACHINE/compile or an associated object directory.
    562  1.22     lukem                    In order to ensure that the kernel is built using up-to-
    563  1.22     lukem                    date tools, it is strongly recommended that the tools be
    564  1.22     lukem                    rebuilt (using the tools operation).
    565  1.22     lukem 
    566  1.35     lukem      releasekernel=kconf
    567  1.35     lukem                    Install a gzip(1)ed copy of the kernel built by
    568  1.35     lukem                    kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually
    569  1.44     lukem                    as netbsd-kconf.gz, although the ``netbsd'' prefix is
    570  1.44     lukem                    determined from the ``config'' directives in kconf.
    571  1.24     lukem 
    572  1.24     lukem      sets          Perform ``make sets''.
    573  1.31     lukem 
    574  1.31     lukem      sourcesets    Perform ``make sourcesets''.
    575  1.22     lukem 
    576  1.54       apb      syspkgs       Perform ``make syspkgs''.
    577  1.54       apb 
    578  1.56       apb      iso-image     Perform ``make iso-image''.
    579  1.56       apb 
    580  1.51       wiz      The following command line options alter the behaviour of the build.sh
    581  1.51       wiz      operations described above:
    582   1.1        tv 
    583   1.1        tv      -a arch   Set the value of MACHINE_ARCH to arch.
    584   1.9   thorpej 
    585   1.9   thorpej      -B buildid
    586   1.9   thorpej                Set the value of BUILDID to buildid.  This will also append the
    587   1.9   thorpej                build idenfitier to the name of the ``make'' wrapper script so
    588  1.37     lukem                that the resulting name is of the form
    589  1.37     lukem                ``nbmake-MACHINE-BUILDID''.
    590   1.1        tv 
    591  1.18     lukem      -D dest   Set the value of DESTDIR to dest.
    592  1.18     lukem 
    593  1.23     lukem      -E        Set `expert' mode.  This overrides various sanity checks, and
    594  1.23     lukem                allows: DESTDIR does not have to be set to a non-root path for
    595  1.38     lukem                builds, and MKUNPRIVED=yes does not have to be set when build-
    596  1.38     lukem                ing as a non-root user.
    597  1.23     lukem 
    598  1.23     lukem                Note: It is highly recommended that you know what you are doing
    599  1.23     lukem                when you use this option.
    600  1.19     lukem 
    601  1.51       wiz      -h        Print a help message.
    602  1.51       wiz 
    603  1.10  sommerfe      -j njob   Passed through to make(1).  Makefiles should use .WAIT or have
    604  1.10  sommerfe                explicit dependancies as necessary to enforce build ordering.
    605  1.10  sommerfe                If you see build failures with -j, please save complete build
    606  1.10  sommerfe                logs so the failures can be analyzed.
    607   1.1        tv 
    608  1.40     lukem      -M obj    Set MAKEOBJDIRPREFIX to obj.  Unsets MAKEOBJDIR.
    609  1.18     lukem 
    610   1.1        tv      -m mach   Set the value of MACHINE to mach.  This will also override any
    611   1.1        tv                value of MACHINE_ARCH in the process environment with a value
    612  1.33     lukem                deduced from mach, unless -a is specified, or mach is a special
    613  1.33     lukem                case listed below.  All cross builds require -m, but if unset
    614  1.33     lukem                on a NetBSD host, the host's value of MACHINE will be detected
    615  1.33     lukem                and used automatically.
    616  1.33     lukem 
    617  1.33     lukem                Some machines support multiple values for MACHINE_ARCH.  For a
    618  1.33     lukem                given value of mach, the following MACHINE and MACHINE_ARCH
    619  1.33     lukem                values will result:
    620  1.33     lukem 
    621  1.33     lukem                      mach          MACHINE    MACHINE_ARCH
    622  1.33     lukem                      evbmips       evbmips    (not set)
    623  1.33     lukem                      evbmips-eb    evbmips    mipseb
    624  1.33     lukem                      evbmips-el    evbmips    mipsel
    625  1.33     lukem                      evbsh3        evbsh3     (not set)
    626  1.33     lukem                      evbsh3-eb     evbsh3     sh3eb
    627  1.33     lukem                      evbsh3-el     evbsh3     sh3el
    628  1.33     lukem                      sbmips        sbmips     (not set)
    629  1.33     lukem                      sbmips-eb     sbmips     mipseb
    630  1.33     lukem                      sbmips-el     sbmips     mipsel
    631   1.1        tv 
    632  1.45     lukem      -N noiselevel
    633  1.46     lukem                Set the ``noisyness'' level of the build, by setting
    634  1.46     lukem                MAKEVERBOSE to noiselevel.
    635  1.45     lukem 
    636   1.1        tv      -n        Show the commands that would be executed by build.sh, but do
    637   1.1        tv                not make any changes.  This is similar in concept to ``make
    638   1.1        tv                -n''.
    639   1.1        tv 
    640  1.18     lukem      -O obj    Create an appropriate transform macro for MAKEOBJDIR that will
    641  1.18     lukem                place the built object files under obj.  For instance, a set-
    642  1.18     lukem                ting of /usr/obj will place build-time files under
    643  1.40     lukem                /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth.
    644  1.40     lukem                Unsets MAKEOBJDIRPREFIX.
    645  1.18     lukem 
    646  1.34     lukem      -o        Set the value of MKOBJDIRS to ``no''.  Otherwise, it will be
    647  1.34     lukem                automatically set to ``yes'' (which is opposite to the default
    648  1.34     lukem                behaviour).
    649   1.1        tv 
    650  1.22     lukem      -R rel    Set the value of RELEASEDIR to rel.
    651  1.18     lukem 
    652   1.1        tv      -r        Remove the contents of DESTDIR and TOOLDIR before building
    653   1.1        tv                (provides a clean starting point).  This will skip deleting
    654   1.1        tv                DESTDIR if building on a native system to the root directory.
    655   1.1        tv 
    656  1.18     lukem      -T tools  Set the value of TOOLDIR to tools.  If set, the bootstrap
    657  1.18     lukem                ``make'' will only be rebuilt as needed (when the source files
    658  1.18     lukem                for make(1) change).
    659  1.18     lukem 
    660  1.38     lukem      -U        Set MKUNPRIVED=yes.
    661  1.18     lukem 
    662  1.38     lukem      -u        Set MKUPDATE=yes.
    663   1.1        tv 
    664  1.21     lukem      -V var=[value]
    665  1.40     lukem                Set the environment variable var to an optional value.  This is
    666  1.40     lukem                propagated to the nbmake wrapper.
    667  1.21     lukem 
    668   1.1        tv      -w wrapper
    669   1.1        tv                Create the nbmake wrapper script (see below) in a custom loca-
    670   1.1        tv                tion, specified by wrapper.  This allows, for instance, to
    671   1.1        tv                place the wrapper in PATH automatically.  Note that wrapper is
    672   1.1        tv                the full name of the file, not just a directory name.
    673   1.1        tv 
    674  1.49     lukem      -X x11src
    675  1.49     lukem                Set the value of X11SRCDIR to x11src.
    676  1.49     lukem 
    677  1.49     lukem      -x        Set MKX11=yes.
    678  1.49     lukem 
    679  1.40     lukem      -Z var    Unset ("zap") the environment variable var.  This is propagated
    680  1.40     lukem                to the nbmake wrapper.
    681  1.40     lukem 
    682   1.1        tv    The "nbmake-MACHINE" wrapper script
    683   1.1        tv      If using the build.sh script to build NetBSD, a nbmake-MACHINE script
    684   1.1        tv      will be created in TOOLDIR/bin upon the first build to assist in building
    685   1.1        tv      subtrees on a cross-compile host.
    686   1.1        tv 
    687   1.1        tv      nbmake-MACHINE can be invoked in lieu of make(1), and will instead call
    688   1.1        tv      the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with sev-
    689   1.1        tv      eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR.
    690  1.40     lukem      build.sh will also set variables specified with -V, and unset variables
    691  1.40     lukem      specified with -Z.
    692  1.40     lukem 
    693   1.1        tv      This script can be symlinked into a directory listed in PATH, or called
    694   1.1        tv      with an absolute path.
    695   1.1        tv 
    696  1.16     lukem EXAMPLES
    697  1.44     lukem      1.   % ./build.sh tools kernel=GENERIC
    698  1.28     lukem 
    699  1.28     lukem           Build a new toolchain, and use the new toolchain to configure and
    700  1.28     lukem           build a new GENERIC kernel.
    701  1.28     lukem 
    702  1.44     lukem      2.   % ./build.sh -U distribution
    703  1.28     lukem 
    704  1.30     lukem           Using unprivileged mode, build a complete distribution to a DESTDIR
    705  1.30     lukem           directory that build.sh selects (and will display).
    706  1.28     lukem 
    707  1.43    martti      3.   # ./build.sh -U install=/
    708  1.28     lukem 
    709  1.29     lukem           As root, install to / the distribution that was built by example 2.
    710  1.29     lukem           Even though this is run as root, -U is required so that the permis-
    711  1.30     lukem           sions stored in DESTDIR/METALOG are correctly applied to the files
    712  1.30     lukem           as they're copied to /.
    713  1.28     lukem 
    714  1.44     lukem      4.   % ./build.sh -U -u release
    715  1.28     lukem 
    716  1.30     lukem           Using unprivileged mode, build a complete release to DESTDIR and
    717  1.30     lukem           RELEASEDIR directories that build.sh selects (and will display).
    718  1.38     lukem           MKUPDATE=yes (-u) is set to prevent the ``make cleandir'', so that
    719  1.38     lukem           if this is run after example 2, it doesn't need to redo that portion
    720  1.38     lukem           of the release build.
    721  1.16     lukem 
    722  1.10  sommerfe OBSOLETE VARIABLES
    723  1.15     lukem      NBUILDJOBS  Use the make(1) option -j, instead.
    724  1.15     lukem 
    725  1.15     lukem      USE_NEW_TOOLCHAIN
    726  1.15     lukem                  The new toolchain is now the default.  To disable, use
    727  1.15     lukem                  TOOLCHAIN_MISSING=yes.
    728  1.10  sommerfe 
    729   1.1        tv SEE ALSO
    730  1.57       apb      make(1), hier(7), release(7), pkgsrc/sysutils/cdrtools
    731   1.1        tv 
    732   1.1        tv HISTORY
    733  1.15     lukem      The build.sh based build scheme was introduced for NetBSD 1.6 as
    734  1.15     lukem      USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.
    735   1.1        tv 
    736   1.1        tv BUGS
    737  1.15     lukem      A few platforms are not yet using this build system.
    738   1.1        tv 
    739  1.55       wiz NetBSD                          January 4, 2006                         NetBSD
    740