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

Annotation of src/BUILDING, Revision 1.119

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

CVSweb <webmaster@jp.NetBSD.org>