[BACK]Return to BUILDING CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src

Annotation of src/BUILDING, Revision 1.107

1.104     wiz         1: BUILDING(8)                 System Manager's Manual                BUILDING(8)
1.1       tv          2:
1.105     wiz         3: NAME
                      4:      BUILDING -- Procedure for building NetBSD from source code.
1.1       tv          5:
1.105     wiz         6: REQUIREMENTS
1.1       tv          7:      NetBSD is designed to be buildable on most POSIX-compliant host systems.
1.105     wiz         8:      The basic build procedure is the same whether compiling natively (on the
                      9:      same NetBSD architecture) or cross compiling (on another architecture or
1.1       tv         10:      OS).
                     11:
                     12:      This source tree contains a special subtree, ``tools'', which uses the
                     13:      host system to create a build toolchain for the target architecture.  The
                     14:      host system must have at least C and C++ compilers in order to create the
1.105     wiz        15:      toolchain (make is not required); all other tools are created as part of
1.53      reed       16:      the NetBSD build process.  (See the environment variables section below
                     17:      if you need to override or manually select your compilers.)
1.1       tv         18:
1.105     wiz        19: FILES
                     20:    Source tree layout
                     21:      doc/BUILDING.mdoc
1.17      wiz        22:                     This document (in -mdoc troff format; the original copy).
1.1       tv         23:
1.105     wiz        24:      BUILDING       This document (in plaintext).
1.1       tv         25:
1.105     wiz        26:      tools/compat/README
1.48      jmc        27:                     Special notes for cross-hosting a NetBSD build on non-
                     28:                     NetBSD platforms.
                     29:
1.105     wiz        30:      Makefile       The main Makefile for NetBSD; should only be run for
1.44      lukem      31:                     native builds with an appropriately up-to-date version of
1.1       tv         32:                     NetBSD make(1).  (For building from out-of-date systems or
1.105     wiz        33:                     on a non-native host, see the build.sh shell script.)
1.1       tv         34:
1.105     wiz        35:      UPDATING       Special notes for updating from an earlier revision of
1.1       tv         36:                     NetBSD.  It is important to read this file before every
                     37:                     build of an updated source tree.
                     38:
1.105     wiz        39:      build.sh       Bourne-compatible shell script used for building the host
1.1       tv         40:                     build tools and the NetBSD system from scratch.  Can be
                     41:                     used for both native and cross builds, and should be used
                     42:                     instead of make(1) for any source tree that is updated and
                     43:                     recompiled regularly.
                     44:
1.105     wiz        45:      crypto/dist/, dist/, gnu/dist/
1.104     wiz        46:                     Sources imported verbatim from third parties, without
                     47:                     mangling the existing build structure.  Other source trees
1.105     wiz        48:                     in bin through usr.sbin use the NetBSD make(1)
1.104     wiz        49:                     ``reachover'' Makefile semantics when building these
                     50:                     programs for a native host.
                     51:
1.106     wiz        52:      external, sys/external
                     53:                     Sources and build infrastructure for components imported
                     54:                     (mostly) unchanged from upstream maintainers, sorted by
                     55:                     applicable license.  This is (slowly) replacing the
                     56:                     crypto/dist, dist, and gnu/dist directories.
                     57:
1.105     wiz        58:      distrib/, etc/
1.104     wiz        59:                     Sources for items used when making a full release
1.105     wiz        60:                     snapshot, such as files installed in DESTDIR/etc on the
1.104     wiz        61:                     destination system, boot media, and release notes.
1.1       tv         62:
1.105     wiz        63:      tests/, regress/
1.70      dholland   64:                     Regression test harness.  Can be cross-compiled, but only
1.105     wiz        65:                     run natively.  tests/ uses the atf(7) test framework;
                     66:                     regress/ contains older tests that have not yet been
1.70      dholland   67:                     migrated to atf(7).
1.1       tv         68:
1.105     wiz        69:      sys/           NetBSD kernel sources.
1.1       tv         70:
1.105     wiz        71:      tools/         ``Reachover'' build structure for the host build tools.
1.104     wiz        72:                     This has a special method of determining out-of-date
                     73:                     status.
1.1       tv         74:
1.105     wiz        75:      bin/ ... usr.sbin/
1.1       tv         76:                     Sources to the NetBSD userland (non-kernel) programs.  If
                     77:                     any of these directories are missing, they will be skipped
                     78:                     during the build.
                     79:
1.105     wiz        80:      x11/           ``Reachover'' build structure for X11R6; the source is in
                     81:                     X11SRCDIR.
1.49      lukem      82:
1.105     wiz        83:    Build tree layout
1.1       tv         84:      The NetBSD build tree is described in hier(7), and the release layout is
                     85:      described in release(7).
                     86:
1.105     wiz        87: CONFIGURATION
                     88:    Environment variables
1.8       lukem      89:      Several environment variables control the behaviour of NetBSD builds.
                     90:
1.105     wiz        91:      HOST_SH           Path name to a shell available on the host system and
1.96      apb        92:                        suitable for use during the build.  The NetBSD build
                     93:                        system requires a modern Bourne-like shell with POSIX-
                     94:                        compliant features, and also requires support for the
                     95:                        ``local'' keyword to declare local variables in shell
1.104     wiz        96:                        functions (which is a widely-implemented but non-
                     97:                        standardised feature).
1.96      apb        98:
                     99:                        Depending on the host system, a suitable shell may be
1.105     wiz       100:                        /bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a
1.96      apb       101:                        variant of ksh that supports the ``local'' keyword,
1.105     wiz       102:                        such as ksh88, but not ksh93), or /usr/local/bin/bash.
1.96      apb       103:
1.105     wiz       104:                        Most parts of the build require HOST_SH to be an
                    105:                        absolute path; however, build.sh allows it to be a
1.104     wiz       106:                        simple command name, which will be converted to an
1.105     wiz       107:                        absolute path by searching the PATH.
1.58      apb       108:
1.105     wiz       109:      HOST_CC           Path name to C compiler used to create the toolchain.
1.53      reed      110:
1.105     wiz       111:      HOST_CXX          Path name to C++ compiler used to create the toolchain.
1.53      reed      112:
1.105     wiz       113:      MACHINE           Machine type, e.g., ``macppc''.
1.8       lukem     114:
1.105     wiz       115:      MACHINE_ARCH      Machine architecture, e.g., ``powerpc''.
1.8       lukem     116:
1.105     wiz       117:      MAKE              Path name to invoke make(1) as.
1.8       lukem     118:
1.105     wiz       119:      MAKEFLAGS         Flags to invoke make(1) with.  Note that build.sh
                    120:                        ignores the value of MAKEFLAGS passed in the
                    121:                        environment, but allows MAKEFLAGS to be set via the -V
