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