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