1.104     wiz       122:                        option.
1.8       lukem     123:
1.105     wiz       124:      MAKEOBJDIR        Directory to use as the .OBJDIR for the current
1.104     wiz       125:                        directory.  The value is subjected to variable
                    126:                        expansion by make(1).  Typical usage is to set this
                    127:                        variable to a value involving the use of
                    128:                        `${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the
1.105     wiz       129:                        value of .OBJDIR from the value of .CURDIR.  Used only
                    130:                        if MAKEOBJDIRPREFIX is not defined.  MAKEOBJDIR can be
                    131:                        provided only in the environment or via the -O flag of
                    132:                        build.sh; it cannot usefully be set inside a Makefile,
                    133:                        including mk.conf or ${MAKECONF}.
1.8       lukem     134:
1.105     wiz       135:      MAKEOBJDIRPREFIX  Top level directory of the object directory tree.  The
1.88      apb       136:                        value is subjected to variable expansion by make(1).
1.105     wiz       137:                        build.sh will create the ${MAKEOBJDIRPREFIX} directory
                    138:                        if necessary, but if make(1) is used without build.sh,
1.88      apb       139:                        then rules in <bsd.obj.mk> will abort the build if the
                    140:                        ${MAKEOBJDIRPREFIX} directory does not exist.  If the
1.104     wiz       141:                        value is defined and valid, then
1.105     wiz       142:                        ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the .OBJDIR
1.104     wiz       143:                        for the current directory.  The current directory may
1.105     wiz       144:                        be read only.  MAKEOBJDIRPREFIX can be provided only in
                    145:                        the environment or via the -M flag of build.sh; it
1.104     wiz       146:                        cannot usefully be set inside a Makefile, including
1.105     wiz       147:                        mk.conf or ${MAKECONF}.
1.104     wiz       148:
1.105     wiz       149:    "make" variables
1.104     wiz       150:      Several variables control the behavior of NetBSD builds.  Unless
                    151:      otherwise specified, these variables may be set in either the process
1.105     wiz       152:      environment or the make(1) configuration file specified by MAKECONF.
1.1       tv        153:
1.107   ! apb       154:      BUILDID     Identifier for the build.  If set, this should be a short
        !           155:                  string that is suitable for use as part of a file or
        !           156:                  directory name.  The identifier will be appended to object
        !           157:                  directory names, and can be consulted in the make(1)
1.104     wiz       158:                  configuration file in order to set additional build
1.107   ! apb       159:                  parameters, such as compiler flags.  It will also be used as
        !           160:                  part of the kernel version string, which can be printed by
        !           161:                  ``uname -v''.
        !           162:
        !           163:                  Default: Unset.
1.9       thorpej   164:
1.105     wiz       165:      BUILDSEED   GCC uses random numbers when compiling C++ code.  This
1.104     wiz       166:                  variable seeds the gcc random number generator using the
                    167:                  -frandom-seed flag with this value.  By default, it is set to
                    168:                  NetBSD-(majorversion).  Using a fixed value causes C++
                    169:                  binaries to be the same when built from the same sources,
                    170:                  resulting in identical (reproducible) builds.  Additional
                    171:                  information is available in the GCC documentation of
                    172:                  -frandom-seed.
                    173:
1.105     wiz       174:      DESTDIR     Directory to contain the built NetBSD system.  If set,
1.104     wiz       175:                  special options are passed to the compilation tools to
1.105     wiz       176:                  prevent their default use of the host system's /usr/include,
                    177:                  /usr/lib, and so forth.  This pathname must be an absolute
                    178:                  path, and should not end with a slash (/) character.  (For
                    179:                  installation into the system's root directory, set DESTDIR to
1.59      apb       180:                  an empty string, not to ``/'').  The directory must reside on
                    181:                  a file system which supports long file names and hard links.
1.1       tv        182:
1.105     wiz       183:                  Default: Empty string if USETOOLS is ``yes''; unset
1.104     wiz       184:                  otherwise.
1.1       tv        185:
1.105     wiz       186:                  Note: build.sh will provide a default of destdir.MACHINE (in
                    187:                  the top-level .OBJDIR) unless run in `expert' mode.
1.30      lukem     188:
1.105     wiz       189:      MAKECONF    The name of the make(1) configuration file.  Only settable in
                    190:                  the process environment.
1.1       tv        191:
1.105     wiz       192:                  Default: ``/etc/mk.conf''
1.1       tv        193:
1.105     wiz       194:      MAKEVERBOSE
1.45      lukem     195:                  Level of verbosity of status messages.  Supported values:
                    196:
1.80      apb       197:                  0    No descriptive messages or commands executed by make(1)
                    198:                       are shown.
1.45      lukem     199:
1.80      apb       200:                  1    Brief messages are shown describing what is being done,
1.104     wiz       201:                       but the actual commands executed by make(1) are not
                    202:                       displayed.
