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

Annotation of src/BUILDING, Revision 1.121

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

CVSweb <webmaster@jp.NetBSD.org>