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

Annotation of src/BUILDING, Revision 1.101

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

CVSweb <webmaster@jp.NetBSD.org>