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