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