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

Annotation of src/BUILDING, Revision 1.100

1.100   ! wiz         1: BUILDING(8)                 System Manager's Manual                BUILDING(8)
1.1       tv          2:
1.100   ! wiz         3: NNAAMMEE
        !             4:      BBUUIILLDDIINNGG -- Procedure for building NetBSD from source code.
1.1       tv          5:
1.100   ! wiz         6: RREEQQUUIIRREEMMEENNTTSS
1.1       tv          7:      NetBSD is designed to be buildable on most POSIX-compliant host systems.
1.100   ! wiz         8:      The basic build procedure is the same whether compiling _n_a_t_i_v_e_l_y (on the
        !             9:      same NetBSD architecture) or _c_r_o_s_s _c_o_m_p_i_l_i_n_g (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.100   ! wiz        15:      toolchain (mmaakkee 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.100   ! wiz        19: FFIILLEESS
        !            20:    SSoouurrccee ttrreeee llaayyoouutt
        !            21:      ddoocc//BBUUIILLDDIINNGG..mmddoocc
1.17      wiz        22:                     This document (in -mdoc troff format; the original copy).
1.1       tv         23:
1.100   ! wiz        24:      BBUUIILLDDIINNGG       This document (in plaintext).
1.1       tv         25:
1.100   ! wiz        26:      ttoooollss//ccoommppaatt//RREEAADDMMEE
1.48      jmc        27:                     Special notes for cross-hosting a NetBSD build on non-
                     28:                     NetBSD platforms.
                     29:
1.100   ! wiz        30:      MMaakkeeffiillee       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.100   ! wiz        33:                     on a non-native host, see the bbuuiilldd..sshh shell script.)
1.1       tv         34:
1.100   ! wiz        35:      UUPPDDAATTIINNGG       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.100   ! wiz        39:      bbuuiilldd..sshh       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.100   ! wiz        45:      ccrryyppttoo//ddiisstt//, ddiisstt//, ggnnuu//ddiisstt//
        !            46:                     Sources imported verbatim from third parties, without
        !            47:                     mangling the existing build structure.  Other source trees
        !            48:                     in bbiinn through uussrr..ssbbiinn use the NetBSD make(1)
        !            49:                     ``reachover'' Makefile semantics when building these
        !            50:                     programs for a native host.
        !            51:
        !            52:      ddiissttrriibb//, eettcc//
        !            53:                     Sources for items used when making a full release
        !            54:                     snapshot, such as files installed in DDEESSTTDDIIRR_/_e_t_c on the
        !            55:                     destination system, boot media, and release notes.
1.1       tv         56:
1.100   ! wiz        57:      tteessttss//, rreeggrreessss//
1.70      dholland   58:                     Regression test harness.  Can be cross-compiled, but only
1.100   ! wiz        59:                     run natively.  _t_e_s_t_s_/ uses the atf(7) test framework;
        !            60:                     _r_e_g_r_e_s_s_/ contains older tests that have not yet been
1.70      dholland   61:                     migrated to atf(7).
1.1       tv         62:
1.100   ! wiz        63:      ssyyss//           NetBSD kernel sources.
1.1       tv         64:
1.100   ! wiz        65:      ttoooollss//         ``Reachover'' build structure for the host build tools.
        !            66:                     This has a special method of determining out-of-date
        !            67:                     status.
1.1       tv         68:
1.100   ! wiz        69:      bbiinn// ...... uussrr..ssbbiinn//
1.1       tv         70:                     Sources to the NetBSD userland (non-kernel) programs.  If
                     71:                     any of these directories are missing, they will be skipped
                     72:                     during the build.
                     73:
1.100   ! wiz        74:      xx1111//           ``Reachover'' build structure for X11R6; the source is in
        !            75:                     XX1111SSRRCCDDIIRR.
1.49      lukem      76:
1.100   ! wiz        77:    BBuuiilldd ttrreeee llaayyoouutt
1.1       tv         78:      The NetBSD build tree is described in hier(7), and the release layout is
                     79:      described in release(7).
                     80:
1.100   ! wiz        81: CCOONNFFIIGGUURRAATTIIOONN
        !            82:    EEnnvviirroonnmmeenntt vvaarriiaabblleess
1.8       lukem      83:      Several environment variables control the behaviour of NetBSD builds.
                     84:
1.100   ! wiz        85:      HHOOSSTT__SSHH           Path name to a shell available on the host system and
1.96      apb        86:                        suitable for use during the build.  The NetBSD build
                     87:                        system requires a modern Bourne-like shell with POSIX-
                     88:                        compliant features, and also requires support for the
                     89:                        ``local'' keyword to declare local variables in shell
1.100   ! wiz        90:                        functions (which is a widely-implemented but non-
        !            91:                        standardised feature).
1.96      apb        92:
                     93:                        Depending on the host system, a suitable shell may be
1.100   ! wiz        94:                        _/_b_i_n_/_s_h, _/_u_s_r_/_x_p_g_4_/_b_i_n_/_s_h, _/_b_i_n_/_k_s_h (provided it is a
1.96      apb        95:                        variant of ksh that supports the ``local'' keyword,
1.100   ! wiz        96:                        such as ksh88, but not ksh93), or _/_u_s_r_/_l_o_c_a_l_/_b_i_n_/_b_a_s_h.
1.96      apb        97:
1.100   ! wiz        98:                        Most parts of the build require HHOOSSTT__SSHH to be an
        !            99:                        absolute path; however, bbuuiilldd..sshh allows it to be a
        !           100:                        simple command name, which will be converted to an
        !           101:                        absolute path by searching the PPAATTHH.
1.58      apb       102:
1.100   ! wiz       103:      HHOOSSTT__CCCC           Path name to C compiler used to create the toolchain.
1.53      reed      104:
1.100   ! wiz       105:      HHOOSSTT__CCXXXX          Path name to C++ compiler used to create the toolchain.
1.53      reed      106:
1.100   ! wiz       107:      MMAACCHHIINNEE           Machine type, e.g., ``macppc''.
1.8       lukem     108:
1.100   ! wiz       109:      MMAACCHHIINNEE__AARRCCHH      Machine architecture, e.g., ``powerpc''.
1.8       lukem     110:
1.100   ! wiz       111:      MMAAKKEE              Path name to invoke make(1) as.
1.8       lukem     112:
1.100   ! wiz       113:      MMAAKKEEFFLLAAGGSS         Flags to invoke make(1) with.  Note that bbuuiilldd..sshh
        !           114:                        ignores the value of MMAAKKEEFFLLAAGGSS passed in the
        !           115:                        environment, but allows MMAAKKEEFFLLAAGGSS to be set via the --VV
        !           116:                        option.
1.8       lukem     117:
1.100   ! wiz       118:      MMAAKKEEOOBBJJDDIIRR        Directory to use as the ..OOBBJJDDIIRR for the current
        !           119:                        directory.  The value is subjected to variable
        !           120:                        expansion by make(1).  Typical usage is to set this
        !           121:                        variable to a value involving the use of
        !           122:                        `${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the
        !           123:                        value of ..OOBBJJDDIIRR from the value of ..CCUURRDDIIRR.  Used only
        !           124:                        if MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX is not defined.  MMAAKKEEOOBBJJDDIIRR can be
        !           125:                        provided only in the environment or via the --OO flag of
        !           126:                        bbuuiilldd..sshh; it cannot usefully be set inside a Makefile,
        !           127:                        including _m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}.
1.8       lukem     128:
1.100   ! wiz       129:      MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX  Top level directory of the object directory tree.  The
1.88      apb       130:                        value is subjected to variable expansion by make(1).
1.100   ! wiz       131:                        bbuuiilldd..sshh will create the ${MAKEOBJDIRPREFIX} directory
        !           132:                        if necessary, but if make(1) is used without bbuuiilldd..sshh,
1.88      apb       133:                        then rules in <bsd.obj.mk> will abort the build if the
                    134:                        ${MAKEOBJDIRPREFIX} directory does not exist.  If the
1.100   ! wiz       135:                        value is defined and valid, then
        !           136:                        ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the ..OOBBJJDDIIRR
        !           137:                        for the current directory.  The current directory may
        !           138:                        be read only.  MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX can be provided only in
        !           139:                        the environment or via the --MM flag of bbuuiilldd..sshh; it
        !           140:                        cannot usefully be set inside a Makefile, including
        !           141:                        _m_k_._c_o_n_f or $${{MMAAKKEECCOONNFF}}.
        !           142:
        !           143:    ""mmaakkee"" vvaarriiaabblleess
        !           144:      Several variables control the behavior of NetBSD builds.  Unless
        !           145:      otherwise specified, these variables may be set in either the process
        !           146:      environment or the make(1) configuration file specified by MMAAKKEECCOONNFF.
1.1       tv        147:
1.100   ! wiz       148:      BBUUIILLDDIIDD     Identifier for the build.  The identifier will be appended to
1.9       thorpej   149:                  object directory names, and can be consulted in the make(1)
1.100   ! wiz       150:                  configuration file in order to set additional build
        !           151:                  parameters, such as compiler flags.
1.9       thorpej   152:
1.100   ! wiz       153:      BBUUIILLDDSSEEEEDD   GCC uses random numbers when compiling C++ code.  This
        !           154:                  variable seeds the gcc random number generator using the
        !           155:                  -frandom-seed flag with this value.  By default, it is set to
        !           156:                  NetBSD-(majorversion).  Using a fixed value causes C++
        !           157:                  binaries to be the same when built from the same sources,
        !           158:                  resulting in identical (reproducible) builds.  Additional
        !           159:                  information is available in the GCC documentation of
        !           160:                  -frandom-seed.
        !           161:
        !           162:      DDEESSTTDDIIRR     Directory to contain the built NetBSD system.  If set,
        !           163:                  special options are passed to the compilation tools to
        !           164:                  prevent their default use of the host system's //uussrr//iinncclluuddee,
        !           165:                  //uussrr//lliibb, and so forth.  This pathname must be an absolute
        !           166:                  path, and should _n_o_t end with a slash (/) character.  (For
        !           167:                  installation into the system's root directory, set DDEESSTTDDIIRR to
1.59      apb       168:                  an empty string, not to ``/'').  The directory must reside on
                    169:                  a file system which supports long file names and hard links.
1.1       tv        170:
1.100   ! wiz       171:                  _D_e_f_a_u_l_t: Empty string if UUSSEETTOOOOLLSS is ``yes''; unset
        !           172:                  otherwise.
1.1       tv        173:
1.100   ! wiz       174:                  _N_o_t_e: bbuuiilldd..sshh will provide a default of _d_e_s_t_d_i_r_.MMAACCHHIINNEE (in
        !           175:                  the top-level ..OOBBJJDDIIRR) unless run in `expert' mode.
1.30      lukem     176:
1.100   ! wiz       177:      MMAAKKEECCOONNFF    The name of the make(1) configuration file.  _O_n_l_y _s_e_t_t_a_b_l_e _i_n
        !           178:                  _t_h_e _p_r_o_c_e_s_s _e_n_v_i_r_o_n_m_e_n_t_.
1.1       tv        179:
1.100   ! wiz       180:                  _D_e_f_a_u_l_t: ``/etc/mk.conf''
1.1       tv        181:
1.100   ! wiz       182:      MMAAKKEEVVEERRBBOOSSEE
1.45      lukem     183:                  Level of verbosity of status messages.  Supported values:
                    184:
1.80      apb       185:                  0    No descriptive messages or commands executed by make(1)
                    186:                       are shown.
1.45      lukem     187:
1.80      apb       188:                  1    Brief messages are shown describing what is being done,
1.100   ! wiz       189:                       but the actual commands executed by make(1) are not
        !           190:                       displayed.
1.80      apb       191:
                    192:                  2    Descriptive messages are shown as above (prefixed with a
                    193:                       `#'), and ordinary commands performed by make(1) are
                    194:                       displayed.
                    195:
                    196:                  3    In addition to the above, all commands performed by
                    197:                       make(1) are displayed, even if they would ordinarily
                    198:                       have been hidden through use of the ``@'' prefix in the
                    199:                       relevant makefile.
1.45      lukem     200:
1.80      apb       201:                  4    In addition to the above, commands executed by make(1)
1.100   ! wiz       202:                       are traced through use of the sh(1) ``--xx'' flag.
1.45      lukem     203:
1.100   ! wiz       204:                  _D_e_f_a_u_l_t: 2
1.45      lukem     205:
1.100   ! wiz       206:      MMKKCCAATTPPAAGGEESS  Can be set to ``yes'' or ``no''.  Indicates whether
        !           207:                  preformatted plaintext manual pages will be created during a
        !           208:                  build.
1.1       tv        209:
1.100   ! wiz       210:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        211:
1.100   ! wiz       212:      MMKKCCRRYYPPTTOO    Can be set to ``yes'' or ``no''.  Indicates whether
        !           213:                  cryptographic code will be included in a build; provided for
        !           214:                  the benefit of countries that do not allow strong
        !           215:                  cryptography.  Will not affect use of the standard low-
        !           216:                  security password encryption system, crypt(3).
1.1       tv        217:
1.100   ! wiz       218:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        219:
1.100   ! wiz       220:      MMKKDDOOCC       Can be set to ``yes'' or ``no''.  Indicates whether system
        !           221:                  documentation destined for DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e_/_d_o_c will be
1.44      lukem     222:                  installed during a build.
1.1       tv        223:
1.100   ! wiz       224:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        225:
1.100   ! wiz       226:      MMKKHHTTMMLL      Can be set to ``yes'' or ``no''.  Indicates whether
        !           227:                  preformatted HTML manual pages will be built and installed
1.77      lukem     228:
1.100   ! wiz       229:                  _D_e_f_a_u_l_t: ``yes''
1.77      lukem     230:
1.100   ! wiz       231:      MMKKHHOOSSTTOOBBJJ   Can be set to ``yes'' or ``no''.  If set to ``yes'', then for
1.4       tv        232:                  programs intended to be run on the compile host, the name,
                    233:                  release, and architecture of the host operating system will
                    234:                  be suffixed to the name of the object directory created by
                    235:                  ``make obj''.  (This allows multiple host systems to compile
                    236:                  NetBSD for a single target.)  If set to ``no'', then programs
                    237:                  built to be run on the compile host will use the same object
                    238:                  directory names as programs built to be run on the target.
                    239:
1.100   ! wiz       240:                  _D_e_f_a_u_l_t: ``no''
1.4       tv        241:
1.100   ! wiz       242:      MMKKIINNFFOO      Can be set to ``yes'' or ``no''.  Indicates whether GNU Info
1.1       tv        243:                  files, used for the documentation for most of the compilation
                    244:                  tools, will be created and installed during a build.
                    245:
1.100   ! wiz       246:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        247:
1.100   ! wiz       248:      MMKKKKMMOODD      Can be set to ``yes'' or ``no''.  Indicates whether kernel
1.95      apb       249:                  modules are built and installed.
                    250:
1.100   ! wiz       251:                  _D_e_f_a_u_l_t: ``yes''
1.95      apb       252:
1.100   ! wiz       253:      MMKKLLIINNTT      Can be set to ``yes'' or ``no''.  Indicates whether lint(1)
1.1       tv        254:                  will be run against portions of the NetBSD source code during
                    255:                  the build, and whether lint libraries will be installed into
1.100   ! wiz       256:                  DDEESSTTDDIIRR_/_u_s_r_/_l_i_b_d_a_t_a_/_l_i_n_t.
1.1       tv        257:
1.100   ! wiz       258:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        259:
1.100   ! wiz       260:      MMKKMMAANN       Can be set to ``yes'' or ``no''.  Indicates whether manual
1.1       tv        261:                  pages will be installed during a build.
                    262:
1.100   ! wiz       263:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        264:
1.100   ! wiz       265:      MMKKNNLLSS       Can be set to ``yes'' or ``no''.  Indicates whether Native
1.44      lukem     266:                  Language System locale zone files will be compiled and
                    267:                  installed during a build.
1.1       tv        268:
1.100   ! wiz       269:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        270:
1.100   ! wiz       271:      MMKKOOBBJJ       Can be set to ``yes'' or ``no''.  Indicates whether object
1.1       tv        272:                  directories will be created when running ``make obj''.  If
                    273:                  set to ``no'', then all built files will be located inside
                    274:                  the regular source tree.
                    275:
1.100   ! wiz       276:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        277:
1.100   ! wiz       278:                  Note that setting MMKKOOBBJJ to ``no'' is not recommended and may
1.70      dholland  279:                  cause problems when updating the tree with cvs(1).
                    280:
1.100   ! wiz       281:      MMKKPPIICC       Can be set to ``yes'' or ``no''.  Indicates whether shared
1.1       tv        282:                  objects and libraries will be created and installed during a
                    283:                  build.  If set to ``no'', the entire built system will be
                    284:                  statically linked.
                    285:
1.100   ! wiz       286:                  _D_e_f_a_u_l_t: Platform dependent.  As of this writing, all
        !           287:                  platforms except sshh33 default to ``yes''.
1.1       tv        288:
1.100   ! wiz       289:      MMKKPPIICCIINNSSTTAALLLL
1.1       tv        290:                  Can be set to ``yes'' or ``no''.  Indicates whether the ar(1)
1.100   ! wiz       291:                  format libraries (lliibb**__ppiicc..aa), used to generate shared
1.44      lukem     292:                  libraries, are installed during a build.
1.1       tv        293:
1.100   ! wiz       294:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        295:
1.100   ! wiz       296:      MMKKPPRROOFFIILLEE   Can be set to ``yes'' or ``no''.  Indicates whether profiled
        !           297:                  libraries (lliibb**__pp..aa) will be built and installed during a
1.1       tv        298:                  build.
                    299:
1.100   ! wiz       300:                  _D_e_f_a_u_l_t: ``yes''; however, some platforms turn off MMKKPPRROOFFIILLEE
1.1       tv        301:                  by default at times due to toolchain problems with profiled
                    302:                  code.
                    303:
1.100   ! wiz       304:      MMKKRREEPPRROO     Can be set to ``yes'' or ``no''.  Create reproducable builds.
        !           305:                  This enables different switches to make two builds from the
        !           306:                  same source tree result in the same build results.
        !           307:
        !           308:                  _D_e_f_a_u_l_t: ``no''
        !           309:
        !           310:      MMKKSSHHAARREE     Can be set to ``yes'' or ``no''.  Indicates whether files
        !           311:                  destined to reside in DDEESSTTDDIIRR_/_u_s_r_/_s_h_a_r_e will be built and
1.44      lukem     312:                  installed during a build.  If set to ``no'', then all of
1.100   ! wiz       313:                  MMKKCCAATTPPAAGGEESS, MMKKDDOOCC, MMKKIINNFFOO, MMKKMMAANN, and MMKKNNLLSS will be set to
1.27      lukem     314:                  ``no'' unconditionally.
1.1       tv        315:
1.100   ! wiz       316:                  _D_e_f_a_u_l_t: ``yes''
1.1       tv        317:
1.100   ! wiz       318:      MMKKSSTTRRIIPPIIDDEENNTT
1.78      apb       319:                  Can be set to ``yes'' or ``no''.  Indicates whether program
                    320:                  binaries and shared libraries should be built to include RCS
                    321:                  IDs for use with ident(1).
                    322:
1.100   ! wiz       323:                  _D_e_f_a_u_l_t: ``no''
1.78      apb       324:
1.100   ! wiz       325:      MMKKUUNNPPRRIIVVEEDD  Can be set to ``yes'' or ``no''.  Indicates whether an
        !           326:                  unprivileged install will occur.  The user, group,
        !           327:                  permissions, and file flags, will not be set on the installed
1.52      jmc       328:                  items; instead the information will be appended to a file
1.100   ! wiz       329:                  called _M_E_T_A_L_O_G in DDEESSTTDDIIRR.  The contents of _M_E_T_A_L_O_G are used
1.52      jmc       330:                  during the generation of the distribution tar files to ensure
                    331:                  that the appropriate file ownership is stored.
1.38      lukem     332:
1.100   ! wiz       333:                  _D_e_f_a_u_l_t: ``no''
1.38      lukem     334:
1.100   ! wiz       335:      MMKKUUPPDDAATTEE    Can be set to ``yes'' or ``no''.  Indicates whether all
        !           336:                  install operations intended to write to DDEESSTTDDIIRR will compare
1.38      lukem     337:                  file timestamps before installing, and skip the install phase
1.44      lukem     338:                  if the destination files are up-to-date.  This also has
                    339:                  implications on full builds (see next subsection).
1.38      lukem     340:
1.100   ! wiz       341:                  _D_e_f_a_u_l_t: ``no''
1.38      lukem     342:
1.100   ! wiz       343:      MMKKXX1111       Can be set to ``yes'' or ``no''.  Indicates whether X11 is
        !           344:                  built from XX1111SSRRCCDDIIRR.
1.49      lukem     345:
1.100   ! wiz       346:                  _D_e_f_a_u_l_t: ``no''
1.49      lukem     347:
1.100   ! wiz       348:      TTOOOOLLDDIIRR     Directory to hold the host tools, once built.  If specified,
1.59      apb       349:                  must be an absolute path.  This directory should be unique to
1.100   ! wiz       350:                  a given host system and NetBSD source tree.  (However,
        !           351:                  multiple targets may share the same TTOOOOLLDDIIRR; the target-
        !           352:                  dependent files have unique names.)  If unset, a default
        !           353:                  based on the uname(1) information of the host platform will
        !           354:                  be created in the ..OOBBJJDDIIRR of _s_r_c.
1.1       tv        355:
1.100   ! wiz       356:                  _D_e_f_a_u_l_t: Unset.
1.1       tv        357:
1.100   ! wiz       358:      UUSSEETTOOOOLLSS    Indicates whether the tools specified by TTOOOOLLDDIIRR should be
1.1       tv        359:                  used as part of a build in progress.  Must be set to ``yes''
                    360:                  if cross-compiling.
                    361:
1.100   ! wiz       362:                  yyeess    Use the tools from TTOOOOLLDDIIRR.
1.1       tv        363:
1.100   ! wiz       364:                  nnoo     Do not use the tools from TTOOOOLLDDIIRR, but refuse to build
1.1       tv        365:                         native compilation tool components that are version-
                    366:                         specific for that tool.
                    367:
1.100   ! wiz       368:                  nneevveerr  Do not use the tools from TTOOOOLLDDIIRR, even when building
        !           369:                         native tool components.  This is similar to the
        !           370:                         traditional NetBSD build method, but does _n_o_t verify
        !           371:                         that the compilation tools in use are up-to-date
        !           372:                         enough in order to build the tree successfully.  This
        !           373:                         may cause build or runtime problems when building the
        !           374:                         whole NetBSD source tree.
1.1       tv        375:
1.100   ! wiz       376:                  _D_e_f_a_u_l_t: ``yes'', unless TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG is set to ``yes''.
1.71      dholland  377:
1.100   ! wiz       378:                  UUSSEETTOOOOLLSS is also set to ``no'' when using <bsd.*.mk> outside
1.71      dholland  379:                  the NetBSD source tree.
1.1       tv        380:
1.100   ! wiz       381:      XX1111SSRRCCDDIIRR   Directory containing the X11R6 source.  If specified, must be
1.59      apb       382:                  an absolute path.  The main X11R6 source is found in
1.100   ! wiz       383:                  XX1111SSRRCCDDIIRR_/_x_f_r_e_e_/_x_c.
1.49      lukem     384:
1.100   ! wiz       385:                  _D_e_f_a_u_l_t: NNEETTBBSSDDRRCCDDIIRR_/_._._/_x_s_r_c, if that exists; otherwise
        !           386:                  _/_u_s_r_/_x_s_r_c.
1.49      lukem     387:
1.100   ! wiz       388:      XX1111FFLLAAVVOOUURR  The style of X11 cross-built, set to either ``Xorg'' or
1.79      mrg       389:                  ``XFree86''.
                    390:
1.100   ! wiz       391:                  _D_e_f_a_u_l_t: ``Xorg'' on amd64, i386, macppc, shark and sparc64
1.81      mrg       392:                  platforms, ``XFree86'' on everything else.
1.79      mrg       393:
1.100   ! wiz       394:    ""mmaakkee"" vvaarriiaabblleess ffoorr ffuullll bbuuiillddss
1.7       lukem     395:      These variables only affect the top level ``Makefile'' and do not affect
                    396:      manually building subtrees of the NetBSD source code.
1.1       tv        397:
1.100   ! wiz       398:      IINNSSTTAALLLLWWOORRLLDDDDIIRR  Location for the ``make installworld'' target to install
1.59      apb       399:                       to.  If specified, must be an absolute path.
1.1       tv        400:
1.100   ! wiz       401:                       _D_e_f_a_u_l_t: ``/''
1.1       tv        402:
1.100   ! wiz       403:      MMKKOOBBJJDDIIRRSS        Can be set to ``yes'' or ``no''.  Indicates whether
1.44      lukem     404:                       object directories will be created automatically (via a
1.20      lukem     405:                       ``make obj'' pass) at the start of a build.
1.1       tv        406:
1.100   ! wiz       407:                       _D_e_f_a_u_l_t: ``no''
1.1       tv        408:
1.100   ! wiz       409:                       If using bbuuiilldd..sshh, the default is ``yes''.  This may be
        !           410:                       set back to ``no'' by giving bbuuiilldd..sshh the --oo option.
1.70      dholland  411:
1.100   ! wiz       412:      MMKKUUPPDDAATTEE         Can be set to ``yes'' or ``no''.  If set, then in
        !           413:                       addition to the effects described for MMKKUUPPDDAATTEE==yyeess
        !           414:                       above, this implies the effects of NNOOCCLLEEAANNDDIIRR (i.e.,
        !           415:                       ``make cleandir'' is avoided).
1.38      lukem     416:
1.100   ! wiz       417:                       _D_e_f_a_u_l_t: ``no''
1.38      lukem     418:
1.100   ! wiz       419:                       If using bbuuiilldd..sshh, this may be set by giving the --uu
1.70      dholland  420:                       option.
                    421:
1.100   ! wiz       422:      NNBBUUIILLDDJJOOBBSS       Now obsolete.  Use the make(1) option --jj, instead.  See
1.70      dholland  423:                       below.
1.1       tv        424:
1.100   ! wiz       425:                       _D_e_f_a_u_l_t: Unset.
1.1       tv        426:
1.100   ! wiz       427:      NNOOCCLLEEAANNDDIIRR       If set, avoids the ``make cleandir'' phase of a full
1.20      lukem     428:                       build.  This has the effect of allowing only changed
                    429:                       files in a source tree to be recompiled.  This can speed
                    430:                       up builds when updating only a few files in the tree.
1.1       tv        431:
1.100   ! wiz       432:                       _D_e_f_a_u_l_t: Unset.
1.1       tv        433:
1.100   ! wiz       434:                       See also MMKKUUPPDDAATTEE.
1.70      dholland  435:
1.100   ! wiz       436:      NNOODDIISSTTRRIIBBDDIIRRSS    If set, avoids the ``make distrib-dirs'' phase of a full
        !           437:                       build.  This skips running mtree(8) on DDEESSTTDDIIRR, useful
1.20      lukem     438:                       on systems where building as an unprivileged user, or
                    439:                       where it is known that the system-wide mtree files have
                    440:                       not changed.
1.1       tv        441:
1.100   ! wiz       442:                       _D_e_f_a_u_l_t: Unset.
1.1       tv        443:
1.100   ! wiz       444:      NNOOIINNCCLLUUDDEESS       If set, avoids the ``make includes'' phase of a full
1.20      lukem     445:                       build.  This has the effect of preventing make(1) from
1.44      lukem     446:                       thinking that some programs are out-of-date simply
                    447:                       because the system include files have changed.  However,
1.20      lukem     448:                       this option should not be used when updating the entire
                    449:                       NetBSD source tree arbitrarily; it is suggested to use
1.100   ! wiz       450:                       MMKKUUPPDDAATTEE==yyeess instead in that case.
1.1       tv        451:
1.100   ! wiz       452:                       _D_e_f_a_u_l_t: Unset.
1.1       tv        453:
1.100   ! wiz       454:      RREELLEEAASSEEDDIIRR       If set, specifies the directory to which a release(7)
1.20      lukem     455:                       layout will be written at the end of a ``make release''.
1.59      apb       456:                       If specified, must be an absolute path.
1.20      lukem     457:
1.100   ! wiz       458:                       _D_e_f_a_u_l_t: Unset.
1.20      lukem     459:
1.100   ! wiz       460:                       _N_o_t_e: bbuuiilldd..sshh will provide a default of _r_e_l_e_a_s_e_d_i_r (in
        !           461:                       the top-level ..OOBBJJDDIIRR) unless run in `expert' mode.
1.30      lukem     462:
1.100   ! wiz       463: BBUUIILLDDIINNGG
        !           464:    ""mmaakkee"" ccoommmmaanndd lliinnee ooppttiioonnss
1.52      jmc       465:      This is not a summary of all the options available to make(1); only the
                    466:      options used most frequently with NetBSD builds are listed here.
1.1       tv        467:
1.100   ! wiz       468:      --jj _n_j_o_b    Run up to _n_j_o_b make(1) subjobs in parallel.  Makefiles should
1.52      jmc       469:                 use .WAIT or have explicit dependencies as necessary to
1.74      apb       470:                 enforce build ordering.
1.10      sommerfe  471:
1.100   ! wiz       472:      --mm _d_i_r     Specify the default directory for searching for system
        !           473:                 Makefile segments, mainly the <bsd.*.mk> files.  When building
        !           474:                 any full NetBSD source tree, this should be set to the
        !           475:                 ``share/mk'' directory in the source tree.  This is set
        !           476:                 automatically when building from the top level, or when using
        !           477:                 bbuuiilldd..sshh.
1.1       tv        478:
1.100   ! wiz       479:      --nn         Display the commands that would have been executed, but do not
1.1       tv        480:                 actually execute them.  This will still cause recursion to
                    481:                 take place.
                    482:
1.100   ! wiz       483:      --VV _v_a_r     Print make(1)'s idea of the value of _v_a_r.  Does not build any
1.1       tv        484:                 targets.
                    485:
1.100   ! wiz       486:      _v_a_r_=_v_a_l_u_e  Set the variable _v_a_r to _v_a_l_u_e, overriding any setting
        !           487:                 specified by the process environment, the MMAAKKEECCOONNFF
        !           488:                 configuration file, or the system Makefile segments.
1.1       tv        489:
1.100   ! wiz       490:    ""mmaakkee"" ttaarrggeettss
1.1       tv        491:      These default targets may be built by running make(1) in any subtree of
                    492:      the NetBSD source code.  It is recommended that none of these be used
                    493:      from the top level Makefile; as a specific exception, ``make obj'' and
                    494:      ``make cleandir'' are useful in that context.
                    495:
1.100   ! wiz       496:      aallll        Build programs, libraries, and preformatted documentation.
1.1       tv        497:
1.100   ! wiz       498:      cclleeaann      Remove program and library object code files.
1.1       tv        499:
1.100   ! wiz       500:      cclleeaannddiirr   Same as cclleeaann, but also remove preformatted documentation,
1.44      lukem     501:                 dependency files generated by ``make depend'', and any other
1.49      lukem     502:                 files known to be created at build time.
1.1       tv        503:
1.100   ! wiz       504:      ddeeppeenndd     Create dependency files (..ddeeppeenndd) containing more detailed
1.44      lukem     505:                 information about the dependencies of source code on header
1.1       tv        506:                 files.  Allows programs to be recompiled automatically when a
                    507:                 dependency changes.
                    508:
1.100   ! wiz       509:      ddeeppeennddaallll  Does a ``make depend'' immediately followed by a ``make all''.
1.10      sommerfe  510:                 This improves cache locality of the build since both passes
                    511:                 read the source files in their entirety.
1.1       tv        512:
1.100   ! wiz       513:      ddiissttcclleeaann  Synonym for cclleeaannddiirr.
1.49      lukem     514:
1.100   ! wiz       515:      iinncclluuddeess   Build and install system header files.  Typically needed
1.44      lukem     516:                 before any system libraries or programs can be built.
1.1       tv        517:
1.100   ! wiz       518:      iinnssttaallll    Install programs, libraries, and documentation into DDEESSTTDDIIRR.
        !           519:                 Few files will be installed to DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c,
        !           520:                 DDEESSTTDDIIRR_/_r_o_o_t or DDEESSTTDDIIRR_/_v_a_r in order to prevent user supplied
1.27      lukem     521:                 configuration data from being overwritten.
1.1       tv        522:
1.100   ! wiz       523:      lliinntt       Run lint(1) against the C source code, where appropriate, and
1.1       tv        524:                 generate system-installed lint libraries.
                    525:
1.100   ! wiz       526:      oobbjj        Create object directories to be used for built files, instead
1.1       tv        527:                 of building directly in the source tree.
                    528:
1.100   ! wiz       529:      ttaaggss       Create ctags(1) searchable function lists usable by the ex(1)
1.1       tv        530:                 and vi(1) text editors.
                    531:
1.100   ! wiz       532:    ""mmaakkee"" ttaarrggeettss ffoorr tthhee ttoopp lleevveell
1.1       tv        533:      Additional make(1) targets are usable specifically from the top source
                    534:      level to facilitate building the entire NetBSD source tree.
                    535:
1.100   ! wiz       536:      bbuuiilldd         Build the entire NetBSD system (except the kernel).  This
1.68      reed      537:                    orders portions of the source tree such that prerequisites
                    538:                    will be built in the proper order.
1.20      lukem     539:
1.100   ! wiz       540:      ddiissttrriibbuuttiioonn  Do a ``make build'', and then install a full distribution
        !           541:                    (which does not include a kernel) into DDEESSTTDDIIRR, including
        !           542:                    files in DDEESSTTDDIIRR_/_d_e_v, DDEESSTTDDIIRR_/_e_t_c, DDEESSTTDDIIRR_/_r_o_o_t and
        !           543:                    DDEESSTTDDIIRR_/_v_a_r.
1.20      lukem     544:
1.100   ! wiz       545:      bbuuiillddwwoorrlldd    As per ``make distribution'', except that it ensures that
        !           546:                    DDEESSTTDDIIRR is not the root directory.
1.20      lukem     547:
1.100   ! wiz       548:      iinnssttaallllwwoorrlldd  Install the distribution from DDEESSTTDDIIRR to IINNSSTTAALLLLWWOORRLLDDDDIIRR,
1.70      dholland  549:                    which defaults to the root directory.  Ensures that
1.100   ! wiz       550:                    IINNSSTTAALLLLWWOORRLLDDDDIIRR is not the root directory if cross
        !           551:                    compiling.
1.20      lukem     552:
1.100   ! wiz       553:                    The IINNSSTTAALLLLSSEETTSS environment variable may be set to a space-
1.95      apb       554:                    separated list of distribution sets to be installed.  By
                    555:                    default, all sets except ``etc'' and ``xetc'' are
1.100   ! wiz       556:                    installed, so most files in IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c will not be
1.95      apb       557:                    installed or modified.
1.61      apb       558:
1.100   ! wiz       559:                    _N_o_t_e: Before performing this operation with
        !           560:                    IINNSSTTAALLLLWWOORRLLDDDDIIRR=_/, it is highly recommended that you
1.61      apb       561:                    upgrade your kernel and reboot.  After performing this
                    562:                    operation, it is recommended that you use etcupdate(8) to
1.100   ! wiz       563:                    update files in IINNSSTTAALLLLWWOORRLLDDDDIIRR_/_e_t_c and that you use
1.61      apb       564:                    postinstall(8) to check for inconsistencies (and possibly
                    565:                    to fix them).
1.20      lukem     566:
1.100   ! wiz       567:      sseettss          Create distribution sets from DDEESSTTDDIIRR into
        !           568:                    RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_e_t_s.  Should be run
1.70      dholland  569:                    after ``make distribution'', as ``make build'' alone does
                    570:                    not install all of the required files.
1.25      lukem     571:
1.100   ! wiz       572:      ssoouurrcceesseettss    Create source sets of the source tree into
        !           573:                    RREELLEEAASSEEDDIIRR_/_s_o_u_r_c_e_/_s_e_t_s.
1.31      lukem     574:
1.100   ! wiz       575:      ssyyssppkkggss       Create syspkgs from DDEESSTTDDIIRR into
        !           576:                    RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_s_y_s_p_k_g_s.  Should be run
1.70      dholland  577:                    after ``make distribution'', as ``make build'' alone does
                    578:                    not install all of the required files.
1.54      apb       579:
1.100   ! wiz       580:      rreelleeaassee       Do a ``make distribution'', build kernels, distribution
1.44      lukem     581:                    media, and install sets (this as per ``make sets''), and
                    582:                    then package the system into a standard release layout as
1.100   ! wiz       583:                    described by release(7).  This requires that RREELLEEAASSEEDDIIRR be
1.25      lukem     584:                    set (see above).
1.1       tv        585:
1.100   ! wiz       586:      iissoo--iimmaaggee     Create a NetBSD installation CD-ROM image in the
        !           587:                    RREELLEEAASSEEDDIIRR_/_i_s_o directory.  The CD-ROM file system will have
1.62      apb       588:                    a layout as described in release(7).
                    589:
                    590:                    For most machine types, the CD-ROM will be bootable, and
1.100   ! wiz       591:                    will automatically run the sysinst(8) menu-based
        !           592:                    installation program, which can be used to install or
        !           593:                    upgrade a NetBSD system.  Bootable CD-ROMs also contain
        !           594:                    tools that may be useful in repairing a damaged NetBSD
        !           595:                    installation.
1.62      apb       596:
                    597:                    Before ``make iso-image'' is attempted, RELEASEDIR must be
                    598:                    populated by ``make release'' or equivalent.
                    599:
                    600:                    Note that other, smaller, CD-ROM images may be created in
1.100   ! wiz       601:                    the RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m
        !           602:                    directory by ``make release''.  These smaller images
        !           603:                    usually contain the same tools as the larger images in
        !           604:                    RREELLEEAASSEEDDIIRR_/_i_s_o, but do not contain additional content such
1.69      lukem     605:                    as the distribution sets.
1.62      apb       606:
                    607:                    Note that the mac68k port still uses an older method of
1.100   ! wiz       608:                    creating CD-ROM images.  This requires the mkisofs(1)
        !           609:                    utility, which is not part of NetBSD, but which can be
        !           610:                    installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s.
1.56      apb       611:
1.100   ! wiz       612:      iissoo--iimmaaggee--ssoouurrccee
1.64      jnemeth   613:                    Create a NetBSD installation CD-ROM image in the
1.100   ! wiz       614:                    RREELLEEAASSEEDDIIRR_/_i_s_o directory.  The CD-ROM file system will have
1.64      jnemeth   615:                    a layout as described in release(7).  It will have top
                    616:                    level directories for the machine type and source.
                    617:
                    618:                    For most machine types, the CD-ROM will be bootable, and
1.100   ! wiz       619:                    will automatically run the sysinst(8) menu-based
        !           620:                    installation program, which can be used to install or
        !           621:                    upgrade a NetBSD system.  Bootable CD-ROMs also contain
        !           622:                    tools that may be useful in repairing a damaged NetBSD
        !           623:                    installation.
1.64      jnemeth   624:
                    625:                    Before ``make iso-image-source'' is attempted, RELEASEDIR
1.100   ! wiz       626:                    must be populated by ``make sourcesets release'' or
        !           627:                    equivalent.
1.64      jnemeth   628:
                    629:                    Note that other, smaller, CD-ROM images may be created in
1.100   ! wiz       630:                    the RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_c_d_r_o_m
        !           631:                    directory by ``make release''.  These smaller images
        !           632:                    usually contain the same tools as the larger images in
        !           633:                    RREELLEEAASSEEDDIIRR_/_i_s_o, but do not contain additional content such
1.69      lukem     634:                    as the distribution sets.
1.64      jnemeth   635:
                    636:                    Note that the mac68k port still uses an older method of
1.100   ! wiz       637:                    creating CD-ROM images.  This requires the mkisofs(1)
        !           638:                    utility, which is not part of NetBSD, but which can be
        !           639:                    installed from _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s.
1.64      jnemeth   640:
1.100   ! wiz       641:      iinnssttaallll--iimmaaggee
1.98      apb       642:                    Create a bootable NetBSD installation disk image in the
1.100   ! wiz       643:                    RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_i_n_s_t_a_l_l_i_m_a_g_e
1.98      apb       644:                    directory.  The installation disk image is suitable for
                    645:                    copying to bootable USB flash memory sticks, etc., for
                    646:                    machines which are able to boot from such devices.  The
                    647:                    file system in the bootable disk image will have a layout
                    648:                    as described in release(7).
1.97      tsutsui   649:
                    650:                    The installation image is bootable, and will automatically
                    651:                    run the sysinst(8) menu-based installation program, which
1.98      apb       652:                    can be used to install or upgrade a NetBSD system.  The
                    653:                    image also contains tools that may be useful in repairing a
                    654:                    damaged NetBSD installation.
1.97      tsutsui   655:
1.100   ! wiz       656:                    Before ``make install-image'' is attempted, RREELLEEAASSEEDDIIRR must
1.98      apb       657:                    be populated by ``make release'' or equivalent.  The build
1.100   ! wiz       658:                    must have been performed with MMKKUUNNPPRRIIVVEEDD==yyeess because ``make
        !           659:                    install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G.
1.97      tsutsui   660:
                    661:      live-image    Create NetBSD live images in the
1.100   ! wiz       662:                    RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_i_n_s_t_a_l_l_a_t_i_o_n_/_l_i_v_e_i_m_a_g_e
        !           663:                    directory.  The live image contains all necessary files to
        !           664:                    boot NetBSD up to multi-user mode, including all files
        !           665:                    which should be extracted during installation, NetBSD
        !           666:                    disklabel, bootloaders, etc.
        !           667:
        !           668:                    The live image is suitable for use as a disk image in
        !           669:                    virtual machine environments such as QEMU, and also useful
        !           670:                    to boot NetBSD from a USB flash memory stick on a real
1.98      apb       671:                    machine, without the need for installation.
1.97      tsutsui   672:
                    673:                    Before ``make live-image'' is attempted, RELEASEDIR must be
1.99      tsutsui   674:                    populated by ``make release'' or equivalent.  The build
1.100   ! wiz       675:                    must have been performed with MMKKUUNNPPRRIIVVEEDD==yyeess because ``make
        !           676:                    install-image'' relies on information in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G.
1.97      tsutsui   677:
1.100   ! wiz       678:      rreeggrreessssiioonn--tteessttss
1.20      lukem     679:                    Can only be run after building the regression tests in the
1.70      dholland  680:                    directory ``regress''.  Runs those compiled regression
1.100   ! wiz       681:                    tests on the local host.  Note that most tests are now
        !           682:                    managed instead using atf(7); this target should probably
        !           683:                    run those as well but currently does not.
1.1       tv        684:
1.100   ! wiz       685:    TThhee ""bbuuiilldd..sshh"" ssccrriipptt
1.96      apb       686:      This script file is a shell script designed to build the entire NetBSD
1.100   ! wiz       687:      system on any host with a suitable modern shell and some common
        !           688:      utilities.  The required shell features are described under the HHOOSSTT__SSHH
        !           689:      variable.
1.96      apb       690:
                    691:      If a host system's default shell does support the required features, then
                    692:      we suggest that you explicitly specify a suitable shell using a command
                    693:      like
                    694:
1.100   ! wiz       695:            /path/to/suitable/shell build.sh [_o_p_t_i_o_n_s]
1.96      apb       696:
1.100   ! wiz       697:      The above command will usually enable bbuuiilldd..sshh to automatically set
        !           698:      HHOOSSTT__SSHH==_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l, but if that fails, then the following
1.96      apb       699:      set of commands may be used instead:
                    700:
1.100   ! wiz       701:            HOST_SH=_/_p_a_t_h_/_t_o_/_s_u_i_t_a_b_l_e_/_s_h_e_l_l
1.96      apb       702:            export HOST_SH
1.100   ! wiz       703:            ${HOST_SH} build.sh [_o_p_t_i_o_n_s]
1.96      apb       704:
1.100   ! wiz       705:      If bbuuiilldd..sshh detects that it is being executed under an unsuitable shell,
1.96      apb       706:      it attempts to exec a suitable shell instead, or prints an error message.
1.100   ! wiz       707:      If HHOOSSTT__SSHH is not set explicitly, then bbuuiilldd..sshh sets a default using
1.96      apb       708:      heuristics dependent on the host platform, or from the shell under which
1.100   ! wiz       709:      bbuuiilldd..sshh is executed (if that can be determined), or using the first copy
        !           710:      of _s_h found in PPAATTHH.
1.1       tv        711:
                    712:      All cross-compile builds, and most native builds, of the entire system
1.100   ! wiz       713:      should make use of bbuuiilldd..sshh rather than just running ``make''.  This way,
        !           714:      the make(1) program will be bootstrapped properly, in case the host
        !           715:      system has an older or incompatible ``make'' program.
1.1       tv        716:
1.100   ! wiz       717:      When compiling the entire system via bbuuiilldd..sshh, many make(1) variables are
1.1       tv        718:      set for you in order to help encapsulate the build process.  In the list
1.100   ! wiz       719:      of options below, variables that are automatically set by bbuuiilldd..sshh are
1.1       tv        720:      noted where applicable.
                    721:
1.100   ! wiz       722:      The following operations are supported by bbuuiilldd..sshh:
1.22      lukem     723:
1.100   ! wiz       724:      bbuuiilldd         Build the system as per ``make build''.  Before the main
        !           725:                    part of the build commences, this command runs the oobbjj
        !           726:                    operation (unless the --oo option is given), ``make
        !           727:                    cleandir'' (unless the --uu option is given), and the ttoooollss
1.70      dholland  728:                    operation.
1.22      lukem     729:
1.100   ! wiz       730:      ddiissttrriibbuuttiioonn  Build a full distribution as per ``make distribution''.
        !           731:                    This command first runs the bbuuiilldd operation.
1.22      lukem     732:
1.100   ! wiz       733:      rreelleeaassee       Build a full release as per ``make release''.  This command
        !           734:                    first runs the ddiissttrriibbuuttiioonn operation.
1.22      lukem     735:
1.100   ! wiz       736:      mmaakkeewwrraappppeerr   Create the nnbbmmaakkee--MMAACCHHIINNEE wrapper.  This operation is
        !           737:                    automatically performed for any of the other operations.
1.23      lukem     738:
1.100   ! wiz       739:      cclleeaannddiirr      Perform ``make cleandir''.
1.75      lukem     740:
1.100   ! wiz       741:      oobbjj           Perform ``make obj''.
1.22      lukem     742:
1.100   ! wiz       743:      ttoooollss         Build and install the host tools from _s_r_c_/_t_o_o_l_s.  This
        !           744:                    command will first run ``make obj'' and ``make cleandir''
        !           745:                    in the _t_o_o_l_s subdirectory unless the --oo or --uu options
        !           746:                    (respectively) are given.
1.22      lukem     747:
1.100   ! wiz       748:      iinnssttaallll=_i_d_i_r  Install the contents of DDEESSTTDDIIRR to _i_d_i_r, using ``make
1.61      apb       749:                    installworld''.  Note that files that are part of the
1.95      apb       750:                    ``etc'' or ``xetc'' sets will not be installed, unless
                    751:                    overridden by the INSTALLSETS environment variable.
1.35      lukem     752:
1.100   ! wiz       753:      kkeerrnneell=_k_c_o_n_f  Build a new kernel.  The _k_c_o_n_f argument is the name of a
        !           754:                    configuration file suitable for use by config(1).  If _k_c_o_n_f
1.22      lukem     755:                    does not contain any `/' characters, the configuration file
1.100   ! wiz       756:                    is expected to be found in the KKEERRNNCCOONNFFDDIIRR directory, which
        !           757:                    is typically ssyyss//aarrcchh//MMAACCHHIINNEE//ccoonnff.  The new kernel will be
        !           758:                    built in a subdirectory of KKEERRNNOOBBJJDDIIRR, which is typically
        !           759:                    ssyyss//aarrcchh//MMAACCHHIINNEE//ccoommppiillee or an associated object directory.
1.70      dholland  760:
1.100   ! wiz       761:                    This command does _n_o_t imply the ttoooollss command; run the
        !           762:                    ttoooollss command first unless it is _c_e_r_t_a_i_n that the tools
1.70      dholland  763:                    already exist and are up to date.
                    764:
                    765:                    This command will run ``make cleandir'' on the kernel in
1.100   ! wiz       766:                    question first unless the --uu option is given.
1.22      lukem     767:
1.100   ! wiz       768:      mmoodduulleess       This command will build kernel modules and install them
        !           769:                    into DDEESSTTDDIIRR.
1.86      jnemeth   770:
1.100   ! wiz       771:      rreelleeaasseekkeerrnneell=_k_c_o_n_f
1.70      dholland  772:                    Install a gzip(1)ed copy of the kernel previously built by
1.100   ! wiz       773:                    kkeerrnneell=_k_c_o_n_f into
        !           774:                    RREELLEEAASSEEDDIIRR//RREELLEEAASSEEMMAACCHHIINNEEDDIIRR_/_b_i_n_a_r_y_/_k_e_r_n_e_l, usually as
        !           775:                    _n_e_t_b_s_d_-_k_c_o_n_f_._g_z, although the ``_n_e_t_b_s_d'' prefix is
        !           776:                    determined from the ``ccoonnffiigg'' directives in _k_c_o_n_f.
1.24      lukem     777:
1.100   ! wiz       778:      sseettss          Perform ``make sets''.
1.31      lukem     779:
1.100   ! wiz       780:      ssoouurrcceesseettss    Perform ``make sourcesets''.
1.22      lukem     781:
1.100   ! wiz       782:      ssyyssppkkggss       Perform ``make syspkgs''.
1.54      apb       783:
1.100   ! wiz       784:      iissoo--iimmaaggee     Perform ``make iso-image''.
1.56      apb       785:
1.100   ! wiz       786:      iissoo--iimmaaggee--ssoouurrccee
1.65      jnemeth   787:                    Perform ``make iso-image-source''.
                    788:
1.100   ! wiz       789:      iinnssttaallll--iimmaaggee
1.98      apb       790:                    Perform ``make install-image''.
1.97      tsutsui   791:
1.100   ! wiz       792:      lliivvee--iimmaaggee    Perform ``make live-image''.
1.97      tsutsui   793:
1.100   ! wiz       794:      The following command line options alter the behaviour of the bbuuiilldd..sshh
1.51      wiz       795:      operations described above:
1.1       tv        796:
1.100   ! wiz       797:      --aa _a_r_c_h   Set the value of MMAACCHHIINNEE__AARRCCHH to _a_r_c_h.
1.9       thorpej   798:
1.100   ! wiz       799:      --BB _b_u_i_l_d_i_d
        !           800:                Set the value of BBUUIILLDDIIDD to _b_u_i_l_d_i_d.  This will also append the
1.67      sborrill  801:                build identifier to the name of the ``make'' wrapper script so
1.37      lukem     802:                that the resulting name is of the form
1.100   ! wiz       803:                ``nnbbmmaakkee--MMAACCHHIINNEE--BBUUIILLDDIIDD''.
1.1       tv        804:
1.100   ! wiz       805:      --CC _c_d_e_x_t_r_a_s
        !           806:                Append _c_d_e_x_t_r_a_s to the CCDDEEXXTTRRAA variable, which is a space-
        !           807:                separated list of files or directories that will be added to
        !           808:                the CD-ROM image that may be create by the ``iso-image'' or
1.87      apb       809:                ``iso-image-source'' operations.  Files will be added to the
                    810:                root of the CD-ROM image, whereas directories will be copied
                    811:                recursively.  If relative paths are specified, they will be
                    812:                converted to absolute paths before being used.  Multiple paths
1.100   ! wiz       813:                may be specified via multiple --CC options, or via a single
1.87      apb       814:                option whose argument contains multiple space-separated paths.
1.66      jnemeth   815:
1.100   ! wiz       816:      --DD _d_e_s_t   Set the value of DDEESSTTDDIIRR to _d_e_s_t.  If a relative path is
        !           817:                specified, it will be converted to an absolute path before
        !           818:                being used.
        !           819:
        !           820:      --EE        Set `expert' mode.  This overrides various sanity checks, and
        !           821:                allows: DDEESSTTDDIIRR does not have to be set to a non-root path for
        !           822:                builds, and MMKKUUNNPPRRIIVVEEDD==yyeess does not have to be set when
        !           823:                building as a non-root user.
1.23      lukem     824:
1.100   ! wiz       825:                _N_o_t_e: It is highly recommended that you know what you are doing
1.23      lukem     826:                when you use this option.
1.19      lukem     827:
1.100   ! wiz       828:      --hh        Print a help message.
1.51      wiz       829:
1.100   ! wiz       830:      --jj _n_j_o_b   Run up to _n_j_o_b make(1) subjobs in parallel; passed through to
1.74      apb       831:                make(1).  If you see failures for reasons other than running
1.100   ! wiz       832:                out of memory while using bbuuiilldd..sshh with --jj, please save
        !           833:                complete build logs so the failures can be analyzed.
1.74      apb       834:
1.100   ! wiz       835:                To achieve the fastest builds, --jj values between (1 + the
        !           836:                number of CPUs) and (2 * the number of CPUs) are recommended.
        !           837:                Use lower values on machines with limited memory or I/O
        !           838:                bandwidth.
        !           839:
        !           840:      --MM _o_b_j    Set MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX to _o_b_j.  Unsets MMAAKKEEOOBBJJDDIIRR.  See ``--OO
        !           841:                --oobbjj'' for more information.
        !           842:
        !           843:                For instance, if the source directory is _/_u_s_r_/_s_r_c, a setting of
        !           844:                ``--MM _/_u_s_r_/_o_b_j'' will place build-time files under
        !           845:                _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_b_i_n, _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_l_i_b,
        !           846:                _/_u_s_r_/_o_b_j_/_u_s_r_/_s_r_c_/_u_s_r_._b_i_n, and so forth.
1.88      apb       847:
1.73      apb       848:                If a relative path is specified, it will be converted to an
1.100   ! wiz       849:                absolute path before being used.  bbuuiilldd..sshh imposes the
        !           850:                restriction that the argument to the --MM option must not begin
        !           851:                with a ``$'' (dollar sign) character; otherwise it would be too
        !           852:                difficult to determine whether the value is an absolute or a
        !           853:                relative path.  If the directory does not already exist,
        !           854:                bbuuiilldd..sshh will create it.
1.18      lukem     855:
1.100   ! wiz       856:      --mm _m_a_c_h   Set the value of MMAACCHHIINNEE to _m_a_c_h, except in some special cases
1.60      apb       857:                listed below.  This will also override any value of
1.100   ! wiz       858:                MMAACCHHIINNEE__AARRCCHH in the process environment with a value deduced
        !           859:                from _m_a_c_h, unless --aa is specified.  All cross builds require
        !           860:                --mm, but if unset on a NetBSD host, the host's value of MACHINE
1.60      apb       861:                will be detected and used automatically.
                    862:
1.100   ! wiz       863:                Some machines support multiple values for MMAACCHHIINNEE__AARRCCHH.  The
        !           864:                following special cases for the _m_a_c_h argument are defined to
        !           865:                set the listed values of MMAACCHHIINNEE and MMAACCHHIINNEE__AARRCCHH:
1.33      lukem     866:
1.100   ! wiz       867:                      mmaacchh          MMAACCHHIINNEE    MMAACCHHIINNEE__AARRCCHH
1.60      apb       868:                      evbarm        evbarm     (not set)
                    869:                      evbarm-eb     evbarm     armeb
                    870:                      evbarm-el     evbarm     arm
1.33      lukem     871:                      evbmips       evbmips    (not set)
                    872:                      evbmips-eb    evbmips    mipseb
                    873:                      evbmips-el    evbmips    mipsel
                    874:                      evbsh3        evbsh3     (not set)
                    875:                      evbsh3-eb     evbsh3     sh3eb
                    876:                      evbsh3-el     evbsh3     sh3el
                    877:                      sbmips        sbmips     (not set)
                    878:                      sbmips-eb     sbmips     mipseb
                    879:                      sbmips-el     sbmips     mipsel
1.1       tv        880:
1.100   ! wiz       881:      --NN _n_o_i_s_e_l_e_v_e_l
1.46      lukem     882:                Set the ``noisyness'' level of the build, by setting
1.100   ! wiz       883:                MMAAKKEEVVEERRBBOOSSEE to _n_o_i_s_e_l_e_v_e_l.
1.45      lukem     884:
1.100   ! wiz       885:      --nn        Show the commands that would be executed by bbuuiilldd..sshh, but do
1.1       tv        886:                not make any changes.  This is similar in concept to ``make
                    887:                -n''.
                    888:
1.100   ! wiz       889:      --OO _o_b_j    Create an appropriate transform macro for MMAAKKEEOOBBJJDDIIRR that will
        !           890:                place the built object files under _o_b_j.  Unsets
        !           891:                MMAAKKEEOOBBJJDDIIRRPPRREEFFIIXX.
1.88      apb       892:
1.100   ! wiz       893:                For instance, a setting of ``--OO _/_u_s_r_/_o_b_j'' will place build-
        !           894:                time files under _/_u_s_r_/_o_b_j_/_b_i_n, _/_u_s_r_/_o_b_j_/_l_i_b, _/_u_s_r_/_o_b_j_/_u_s_r_._b_i_n,
1.88      apb       895:                and so forth.
                    896:
                    897:                If a relative path is specified, it will be converted to an
1.100   ! wiz       898:                absolute path before being used.  bbuuiilldd..sshh imposes the
        !           899:                restriction that the argument to the --OO option must not contain
        !           900:                a ``$'' (dollar sign) character.  If the directory does not
        !           901:                already exist, bbuuiilldd..sshh will create it.
1.73      apb       902:
1.100   ! wiz       903:                In normal use, exactly one of the --MM or --OO options should be
        !           904:                specified.  If neither --MM nor --OO is specified, then a default
1.78      apb       905:                object directory will be chosen according to rules in
                    906:                <bsd.obj.mk>.  Relying on this default is not recommended
                    907:                because it is determined by complex rules that are influenced
                    908:                by the values of several variables and by the location of the
                    909:                source directory.
1.18      lukem     910:
1.100   ! wiz       911:      --oo        Set the value of MMKKOOBBJJDDIIRRSS to ``no''.  Otherwise, it will be
1.70      dholland  912:                automatically set to ``yes''.  This default is opposite to the
1.100   ! wiz       913:                behaviour when not using bbuuiilldd..sshh.
1.1       tv        914:
1.100   ! wiz       915:      --RR _r_e_l    Set the value of RREELLEEAASSEEDDIIRR to _r_e_l.  If a relative path is
1.59      apb       916:                specified, it will be converted to an absolute path before
                    917:                being used.
1.18      lukem     918:
1.100   ! wiz       919:      --rr        Remove the contents of DDEESSTTDDIIRR and TTOOOOLLDDIIRR before building
1.1       tv        920:                (provides a clean starting point).  This will skip deleting
1.100   ! wiz       921:                DDEESSTTDDIIRR if building on a native system to the root directory.
1.1       tv        922:
1.100   ! wiz       923:      --SS _s_e_e_d   Change the value of BBUUIILLDDSSEEEEDD to _s_e_e_d.  This should rarely be
1.72      perry     924:                necessary.
                    925:
1.100   ! wiz       926:      --TT _t_o_o_l_s  Set the value of TTOOOOLLDDIIRR to _t_o_o_l_s.  If a relative path is
        !           927:                specified, it will be converted to an absolute path before
        !           928:                being used.  If set, the bootstrap ``make'' will only be
        !           929:                rebuilt if the source files for make(1) have changed.
        !           930:
        !           931:      --UU        Set MMKKUUNNPPRRIIVVEEDD==yyeess.
        !           932:
        !           933:      --uu        Set MMKKUUPPDDAATTEE==yyeess.
        !           934:
        !           935:      --VV _v_a_r=[_v_a_l_u_e]
        !           936:                Set the environment variable _v_a_r to an optional _v_a_l_u_e.  This is
        !           937:                propagated to the nnbbmmaakkee wrapper.
        !           938:
        !           939:      --ww _w_r_a_p_p_e_r
        !           940:                Create the nnbbmmaakkee wrapper script (see below) in a custom
        !           941:                location, specified by _w_r_a_p_p_e_r.  This allows, for instance, to
        !           942:                place the wrapper in PPAATTHH automatically.  Note that _w_r_a_p_p_e_r is
1.59      apb       943:                the full name of the file, not just a directory name.  If a
                    944:                relative path is specified, it will be converted to an absolute
                    945:                path before being used.
1.1       tv        946:
1.100   ! wiz       947:      --XX _x_1_1_s_r_c
        !           948:                Set the value of XX1111SSRRCCDDIIRR to _x_1_1_s_r_c.  If a relative path is
1.59      apb       949:                specified, it will be converted to an absolute path before
                    950:                being used.
1.49      lukem     951:
1.100   ! wiz       952:      --xx        Set MMKKXX1111==yyeess.
1.49      lukem     953:
1.100   ! wiz       954:      --ZZ _v_a_r    Unset ("zap") the environment variable _v_a_r.  This is propagated
        !           955:                to the nnbbmmaakkee wrapper.
1.40      lukem     956:
1.100   ! wiz       957:    TThhee ""nnbbmmaakkee--MMAACCHHIINNEE"" wwrraappppeerr ssccrriipptt
        !           958:      If using the bbuuiilldd..sshh script to build NetBSD, a nnbbmmaakkee--MMAACCHHIINNEE script
        !           959:      will be created in TTOOOOLLDDIIRR//bbiinn upon the first build to assist in building
1.1       tv        960:      subtrees on a cross-compile host.
                    961:
1.100   ! wiz       962:      nnbbmmaakkee--MMAACCHHIINNEE can be invoked in lieu of make(1), and will instead call
        !           963:      the up-to-date version of ``nbmake'' installed into TTOOOOLLDDIIRR//bbiinn with
        !           964:      several key variables pre-set, including MMAACCHHIINNEE, MMAACCHHIINNEE__AARRCCHH, and
        !           965:      TTOOOOLLDDIIRR.  nnbbmmaakkee--MMAACCHHIINNEE will also set variables specified with --VV, and
        !           966:      unset variables specified with --ZZ.
1.40      lukem     967:
1.100   ! wiz       968:      This script can be symlinked into a directory listed in PPAATTHH, or called
1.1       tv        969:      with an absolute path.
                    970:
1.100   ! wiz       971: EEXXAAMMPPLLEESS
1.78      apb       972:      1.   % ./build.sh [options] tools kernel=GENERIC
1.28      lukem     973:
                    974:           Build a new toolchain, and use the new toolchain to configure and
                    975:           build a new GENERIC kernel.
                    976:
1.78      apb       977:      2.   % ./build.sh [options] -U distribution
1.28      lukem     978:
1.100   ! wiz       979:           Using unprivileged mode, build a complete distribution to a DDEESSTTDDIIRR
        !           980:           directory that bbuuiilldd..sshh selects (and will display).
1.28      lukem     981:
1.78      apb       982:      3.   # ./build.sh [options] -U install=/
1.28      lukem     983:
1.100   ! wiz       984:           As root, install to _/ the distribution that was built by example 2.
        !           985:           Even though this is run as root, --UU is required so that the
        !           986:           permissions stored in DDEESSTTDDIIRR_/_M_E_T_A_L_O_G are correctly applied to the
        !           987:           files as they're copied to _/.
1.28      lukem     988:
1.78      apb       989:      4.   % ./build.sh [options] -U -u release
1.28      lukem     990:
1.100   ! wiz       991:           Using unprivileged mode, build a complete release to DDEESSTTDDIIRR and
        !           992:           RREELLEEAASSEEDDIIRR directories that bbuuiilldd..sshh selects (and will display).
        !           993:           MMKKUUPPDDAATTEE==yyeess (--uu) is set to prevent the ``make cleandir'', so that
1.38      lukem     994:           if this is run after example 2, it doesn't need to redo that portion
                    995:           of the release build.
1.16      lukem     996:
1.100   ! wiz       997: OOBBSSOOLLEETTEE VVAARRIIAABBLLEESS
        !           998:      NNBBUUIILLDDJJOOBBSS  Use the make(1) option --jj instead.
1.15      lukem     999:
1.100   ! wiz      1000:      UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN
1.15      lukem    1001:                  The new toolchain is now the default.  To disable, use
1.100   ! wiz      1002:                  TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG==yyeess.
1.10      sommerfe 1003:
1.100   ! wiz      1004: SSEEEE AALLSSOO
1.62      apb      1005:      make(1), hier(7), release(7), etcupdate(8), postinstall(8), sysinst(8),
1.100   ! wiz      1006:      _p_k_g_s_r_c_/_s_y_s_u_t_i_l_s_/_c_d_r_t_o_o_l_s
1.1       tv       1007:
1.100   ! wiz      1008: HHIISSTTOORRYY
        !          1009:      The bbuuiilldd..sshh based build scheme was introduced for NetBSD 1.6 as
        !          1010:      UUSSEE__NNEEWW__TTOOOOLLCCHHAAIINN, and re-worked to TTOOOOLLCCHHAAIINN__MMIISSSSIINNGG after that.
1.1       tv       1011:
1.100   ! wiz      1012: NetBSD                           May 25, 2012                           NetBSD

CVSweb <webmaster@jp.NetBSD.org>