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

Annotation of src/BUILDING, Revision 1.106

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

CVSweb <webmaster@jp.NetBSD.org>