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