1.80      apb       203:
                    204:                  2    Descriptive messages are shown as above (prefixed with a
                    205:                       `#'), and ordinary commands performed by make(1) are
                    206:                       displayed.
                    207:
                    208:                  3    In addition to the above, all commands performed by
                    209:                       make(1) are displayed, even if they would ordinarily
                    210:                       have been hidden through use of the ``@'' prefix in the
                    211:                       relevant makefile.
1.45      lukem     212:
1.80      apb       213:                  4    In addition to the above, commands executed by make(1)
1.105     wiz       214:                       are traced through use of the sh(1) ``-x'' flag.
1.45      lukem     215:
1.105     wiz       216:                  Default: 2
1.45      lukem     217:
1.105     wiz       218:      MKCATPAGES  Can be set to ``yes'' or ``no''.  Indicates whether
1.104     wiz       219:                  preformatted plaintext manual pages will be created during a
                    220:                  build.
1.1       tv        221:
1.105     wiz       222:                  Default: ``no''
1.1       tv        223:
1.106     wiz       224:      MKCROSSGDB  Can be set to ``yes'' or ``no''.  Create a cross-gdb as a
                    225:                  host tool.
                    226:
                    227:                  Default: ``no''
                    228:
1.105     wiz       229:      MKCRYPTO    Can be set to ``yes'' or ``no''.  Indicates whether
1.104     wiz       230:                  cryptographic code will be included in a build; provided for
                    231:                  the benefit of countries that do not allow strong
                    232:                  cryptography.  Will not affect use of the standard low-
                    233:                  security password encryption system, crypt(3).
1.1       tv        234:
1.105     wiz       235:                  Default: ``yes''
1.1       tv        236:
1.106     wiz       237:      MKDEBUG     Can be set to ``yes'' or ``no''.  Indicates whether debug
                    238:                  information should be generated for all userland binaries
                    239:                  compiled.  The result is collected as an additional debug.tgz
                    240:                  and xdebug.tgz set and installed in /usr/libdata/debug.
                    241:
                    242:                  Default: ``no''
                    243:
                    244:      MKDEBUGLIB  Can be set to ``yes'' or ``no''.  Indicates whether debug
                    245:                  information (see MKDEBUG) should also be generated for all
                    246:                  libraries build.
                    247:
                    248:                  Default: ``no''
                    249:
1.105     wiz       250:      MKDOC       Can be set to ``yes'' or ``no''.  Indicates whether system
                    251:                  documentation destined for DESTDIR/usr/share/doc will be
1.44      lukem     252:                  installed during a build.
1.1       tv        253:
1.105     wiz       254:                  Default: ``yes''
1.1       tv        255:
1.105     wiz       256:      MKHTML      Can be set to ``yes'' or ``no''.  Indicates whether
1.104     wiz       257:                  preformatted HTML manual pages will be built and installed
1.77      lukem     258:
1.105     wiz       259:                  Default: ``yes''
1.77      lukem     260:
1.105     wiz       261:      MKHOSTOBJ   Can be set to ``yes'' or ``no''.  If set to ``yes'', then for
1.4       tv        262:                  programs intended to be run on the compile host, the name,
                    263:                  release, and architecture of the host operating system will
                    264:                  be suffixed to the name of the object directory created by
                    265:                  ``make obj''.  (This allows multiple host systems to compile
                    266:                  NetBSD for a single target.)  If set to ``no'', then programs
                    267:                  built to be run on the compile host will use the same object
                    268:                  directory names as programs built to be run on the target.
                    269:
1.105     wiz       270:                  Default: ``no''
1.4       tv        271:
1.105     wiz       272:      MKINFO      Can be set to ``yes'' or ``no''.  Indicates whether GNU Info
1.1       tv        273:                  files, used for the documentation for most of the compilation
                    274:                  tools, will be created and installed during a build.
                    275:
1.105     wiz       276:                  Default: ``yes''
1.1       tv        277:
1.106     wiz       278:      MKKDEBUG    Can be set to ``yes'' or ``no''.  Force generation of full-
                    279:                  debug symbol versions of all kernels compiled.  Alongside of
                    280:                  the netbsd kernel file, an unstripped version netbsd.gdb is
                    281:                  created.  This is useful if a cross-gdb is built as well (see
                    282:                  MKCROSSGDB).
                    283:
                    284:                  Default: ``no''
                    285:
1.105     wiz       286:      MKKMOD      Can be set to ``yes'' or ``no''.  Indicates whether kernel
1.95      apb       287:                  modules are built and installed.
                    288:
1.105     wiz       289:                  Default: ``yes''
1.95      apb       290:
1.105     wiz       291:      MKLINT      Can be set to ``yes'' or ``no''.  Indicates whether lint(1)
1.1       tv        292:                  will be run against portions of the NetBSD source code during
                    293:                  the build, and whether lint libraries will be installed into
1.105     wiz       294:                  DESTDIR/usr/libdata/lint.
1.1       tv        295:
1.105     wiz       296:                  Default: ``yes''
1.1       tv        297:
1.105     wiz       298:      MKMAN       Can be set to ``yes'' or ``no''.  Indicates whether manual
1.1       tv        299:                  pages will be installed during a build.
                    300:
1.105     wiz       301:                  Default: ``yes''
1.1       tv        302:
1.105     wiz       303:      MKNLS       Can be set to ``yes'' or ``no''.  Indicates whether Native
1.44      lukem     304:                  Language System locale zone files will be compiled and
                    305:                  installed during a build.
1.1       tv        306:
1.105     wiz       307:                  Default: ``yes''
1.1       tv        308:
1.105     wiz       309:      MKOBJ       Can be set to ``yes'' or ``no''.  Indicates whether object
1.1       tv        310:                  directories will be created when running ``make obj''.  If
                    311:                  set to ``no'', then all built files will be located inside
                    312:                  the regular source tree.
                    313:
1.105     wiz       314:                  Default: ``yes''
1.1       tv        315:
1.105     wiz       316:                  Note that setting MKOBJ to ``no'' is not recommended and may
1.70      dholland  317:                  cause problems when updating the tree with cvs(1).
                    318:
1.105     wiz       319:      MKPIC       Can be set to ``yes'' or ``no''.  Indicates whether shared
1.1       tv        320:                  objects and libraries will be created and installed during a
                    321:                  build.  If set to ``no'', the entire built system will be
                    322:                  statically linked.
                    323:
1.105     wiz       324:                  Default: Platform dependent.  As of this writing, all
                    325:                  platforms except sh3 default to ``yes''.
1.1       tv        326:
1.105     wiz       327:      MKPICINSTALL
1.1       tv        328:                  Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)
1.105     wiz       329:                  format libraries (lib*_pic.a), used to generate shared
1.44      lukem     330:                  libraries, are installed during a build.
1.1       tv        331:
1.105     wiz       332:                  Default: ``yes''
1.1       tv        333:
1.105     wiz       334:      MKPROFILE   Can be set to ``yes'' or ``no''.  Indicates whether profiled
                    335:                  libraries (lib*_p.a) will be built and installed during a
1.1       tv        336:                  build.
                    337:
1.105     wiz       338:                  Default: ``yes''; however, some platforms turn off MKPROFILE
1.1       tv        339:                  by default at times due to toolchain problems with profiled
                    340:                  code.
                    341:
1.105     wiz       342:      MKREPRO     Can be set to ``yes'' or ``no''.  Create reproducable builds.
1.100     wiz       343:                  This enables different switches to make two builds from the
                    344:                  same source tree result in the same build results.
                    345:
1.105     wiz       346:                  Default: ``no''
1.100     wiz       347:
1.105     wiz       348:      MKSHARE     Can be set to ``yes'' or ``no''.  Indicates whether files
                    349:                  destined to reside in DESTDIR/usr/share will be built and
1.44      lukem     350:                  installed during a build.  If set to ``no'', then all of
1.105     wiz       351:                  MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to
1.27      lukem     352:                  ``no'' unconditionally.
1.1       tv        353:
1.105     wiz       354:                  Default: ``yes''
1.1       tv        355:
1.105     wiz       356:      MKSTRIPIDENT
1.102     abs       357:                  Can be set to ``yes'' or ``no''.  Indicates whether RCS IDs,
1.104     wiz       358:                  for use with ident(1), should be stripped from program
                    359:                  binaries and shared libraries.
1.78      apb       360:
1.105     wiz       361:                  Default: ``no''
1.78      apb       362:
1.105     wiz       363:      MKUNPRIVED  Can be set to ``yes'' or ``no''.  Indicates whether an
1.104     wiz       364:                  unprivileged install will occur.  The user, group,
                    365:                  permissions, and file flags, will not be set on the installed
1.52      jmc       366:                  items; instead the information will be appended to a file
1.105     wiz       367:                  called METALOG in DESTDIR.  The contents of METALOG are used
1.52      jmc       368:                  during the generation of the distribution tar files to ensure
                    369:                  that the appropriate file ownership is stored.
1.38      lukem     370:
1.105     wiz       371:                  Default: ``no''
1.38      lukem     372:
1.105     wiz       373:      MKUPDATE    Can be set to ``yes'' or ``no''.  Indicates whether all
                    374:                  install operations intended to write to DESTDIR will compare
1.38      lukem     375:                  file timestamps before installing, and skip the install phase
1.44      lukem     376:                  if the destination files are up-to-date.  This also has
                    377:                  implications on full builds (see next subsection).
1.38      lukem     378:
1.105     wiz       379:                  Default: ``no''
1.38      lukem     380:
1.105     wiz       381:      MKX11       Can be set to ``yes'' or ``no''.  Indicates whether X11 is
                    382:                  built from X11SRCDIR.
1.49      lukem     383:
1.105     wiz       384:                  Default: ``no''
1.49      lukem     385:
1.105     wiz       386:      TOOLDIR     Directory to hold the host tools, once built.  If specified,
1.59      apb       387:                  must be an absolute path.  This directory should be unique to
1.104     wiz       388:                  a given host system and NetBSD source tree.  (However,
1.105     wiz       389:                  multiple targets may share the same TOOLDIR; the target-
1.104     wiz       390:                  dependent files have unique names.)  If unset, a default
                    391:                  based on the uname(1) information of the host platform will
1.105     wiz       392:                  be created in the .OBJDIR of src.
1.1       tv        393:
1.105     wiz       394:                  Default: Unset.
1.1       tv        395:
1.105     wiz       396:      USETOOLS    Indicates whether the tools specified by TOOLDIR should be
1.1       tv        397:                  used as part of a build in progress.  Must be set to ``yes''
                    398:                  if cross-compiling.
                    399:
1.105     wiz       400:                  yes    Use the tools from TOOLDIR.
1.1       tv        401:
1.105     wiz       402:                  no     Do not use the tools from TOOLDIR, but refuse to build
1.1       tv        403:                         native compilation tool components that are version-
                    404:                         specific for that tool.
                    405:
1.105     wiz       406:                  never  Do not use the tools from TOOLDIR, even when building
1.104     wiz       407:                         native tool components.  This is similar to the
1.105     wiz       408:                         traditional NetBSD build method, but does not verify
1.104     wiz       409:                         that the compilation tools in use are up-to-date
                    410:                         enough in order to build the tree successfully.  This
                    411:                         may cause build or runtime problems when building the
                    412:                         whole NetBSD source tree.
1.1       tv        413:
1.105     wiz       414:                  Default: ``yes'', unless TOOLCHAIN_MISSING is set to ``yes''.
1.71      dholland  415:
1.105     wiz       416:                  USETOOLS is also set to ``no'' when using <bsd.*.mk> outside
1.71      dholland  417:                  the NetBSD source tree.
1.1       tv        418:
1.105     wiz       419:      X11SRCDIR   Directory containing the X11R6 source.  If specified, must be
1.59      apb       420:                  an absolute path.  The main X11R6 source is found in
1.105     wiz       421:                  X11SRCDIR/xfree/xc.
1.49      lukem     422:
1.105     wiz       423:                  Default: NETBSDRCDIR/../xsrc, if that exists; otherwise
                    424:                  /usr/xsrc.
1.49      lukem     425:
1.105     wiz       426:      X11FLAVOUR  The style of X11 cross-built, set to either ``Xorg'' or
1.79      mrg       427:                  ``XFree86''.
                    428:
1.105     wiz       429:                  Default: ``Xorg'' on amd64, i386, macppc, shark and sparc64
1.81      mrg       430:                  platforms, ``XFree86'' on everything else.
1.79      mrg       431:
1.105     wiz       432:    "make" variables for full builds
1.7       lukem     433:      These variables only affect the top level ``Makefile'' and do not affect
                    434:      manually building subtrees of the NetBSD source code.
1.1       tv        435:
1.105     wiz       436:      INSTALLWORLDDIR  Location for the ``make installworld'' target to install
1.59      apb       437:                       to.  If specified, must be an absolute path.
1.1       tv        438:
1.105     wiz       439:                       Default: ``/''
1.1       tv        440:
1.105     wiz       441:      MKOBJDIRS        Can be set to ``yes'' or ``no''.  Indicates whether
1.44      lukem     442:                       object directories will be created automatically (via a
1.20      lukem     443:                       ``make obj'' pass) at the start of a build.
1.1       tv        444:
1.105     wiz       445:                       Default: ``no''
1.1       tv        446:
1.105     wiz       447:                       If using build.sh, the default is ``yes''.  This may be
                    448:                       set back to ``no'' by giving build.sh the -o option.
1.70      dholland  449:
1.105     wiz       450:      MKUPDATE         Can be set to ``yes'' or ``no''.  If set, then in
                    451:                       addition to the effects described for MKUPDATE=yes
                    452:                       above, this implies the effects of NOCLEANDIR (i.e.,
1.104     wiz       453:                       ``make cleandir'' is avoided).
1.38      lukem     454:
1.105     wiz       455:                       Default: ``no''
1.38      lukem     456:
1.105     wiz       457:                       If using build.sh, this may be set by giving the -u
1.70      dholland  458:                       option.
                    459:
1.105     wiz       460:      NBUILDJOBS       Now obsolete.  Use the make(1) option -j, instead.  See
1.70      dholland  461:                       below.
1.1       tv        462:
1.105     wiz       463:                       Default: Unset.
1.1       tv        464:
1.105     wiz       465:      NOCLEANDIR       If set, avoids the ``make cleandir'' phase of a full
1.20      lukem     466:                       build.  This has the effect of allowing only changed
                    467:                       files in a source tree to be recompiled.  This can speed
                    468:                       up builds when updating only a few files in the tree.
1.1       tv        469:
1.105     wiz       470:                       Default: Unset.
1.1       tv        471:
1.105     wiz       472:                       See also MKUPDATE.
1.70      dholland  473:
1.105     wiz       474:      NODISTRIBDIRS    If set, avoids the ``make distrib-dirs'' phase of a full
                    475:                       build.  This skips running mtree(8) on DESTDIR, useful
1.20      lukem     476:                       on systems where building as an unprivileged user, or
                    477:                       where it is known that the system-wide mtree files have
                    478:                       not changed.
1.1       tv        479:
1.105     wiz       480:                       Default: Unset.
1.1       tv        481:
1.105     wiz       482:      NOINCLUDES       If set, avoids the ``make includes'' phase of a full
1.20      lukem     483:                       build.  This has the effect of preventing make(1) from
1.44      lukem     484:                       thinking that some programs are out-of-date simply
                    485:                       because the system include files have changed.  However,
1.20      lukem     486:                       this option should not be used when updating the entire
                    487:                       NetBSD source tree arbitrarily; it is suggested to use
1.105     wiz       488:                       MKUPDATE=yes instead in that case.
1.1       tv        489:
1.105     wiz       490:                       Default: Unset.
1.1       tv        491:
1.105     wiz       492:      RELEASEDIR       If set, specifies the directory to which a release(7)
1.20      lukem     493:                       layout will be written at the end of a ``make release''.
1.59      apb       494:                       If specified, must be an absolute path.
1.20      lukem     495:
1.105     wiz       496:                       Default: Unset.
1.20      lukem     497:
1.105     wiz       498:                       Note: build.sh will provide a default of releasedir (in
                    499:                       the top-level .OBJDIR) unless run in `expert' mode.
1.30      lukem     500:
1.105     wiz       501: BUILDING
                    502:    "make" command line options
1.52      jmc       503:      This is not a summary of all the options available to make(1); only the
                    504:      options used most frequently with NetBSD builds are listed here.
1.1       tv        505:
1.105     wiz       506:      -j njob    Run up to njob make(1) subjobs in parallel.  Makefiles should
1.52      jmc       507:                 use .WAIT or have explicit dependencies as necessary to
1.74      apb       508:                 enforce build ordering.
1.10      sommerfe  509:
1.105     wiz       510:      -m dir     Specify the default directory for searching for system
1.104     wiz       511:                 Makefile segments, mainly the <bsd.*.mk> files.  When building
                    512:                 any full NetBSD source tree, this should be set to the
                    513:                 ``share/mk'' directory in the source tree.  This is set
                    514:                 automatically when building from the top level, or when using
1.105     wiz       515:                 build.sh.
1.1       tv        516:
1.105     wiz       517:      -n         Display the commands that would have been executed, but do not
1.1       tv        518:                 actually execute them.  This will still cause recursion to
                    519:                 take place.
                    520:
1.105     wiz       521:      -V var     Print make(1)'s idea of the value of var.  Does not build any
1.1       tv        522:                 targets.
                    523:
1.105     wiz       524:      var=value  Set the variable var to value, overriding any setting
                    525:                 specified by the process environment, the MAKECONF
1.104     wiz       526:                 configuration file, or the system Makefile segments.
1.1       tv        527:
1.105     wiz       528:    "make" targets
1.1       tv        529:      These default targets may be built by running make(1) in any subtree of
                    530:      the NetBSD source code.  It is recommended that none of these be used
                    531:      from the top level Makefile; as a specific exception, ``make obj'' and
                    532:      ``make cleandir'' are useful in that context.
                    533:
1.105     wiz       534:      all        Build programs, libraries, and preformatted documentation.
1.1       tv        535:
1.105     wiz       536:      clean      Remove program and library object code files.
1.1       tv        537:
1.105     wiz       538:      cleandir   Same as clean, but also remove preformatted documentation,
1.44      lukem     539:                 dependency files generated by ``make depend'', and any other
1.49      lukem     540:                 files known to be created at build time.
1.1       tv        541:
1.105     wiz       542:      depend     Create dependency files (.depend) containing more detailed
1.44      lukem     543:                 information about the dependencies of source code on header
1.1       tv        544:                 files.  Allows programs to be recompiled automatically when a
                    545:                 dependency changes.
                    546:
1.105     wiz       547:      dependall  Does a ``make depend'' immediately followed by a ``make all''.
1.10      sommerfe  548:                 This improves cache locality of the build since both passes
                    549:                 read the source files in their entirety.
1.1       tv        550:
1.105     wiz       551:      distclean  Synonym for cleandir.
1.49      lukem     552:
1.105     wiz       553:      includes   Build and install system header files.  Typically needed
1.44      lukem     554:                 before any system libraries or programs can be built.
1.1       tv        555:
1.105     wiz       556:      install    Install programs, libraries, and documentation into DESTDIR.
                    557:                 Few files will be installed to DESTDIR/dev, DESTDIR/etc,
                    558:                 DESTDIR/root or DESTDIR/var in order to prevent user supplied
1.27      lukem     559:                 configuration data from being overwritten.
1.1       tv        560:
1.105     wiz       561:      lint       Run lint(1) against the C source code, where appropriate, and
1.1       tv        562:                 generate system-installed lint libraries.
                    563:
1.105     wiz       564:      obj        Create object directories to be used for built files, instead
1.1       tv        565:                 of building directly in the source tree.
                    566:
1.105     wiz       567:      tags       Create ctags(1) searchable function lists usable by the ex(1)
1.1       tv        568:                 and vi(1) text editors.
                    569:
1.105     wiz       570:    "make" targets for the top level
1.1       tv        571:      Additional make(1) targets are usable specifically from the top source
                    572:      level to facilitate building the entire NetBSD source tree.
                    573:
1.105     wiz       574:      build         Build the entire NetBSD system (except the kernel).  This
1.68      reed      575:                    orders portions of the source tree such that prerequisites
                    576:                    will be built in the proper order.
1.20      lukem     577:
1.105     wiz       578:      distribution  Do a ``make build'', and then install a full distribution
                    579:                    (which does not include a kernel) into DESTDIR, including
                    580:                    files in DESTDIR/dev, DESTDIR/etc, DESTDIR/root and
                    581:                    DESTDIR/var.
1.20      lukem     582:
1.105     wiz       583:      buildworld    As per ``make distribution'', except that it ensures that
                    584:                    DESTDIR is not the root directory.
1.20      lukem     585:
1.105     wiz       586:      installworld  Install the distribution from DESTDIR to INSTALLWORLDDIR,
1.70      dholland  587:                    which defaults to the root directory.  Ensures that
1.105     wiz       588:                    INSTALLWORLDDIR is not the root directory if cross
1.104     wiz       589:                    compiling.
1.20      lukem     590:
1.105     wiz       591:                    The INSTALLSETS environment variable may be set to a space-
1.95      apb       592:                    separated list of distribution sets to be installed.  By
                    593:                    default, all sets except ``etc'' and ``xetc'' are
1.105     wiz       594:                    installed, so most files in INSTALLWORLDDIR/etc will not be
1.95      apb       595:                    installed or modified.
1.61      apb       596:
1.105     wiz       597:                    Note: Before performing this operation with
                    598:                    INSTALLWORLDDIR=/, it is highly recommended that you
1.61      apb       599:                    upgrade your kernel and reboot.  After performing this
                    600:                    operation, it is recommended that you use etcupdate(8) to
1.105     wiz       601:                    update files in INSTALLWORLDDIR/etc, and postinstall(8) to
1.102     abs       602:                    check for or fix inconsistencies.
1.20      lukem     603:
1.105     wiz       604:      sets          Create distribution sets from DESTDIR into
                    605:                    RELEASEDIR/RELEASEMACHINEDIR/binary/sets.  Should be run
1.70      dholland  606:                    after ``make distribution'', as ``make build'' alone does
                    607:                    not install all of the required files.
1.25      lukem     608:
1.105     wiz       609:      sourcesets    Create source sets of the source tree into
                    610:                    RELEASEDIR/source/sets.
1.31      lukem     611:
1.105     wiz       612:      syspkgs       Create syspkgs from DESTDIR into
                    613:                    RELEASEDIR/RELEASEMACHINEDIR/binary/syspkgs.  Should be run
1.70      dholland  614:                    after ``make distribution'', as ``make build'' alone does
                    615:                    not install all of the required files.
1.54      apb       616:
1.105     wiz       617:      release       Do a ``make distribution'', build kernels, distribution
1.44      lukem     618:                    media, and install sets (this as per ``make sets''), and
                    619:                    then package the system into a standard release layout as
1.105     wiz       620:                    described by release(7).  This requires that RELEASEDIR be
1.25      lukem     621:                    set (see above).
1.1       tv        622:
1.105     wiz       623:      iso-image     Create a NetBSD installation CD-ROM image in the
                    624:                    RELEASEDIR/iso directory.  The CD-ROM file system will have
1.62      apb       625:                    a layout as described in release(7).
                    626:
                    627:                    For most machine types, the CD-ROM will be bootable, and
1.104     wiz       628:                    will automatically run the sysinst(8) menu-based
                    629:                    installation program, which can be used to install or
                    630:                    upgrade a NetBSD system.  Bootable CD-ROMs also contain
                    631:                    tools that may be useful in repairing a damaged NetBSD
                    632:                    installation.
1.62      apb       633:
                    634:                    Before ``make iso-image'' is attempted, RELEASEDIR must be
                    635:                    populated by ``make release'' or equivalent.
                    636:
                    637:                    Note that other, smaller, CD-ROM images may be created in
1.105     wiz       638:                    the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom
1.104     wiz       639:                    directory by ``make release''.  These smaller images
                    640:                    usually contain the same tools as the larger images in
1.105     wiz       641:                    RELEASEDIR/iso, but do not contain additional content such
1.69      lukem     642:                    as the distribution sets.
1.62      apb       643:
                    644:                    Note that the mac68k port still uses an older method of
1.104     wiz       645:                    creating CD-ROM images.  This requires the mkisofs(1)
                    646:                    utility, which is not part of NetBSD, but which can be
1.105     wiz       647:                    installed from pkgsrc/sysutils/cdrtools.
1.56      apb       648:
1.105     wiz       649:      iso-image-source
1.64      jnemeth   650:                    Create a NetBSD installation CD-ROM image in the
1.105     wiz       651:                    RELEASEDIR/iso directory.  The CD-ROM file system will have
1.64      jnemeth   652:                    a layout as described in release(7).  It will have top
                    653:                    level directories for the machine type and source.
                    654:
                    655:                    For most machine types, the CD-ROM will be bootable, and
1.104     wiz       656:                    will automatically run the sysinst(8) menu-based
                    657:                    installation program, which can be used to install or
                    658:                    upgrade a NetBSD system.  Bootable CD-ROMs also contain
                    659:                    tools that may be useful in repairing a damaged NetBSD
                    660:                    installation.
1.64      jnemeth   661:
                    662:                    Before ``make iso-image-source'' is attempted, RELEASEDIR
1.104     wiz       663:                    must be populated by ``make sourcesets release'' or
                    664:                    equivalent.
1.64      jnemeth   665:
                    666:                    Note that other, smaller, CD-ROM images may be created in
1.105     wiz       667:                    the RELEASEDIR/RELEASEMACHINEDIR/installation/cdrom
1.104     wiz       668:                    directory by ``make release''.  These smaller images
                    669:                    usually contain the same tools as the larger images in
1.105     wiz       670:                    RELEASEDIR/iso, but do not contain additional content such
1.69      lukem     671:                    as the distribution sets.
1.64      jnemeth   672:
                    673:                    Note that the mac68k port still uses an older method of
1.104     wiz       674:                    creating CD-ROM images.  This requires the mkisofs(1)
                    675:                    utility, which is not part of NetBSD, but which can be
1.105     wiz       676:                    installed from pkgsrc/sysutils/cdrtools.
1.64      jnemeth   677:
1.105     wiz       678:      install-image
1.98      apb       679:                    Create a bootable NetBSD installation disk image in the
1.105     wiz       680:                    RELEASEDIR/RELEASEMACHINEDIR/installation/installimage
1.98      apb       681:                    directory.  The installation disk image is suitable for
                    682:                    copying to bootable USB flash memory sticks, etc., for
                    683:                    machines which are able to boot from such devices.  The
                    684:                    file system in the bootable disk image will have a layout
                    685:                    as described in release(7).
1.97      tsutsui   686:
                    687:                    The installation image is bootable, and will automatically
                    688:                    run the sysinst(8) menu-based installation program, which
1.98      apb       689:                    can be used to install or upgrade a NetBSD system.  The
                    690:                    image also contains tools that may be useful in repairing a
                    691:                    damaged NetBSD installation.
1.97      tsutsui   692:
1.105     wiz       693:                    Before ``make install-image'' is attempted, RELEASEDIR must
1.98      apb       694:                    be populated by ``make release'' or equivalent.  The build
1.105     wiz       695:                    must have been performed with MKUNPRIVED=yes because ``make
                    696:                    install-image'' relies on information in DESTDIR/METALOG.
1.97      tsutsui   697:
                    698:      live-image    Create NetBSD live images in the
1.105     wiz       699:                    RELEASEDIR/RELEASEMACHINEDIR/installation/liveimage
1.104     wiz       700:                    directory.  The live image contains all necessary files to
                    701:                    boot NetBSD up to multi-user mode, including all files
                    702:                    which should be extracted during installation, NetBSD
                    703:                    disklabel, bootloaders, etc.
                    704:
                    705:                    The live image is suitable for use as a disk image in
                    706:                    virtual machine environments such as QEMU, and also useful
                    707:                    to boot NetBSD from a USB flash memory stick on a real
1.98      apb       708:                    machine, without the need for installation.
1.97      tsutsui   709:
                    710:                    Before ``make live-image'' is attempted, RELEASEDIR must be
1.99      tsutsui   711:                    populated by ``make release'' or equivalent.  The build
1.105     wiz       712:                    must have been performed with MKUNPRIVED=yes because ``make
                    713:                    install-image'' relies on information in DESTDIR/METALOG.
1.97      tsutsui   714:
1.105     wiz       715:      regression-tests
1.20      lukem     716:                    Can only be run after building the regression tests in the
1.70      dholland  717:                    directory ``regress''.  Runs those compiled regression
1.104     wiz       718:                    tests on the local host.  Note that most tests are now
                    719:                    managed instead using atf(7); this target should probably
                    720:                    run those as well but currently does not.
1.1       tv        721:
1.105     wiz       722:    The "build.sh" script
1.96      apb       723:      This script file is a shell script designed to build the entire NetBSD
1.104     wiz       724:      system on any host with a suitable modern shell and some common
1.105     wiz       725:      utilities.  The required shell features are described under the HOST_SH
1.104     wiz       726:      variable.
1.96      apb       727:
                    728:      If a host system's default shell does support the required features, then
                    729:      we suggest that you explicitly specify a suitable shell using a command
                    730:      like
                    731:
1.105     wiz       732:            /path/to/suitable/shell build.sh [options]
1.96      apb       733:
1.105     wiz       734:      The above command will usually enable build.sh to automatically set
                    735:      HOST_SH=/path/to/suitable/shell, but if that fails, then the following
1.96      apb       736:      set of commands may be used instead:
                    737:
1.105     wiz       738:            HOST_SH=/path/to/suitable/shell
1.96      apb       739:            export HOST_SH
1.105     wiz       740:            ${HOST_SH} build.sh [options]
1.96      apb       741:
1.105     wiz       742:      If build.sh detects that it is being executed under an unsuitable shell,
1.96      apb       743:      it attempts to exec a suitable shell instead, or prints an error message.
1.105     wiz       744:      If HOST_SH is not set explicitly, then build.sh sets a default using
1.96      apb       745:      heuristics dependent on the host platform, or from the shell under which
1.105     wiz       746:      build.sh is executed (if that can be determined), or using the first copy
                    747:      of sh found in PATH.
1.1       tv        748:
                    749:      All cross-compile builds, and most native builds, of the entire system
1.105     wiz       750:      should make use of build.sh rather than just running ``make''.  This way,
1.104     wiz       751:      the make(1) program will be bootstrapped properly, in case the host
                    752:      system has an older or incompatible ``make'' program.
1.1       tv        753:
1.105     wiz       754:      When compiling the entire system via build.sh, many make(1) variables are
1.1       tv        755:      set for you in order to help encapsulate the build process.  In the list
1.105     wiz       756:      of options below, variables that are automatically set by build.sh are
1.1       tv        757:      noted where applicable.
                    758:
1.105     wiz       759:      The following operations are supported by build.sh:
1.22      lukem     760:
1.105     wiz       761:      build         Build the system as per ``make build''.  Before the main
                    762:                    part of the build commences, this command runs the obj
                    763:                    operation (unless the -o option is given), ``make
                    764:                    cleandir'' (unless the -u option is given), and the tools
1.70      dholland  765:                    operation.
1.22      lukem     766:
1.105     wiz       767:      distribution  Build a full distribution as per ``make distribution''.
                    768:                    This command first runs the build operation.
1.22      lukem     769:
1.105     wiz       770:      release       Build a full release as per ``make release''.  This command
                    771:                    first runs the distribution operation.
1.22      lukem     772:
1.105     wiz       773:      makewrapper   Create the nbmake-MACHINE wrapper.  This operation is
1.104     wiz       774:                    automatically performed for any of the other operations.
1.23      lukem     775:
1.105     wiz       776:      cleandir      Perform ``make cleandir''.
1.75      lukem     777:
1.105     wiz       778:      obj           Perform ``make obj''.
1.22      lukem     779:
1.105     wiz       780:      tools         Build and install the host tools from src/tools.  This
1.104     wiz       781:                    command will first run ``make obj'' and ``make cleandir''
1.105     wiz       782:                    in the tools subdirectory unless the -o or -u options
1.104     wiz       783:                    (respectively) are given.
1.22      lukem     784:
1.105     wiz       785:      install=idir  Install the contents of DESTDIR to idir, using ``make
1.61      apb       786:                    installworld''.  Note that files that are part of the
1.95      apb       787:                    ``etc'' or ``xetc'' sets will not be installed, unless
                    788:                    overridden by the INSTALLSETS environment variable.
1.35      lukem     789:
1.105     wiz       790:      kernel=kconf  Build a new kernel.  The kconf argument is the name of a
                    791:                    configuration file suitable for use by config(1).  If kconf
1.22      lukem     792:                    does not contain any `/' characters, the configuration file
1.105     wiz       793:                    is expected to be found in the KERNCONFDIR directory, which
                    794:                    is typically sys/arch/MACHINE/conf.  The new kernel will be
                    795:                    built in a subdirectory of KERNOBJDIR, which is typically
                    796:                    sys/arch/MACHINE/compile or an associated object directory.
1.70      dholland  797:
1.105     wiz       798:                    This command does not imply the tools command; run the
                    799:                    tools command first unless it is certain that the tools
1.70      dholland  800:                    already exist and are up to date.
                    801:
                    802:                    This command will run ``make cleandir'' on the kernel in
1.105     wiz       803:                    question first unless the -u option is given.
1.22      lukem     804:
1.106     wiz       805:      kernel.gdb=kconf
                    806:                    Build a new kernel with debug information.  Similar to the
                    807:                    above kernel=kconf operation, but creates a netbsd.gdb file
                    808:                    alongside of the kernel netbsd, which contains a full
                    809:                    symbol table and can be used for debugging (for example
                    810:                    with a cross-gdb built by MKCROSSGDB).
                    811:
1.105     wiz       812:      modules       This command will build kernel modules and install them
                    813:                    into DESTDIR.
1.86      jnemeth   814:
1.105     wiz       815:      releasekernel=kconf
1.70      dholland  816:                    Install a gzip(1)ed copy of the kernel previously built by
1.105     wiz       817:                    kernel=kconf into
                    818:                    RELEASEDIR/RELEASEMACHINEDIR/binary/kernel, usually as
                    819:                    netbsd-kconf.gz, although the ``netbsd'' prefix is
                    820:                    determined from the ``config'' directives in kconf.
1.24      lukem     821:
1.105     wiz       822:      sets          Perform ``make sets''.
1.31      lukem     823:
1.105     wiz       824:      sourcesets    Perform ``make sourcesets''.
1.22      lukem     825:
1.105     wiz       826:      syspkgs       Perform ``make syspkgs''.
1.54      apb       827:
1.105     wiz       828:      iso-image     Perform ``make iso-image''.
1.56      apb       829:
1.105     wiz       830:      iso-image-source
1.65      jnemeth   831:                    Perform ``make iso-image-source''.
                    832:
1.105     wiz       833:      install-image
1.98      apb       834:                    Perform ``make install-image''.
1.97      tsutsui   835:
1.105     wiz       836:      live-image    Perform ``make live-image''.
1.97      tsutsui   837:
1.105     wiz       838:      The following command line options alter the behaviour of the build.sh
1.51      wiz       839:      operations described above:
1.1       tv        840:
1.105     wiz       841:      -a arch   Set the value of MACHINE_ARCH to arch.
1.9       thorpej   842:
1.105     wiz       843:      -B buildid
                    844:                Set the value of BUILDID to buildid.  This will also append the
1.67      sborrill  845:                build identifier to the name of the ``make'' wrapper script so
1.37      lukem     846:                that the resulting name is of the form
1.105     wiz       847:                ``nbmake-MACHINE-BUILDID''.
1.1       tv        848:
1.105     wiz       849:      -C cdextras
                    850:                Append cdextras to the CDEXTRA variable, which is a space-
1.104     wiz       851:                separated list of files or directories that will be added to
                    852:                the CD-ROM image that may be create by the ``iso-image'' or
1.87      apb       853:                ``iso-image-source'' operations.  Files will be added to the
                    854:                root of the CD-ROM image, whereas directories will be copied
                    855:                recursively.  If relative paths are specified, they will be
                    856:                converted to absolute paths before being used.  Multiple paths
1.105     wiz       857:                may be specified via multiple -C options, or via a single
1.87      apb       858:                option whose argument contains multiple space-separated paths.
1.66      jnemeth   859:
1.105     wiz       860:      -D dest   Set the value of DESTDIR to dest.  If a relative path is
1.104     wiz       861:                specified, it will be converted to an absolute path before
                    862:                being used.
                    863:
1.105     wiz       864:      -E        Set `expert' mode.  This overrides various sanity checks, and
                    865:                allows: DESTDIR does not have to be set to a non-root path for
                    866:                builds, and MKUNPRIVED=yes does not have to be set when
1.104     wiz       867:                building as a non-root user.
1.23      lukem     868:
1.105     wiz       869:                Note: It is highly recommended that you know what you are doing
1.23      lukem     870:                when you use this option.
1.19      lukem     871:
1.105     wiz       872:      -h        Print a help message.
1.51      wiz       873:
1.105     wiz       874:      -j njob   Run up to njob make(1) subjobs in parallel; passed through to
1.74      apb       875:                make(1).  If you see failures for reasons other than running
1.105     wiz       876:                out of memory while using build.sh with -j, please save
1.104     wiz       877:                complete build logs so the failures can be analyzed.
1.74      apb       878:
1.105     wiz       879:                To achieve the fastest builds, -j values between (1 + the
1.104     wiz       880:                number of CPUs) and (2 * the number of CPUs) are recommended.
                    881:                Use lower values on machines with limited memory or I/O
                    882:                bandwidth.
                    883:
1.105     wiz       884:      -M obj    Set MAKEOBJDIRPREFIX to obj.  Unsets MAKEOBJDIR.  See ``-O
1.106     wiz       885:                obj'' for more information.
1.104     wiz       886:
1.105     wiz       887:                For instance, if the source directory is /usr/src, a setting of
                    888:                ``-M /usr/obj'' will place build-time files under
                    889:                /usr/obj/usr/src/bin, /usr/obj/usr/src/lib,
                    890:                /usr/obj/usr/src/usr.bin, and so forth.
1.88      apb       891:
1.73      apb       892:                If a relative path is specified, it will be converted to an
1.105     wiz       893:                absolute path before being used.  build.sh imposes the
                    894:                restriction that the argument to the -M option must not begin
1.104     wiz       895:                with a ``$'' (dollar sign) character; otherwise it would be too
                    896:                difficult to determine whether the value is an absolute or a
                    897:                relative path.  If the directory does not already exist,
1.105     wiz       898:                build.sh will create it.
1.18      lukem     899:
1.105     wiz       900:      -m mach   Set the value of MACHINE to mach, except in some special cases
1.60      apb       901:                listed below.  This will also override any value of
1.105     wiz       902:                MACHINE_ARCH in the process environment with a value deduced
                    903:                from mach, unless -a is specified.  All cross builds require
                    904:                -m, but if unset on a NetBSD host, the host's value of MACHINE
1.60      apb       905:                will be detected and used automatically.
                    906:
1.105     wiz       907:                Some machines support multiple values for MACHINE_ARCH.  The
                    908:                following special cases for the mach argument are defined to
                    909:                set the listed values of MACHINE and MACHINE_ARCH:
1.33      lukem     910:
1.105     wiz       911:                      mach          MACHINE    MACHINE_ARCH
1.60      apb       912:                      evbarm        evbarm     (not set)
                    913:                      evbarm-eb     evbarm     armeb
                    914:                      evbarm-el     evbarm     arm
1.33      lukem     915:                      evbmips       evbmips    (not set)
                    916:                      evbmips-eb    evbmips    mipseb
                    917:                      evbmips-el    evbmips    mipsel
                    918:                      evbsh3        evbsh3     (not set)
                    919:                      evbsh3-eb     evbsh3     sh3eb
                    920:                      evbsh3-el     evbsh3     sh3el
                    921:                      sbmips        sbmips     (not set)
                    922:                      sbmips-eb     sbmips     mipseb
                    923:                      sbmips-el     sbmips     mipsel
1.1       tv        924:
1.105     wiz       925:      -N noiselevel
1.46      lukem     926:                Set the ``noisyness'' level of the build, by setting
1.105     wiz       927:                MAKEVERBOSE to noiselevel.
1.45      lukem     928:
1.105     wiz       929:      -n        Show the commands that would be executed by build.sh, but do
1.1       tv        930:                not make any changes.  This is similar in concept to ``make
                    931:                -n''.
                    932:
1.105     wiz       933:      -O obj    Create an appropriate transform macro for MAKEOBJDIR that will
                    934:                place the built object files under obj.  Unsets
                    935:                MAKEOBJDIRPREFIX.
1.88      apb       936:
1.105     wiz       937:                For instance, a setting of ``-O /usr/obj'' will place build-
                    938:                time files under /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin,
1.88      apb       939:                and so forth.
                    940:
                    941:                If a relative path is specified, it will be converted to an
1.105     wiz       942:                absolute path before being used.  build.sh imposes the
                    943:                restriction that the argument to the -O option must not contain
1.104     wiz       944:                a ``$'' (dollar sign) character.  If the directory does not
1.105     wiz       945:                already exist, build.sh will create it.
1.73      apb       946:
1.105     wiz       947:                In normal use, exactly one of the -M or -O options should be
                    948:                specified.  If neither -M nor -O is specified, then a default
1.78      apb       949:                object directory will be chosen according to rules in
                    950:                <bsd.obj.mk>.  Relying on this default is not recommended
                    951:                because it is determined by complex rules that are influenced
                    952:                by the values of several variables and by the location of the
                    953:                source directory.
1.18      lukem     954:
1.105     wiz       955:      -o        Set the value of MKOBJDIRS to ``no''.  Otherwise, it will be
1.70      dholland  956:                automatically set to ``yes''.  This default is opposite to the
1.105     wiz       957:                behaviour when not using build.sh.
1.1       tv        958:
1.105     wiz       959:      -R rel    Set the value of RELEASEDIR to rel.  If a relative path is
1.59      apb       960:                specified, it will be converted to an absolute path before
                    961:                being used.
1.18      lukem     962:
1.105     wiz       963:      -r        Remove the contents of DESTDIR and TOOLDIR before building
1.1       tv        964:                (provides a clean starting point).  This will skip deleting
1.105     wiz       965:                DESTDIR if building on a native system to the root directory.
1.1       tv        966:
1.105     wiz       967:      -S seed   Change the value of BUILDSEED to seed.  This should rarely be
1.72      perry     968:                necessary.
                    969:
1.105     wiz       970:      -T tools  Set the value of TOOLDIR to tools.  If a relative path is
1.104     wiz       971:                specified, it will be converted to an absolute path before
                    972:                being used.  If set, the bootstrap ``make'' will only be
                    973:                rebuilt if the source files for make(1) have changed.
                    974:
1.105     wiz       975:      -U        Set MKUNPRIVED=yes.
1.104     wiz       976:
1.105     wiz       977:      -u        Set MKUPDATE=yes.
1.104     wiz       978:
1.105     wiz       979:      -V var=[value]
                    980:                Set the environment variable var to an optional value.  This is
                    981:                propagated to the nbmake wrapper.
                    982:
                    983:      -w wrapper
                    984:                Create the nbmake wrapper script (see below) in a custom
                    985:                location, specified by wrapper.  This allows, for instance, to
                    986:                place the wrapper in PATH automatically.  Note that wrapper is
1.59      apb       987:                the full name of the file, not just a directory name.  If a
                    988:                relative path is specified, it will be converted to an absolute
                    989:                path before being used.
1.1       tv        990:
1.105     wiz       991:      -X x11src
                    992:                Set the value of X11SRCDIR to x11src.  If a relative path is
1.59      apb       993:                specified, it will be converted to an absolute path before
                    994:                being used.
1.49      lukem     995:
1.105     wiz       996:      -x        Set MKX11=yes.
1.49      lukem     997:
1.105     wiz       998:      -Z var    Unset ("zap") the environment variable var.  This is propagated
                    999:                to the nbmake wrapper.
1.40      lukem    1000:
1.105     wiz      1001:    The "nbmake-MACHINE" wrapper script
                   1002:      If using the build.sh script to build NetBSD, a nbmake-MACHINE script
                   1003:      will be created in TOOLDIR/bin upon the first build to assist in building
1.1       tv       1004:      subtrees on a cross-compile host.
                   1005:
1.105     wiz      1006:      nbmake-MACHINE can be invoked in lieu of make(1), and will instead call
                   1007:      the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with
                   1008:      several key variables pre-set, including MACHINE, MACHINE_ARCH, and
                   1009:      TOOLDIR.  nbmake-MACHINE will also set variables specified with -V, and
                   1010:      unset variables specified with -Z.
1.40      lukem    1011:
1.105     wiz      1012:      This script can be symlinked into a directory listed in PATH, or called
1.1       tv       1013:      with an absolute path.
                   1014:
1.105     wiz      1015: EXAMPLES
1.78      apb      1016:      1.   % ./build.sh [options] tools kernel=GENERIC
1.28      lukem    1017:
                   1018:           Build a new toolchain, and use the new toolchain to configure and
                   1019:           build a new GENERIC kernel.
                   1020:
1.78      apb      1021:      2.   % ./build.sh [options] -U distribution
1.28      lukem    1022:
1.105     wiz      1023:           Using unprivileged mode, build a complete distribution to a DESTDIR
                   1024:           directory that build.sh selects (and will display).
1.28      lukem    1025:
1.78      apb      1026:      3.   # ./build.sh [options] -U install=/
1.28      lukem    1027:
1.105     wiz      1028:           As root, install to / the distribution that was built by example 2.
                   1029:           Even though this is run as root, -U is required so that the
                   1030:           permissions stored in DESTDIR/METALOG are correctly applied to the
                   1031:           files as they're copied to /.
1.28      lukem    1032:
1.78      apb      1033:      4.   % ./build.sh [options] -U -u release
1.28      lukem    1034:
1.105     wiz      1035:           Using unprivileged mode, build a complete release to DESTDIR and
                   1036:           RELEASEDIR directories that build.sh selects (and will display).
                   1037:           MKUPDATE=yes (-u) is set to prevent the ``make cleandir'', so that
1.38      lukem    1038:           if this is run after example 2, it doesn't need to redo that portion
                   1039:           of the release build.
1.16      lukem    1040:
1.105     wiz      1041: OBSOLETE VARIABLES
                   1042:      NBUILDJOBS  Use the make(1) option -j instead.
1.15      lukem    1043:
1.105     wiz      1044:      USE_NEW_TOOLCHAIN
1.15      lukem    1045:                  The new toolchain is now the default.  To disable, use
1.105     wiz      1046:                  TOOLCHAIN_MISSING=yes.
1.10      sommerfe 1047:
1.105     wiz      1048: SEE ALSO
1.62      apb      1049:      make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8),
1.105     wiz      1050:      pkgsrc/sysutils/cdrtools
1.1       tv       1051:
1.105     wiz      1052: HISTORY
                   1053:      The build.sh based build scheme was introduced for NetBSD 1.6 as
                   1054:      USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.
1.1       tv       1055:
1.107   ! apb      1056: NetBSD                           June 14, 2014                          NetBSD

CVSweb <webmaster@jp.NetBSD.org>