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

Annotation of src/BUILDING, Revision 1.131

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

CVSweb <webmaster@jp.NetBSD.org>