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