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

Annotation of src/BUILDING, Revision 1.131.2.1

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

CVSweb <webmaster@jp.NetBSD.org>