Annotation of src/BUILDING, Revision 1.49
1.1 tv 1: BUILDING(8) NetBSD System Manager's Manual BUILDING(8)
2:
3: NAME
4: BUILDING - Procedure for building NetBSD from source code.
5:
6: STATUS
7: This document is a work-in-progress. As such, the information described
8: here may not match the reality of the build system as of this writing.
9: Once this document is completely in sync with reality, this paragraph
10: will be removed.
11:
1.44 lukem 12: Discrepancies between this documentation and the current reality of
13: implementation are noted specially, as with the note below:
1.1 tv 14:
15: Note: This document applies only to platforms which use the new toolchain
1.15 lukem 16: as indicated by the default setting of TOOLCHAIN_MISSING in <bsd.own.mk>.
1.5 tv 17: Platforms which have not yet been switched to the new toolchain should
18: continue building traditionally, using the notes specified in the file
19: UPDATING.
1.1 tv 20:
21: REQUIREMENTS
22: NetBSD is designed to be buildable on most POSIX-compliant host systems.
23: The basic build procedure is the same whether compiling natively (on the
24: same NetBSD architecture) or cross compiling (on another architecture or
25: OS).
26:
27: This source tree contains a special subtree, ``tools'', which uses the
28: host system to create a build toolchain for the target architecture. The
29: host system must have at least C and C++ compilers in order to create the
30: toolchain (make is not required); all other tools are created as part of
31: the NetBSD build process.
32:
33: FILES
34: Source tree layout
1.17 wiz 35: doc/BUILDING.mdoc
36: This document (in -mdoc troff format; the original copy).
1.1 tv 37:
1.2 wiz 38: BUILDING This document (in plaintext).
1.1 tv 39:
1.48 jmc 40: tools/compat/README
41: Special notes for cross-hosting a NetBSD build on non-
42: NetBSD platforms.
43:
1.44 lukem 44: Makefile The main Makefile for NetBSD; should only be run for
45: native builds with an appropriately up-to-date version of
1.1 tv 46: NetBSD make(1). (For building from out-of-date systems or
47: on a non-native host, see the build.sh shell script.)
48:
49: UPDATING Special notes for updating from an earlier revision of
50: NetBSD. It is important to read this file before every
51: build of an updated source tree.
52:
53: build.sh Bourne-compatible shell script used for building the host
54: build tools and the NetBSD system from scratch. Can be
55: used for both native and cross builds, and should be used
56: instead of make(1) for any source tree that is updated and
57: recompiled regularly.
58:
59: crypto/dist/, dist/, gnu/dist/
60: Sources imported verbatim from third parties, without man-
61: gling the existing build structure. Other source trees in
62: bin through usr.sbin use the NetBSD make(1) ``reachover''
1.44 lukem 63: Makefile semantics when building these programs for a
64: native host.
1.1 tv 65:
66: distrib/, etc/
67: Sources for items used when making a full release snap-
1.27 lukem 68: shot, such as files installed in DESTDIR/etc on the desti-
69: nation system, boot media, and release notes.
1.1 tv 70:
71: regress/ Regression test harness. Can be cross-compiled, but only
72: run natively.
73:
74: sys/ NetBSD kernel sources.
75:
76: tools/ ``Reachover'' build structure for the host build tools.
77: This has a special method of determining out-of-date sta-
78: tus.
79:
80: bin/ ... usr.sbin/
81: Sources to the NetBSD userland (non-kernel) programs. If
82: any of these directories are missing, they will be skipped
83: during the build.
84:
1.49 ! lukem 85: x11/ ``Reachover'' build structure for X11R6; the source is in
! 86: X11SRCDIR.
! 87:
1.1 tv 88: Build tree layout
89: The NetBSD build tree is described in hier(7), and the release layout is
90: described in release(7).
91:
92: CONFIGURATION
1.8 lukem 93: Environment variables
94: Several environment variables control the behaviour of NetBSD builds.
95:
96: MACHINE Machine type.
97:
98: MACHINE_ARCH Machine architecture.
99:
100: MAKE Path name to invoke make(1) as.
101:
102: MAKEFLAGS Flags to invoke make(1) with.
103:
104: MAKEOBJDIR Directory to use as the .OBJDIR for the current direc-
105: tory. Used only if MAKEOBJDIRPREFIX is not defined.
1.36 lukem 106: MAKEOBJDIR can only be provided in the environment or
1.41 lukem 107: via the -O flag of build.sh.
1.8 lukem 108:
109: MAKEOBJDIRPREFIX Top level directory of the object directory tree. If
110: this is defined, ${MAKEOBJDIRPREFIX}/${.CURDIR} is used
111: as the .OBJDIR for the current directory. The current
112: directory may be read only. MAKEOBJDIRPREFIX can only
1.36 lukem 113: be provided in the environment or via the -M flag of
114: build.sh.
1.8 lukem 115:
1.1 tv 116: "make" variables
117: Several variables control the behavior of NetBSD builds. Unless other-
118: wise specified, these variables may be set in either the process environ-
119: ment or the make(1) configuration file specified by MAKECONF.
120:
1.9 thorpej 121: BUILDID Identifier for the build. The identifier will be appended to
122: object directory names, and can be consulted in the make(1)
123: configuration file in order to set additional build parame-
124: ters, such as compiler flags.
125:
1.1 tv 126: DESTDIR Directory to contain the built NetBSD system. If set, spe-
127: cial options are passed to the compilation tools to prevent
128: their default use of the host system's /usr/include,
129: /usr/lib, and so forth. This pathname should not end with a
130: slash (/) character (for installation into the system's root
1.7 lukem 131: directory, set DESTDIR to an empty string). The directory
132: must reside on a file system which supports long file names
133: and hard links.
1.1 tv 134:
135: Default: Empty string if USETOOLS is ``yes''; unset other-
136: wise.
137:
1.30 lukem 138: Note: build.sh will provide a default of destdir.MACHINE (in
139: the top-level .OBJDIR) unless run in `expert' mode
140:
1.1 tv 141: MAKECONF The name of the make(1) configuration file. Only settable in
142: the process environment.
143:
144: Default: ``/etc/mk.conf''
145:
1.45 lukem 146: MAKEVERBOSE
147: Level of verbosity of status messages. Supported values:
148:
149: 0 No descriptive messages are shown.
150:
151: 1 Descriptive messages are shown.
152:
153: 2 Descriptive messages (prefixed with a `#') and command
154: output is not suppressed.
155:
156: Default: 2
157:
1.1 tv 158: MKCATPAGES Can be set to ``yes'' or ``no''. Indicates whether prefor-
159: matted plaintext manual pages will be created during a build.
160:
161: Default: ``yes''
162:
163: MKCRYPTO Can be set to ``yes'' or ``no''. Indicates whether crypto-
164: graphic code will be included in a build; provided for the
165: benefit of countries that do not allow strong cryptography.
1.44 lukem 166: Will not affect use of the standard low-security password
167: encryption system, crypt(3).
1.1 tv 168:
169: Default: ``yes''
170:
171: MKDOC Can be set to ``yes'' or ``no''. Indicates whether system
1.44 lukem 172: documentation destined for DESTDIR/usr/share/doc will be
173: installed during a build.
1.1 tv 174:
175: Default: ``yes''
176:
1.4 tv 177: MKHOSTOBJ Can be set to ``yes'' or ``no''. If set to ``yes'', then for
178: programs intended to be run on the compile host, the name,
179: release, and architecture of the host operating system will
180: be suffixed to the name of the object directory created by
181: ``make obj''. (This allows multiple host systems to compile
182: NetBSD for a single target.) If set to ``no'', then programs
183: built to be run on the compile host will use the same object
184: directory names as programs built to be run on the target.
185:
186: Default: ``no''
187:
1.1 tv 188: MKINFO Can be set to ``yes'' or ``no''. Indicates whether GNU Info
189: files, used for the documentation for most of the compilation
190: tools, will be created and installed during a build.
191:
192: Default: ``yes''
193:
194: MKLINT Can be set to ``yes'' or ``no''. Indicates whether lint(1)
195: will be run against portions of the NetBSD source code during
196: the build, and whether lint libraries will be installed into
1.27 lukem 197: DESTDIR/usr/libdata/lint.
1.1 tv 198:
199: Default: ``yes''
200:
201: MKMAN Can be set to ``yes'' or ``no''. Indicates whether manual
202: pages will be installed during a build.
203:
204: Default: ``yes''
205:
206: MKNLS Can be set to ``yes'' or ``no''. Indicates whether Native
1.44 lukem 207: Language System locale zone files will be compiled and
208: installed during a build.
1.1 tv 209:
210: Default: ``yes''
211:
212: MKOBJ Can be set to ``yes'' or ``no''. Indicates whether object
213: directories will be created when running ``make obj''. If
214: set to ``no'', then all built files will be located inside
215: the regular source tree.
216:
217: Default: ``yes''
218:
219: MKPIC Can be set to ``yes'' or ``no''. Indicates whether shared
220: objects and libraries will be created and installed during a
221: build. If set to ``no'', the entire built system will be
222: statically linked.
223:
224: Default: Platform dependent. As of this writing, all plat-
225: forms except sh3 default to ``yes''.
226:
227: MKPICINSTALL
228: Can be set to ``yes'' or ``no''. Indicates whether the ar(1)
1.44 lukem 229: format libraries (lib*_pic.a), used to generate shared
230: libraries, are installed during a build.
1.1 tv 231:
232: Default: ``yes''
233:
234: MKPROFILE Can be set to ``yes'' or ``no''. Indicates whether profiled
235: libraries (lib*_p.a) will be built and installed during a
236: build.
237:
238: Default: ``yes''; however, some platforms turn off MKPROFILE
239: by default at times due to toolchain problems with profiled
240: code.
241:
242: MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files
1.44 lukem 243: destined to reside in DESTDIR/usr/share will be built and
244: installed during a build. If set to ``no'', then all of
1.27 lukem 245: MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to
246: ``no'' unconditionally.
1.1 tv 247:
248: Default: ``yes''
249:
1.44 lukem 250: MKUNPRIVED Can be set to ``yes'' or ``no''. Indicates whether an
251: unprivileged install will occur. The user, group, permis-
252: sions, and file flags, will not be set on the installed item;
253: instead the information will be appended to a file called
1.38 lukem 254: METALOG in DESTDIR. The contents of METALOG is used during
255: the generation of the distribution tar files to ensure that
256: the appropriate file ownership is stored.
257:
258: Default: ``no''
259:
1.44 lukem 260: MKUPDATE Can be set to ``yes'' or ``no''. Indicates whether all
261: install operations intended to write to DESTDIR will compare
1.38 lukem 262: file timestamps before installing, and skip the install phase
1.44 lukem 263: if the destination files are up-to-date. This also has
264: implications on full builds (see next subsection).
1.38 lukem 265:
266: Default: ``no''
267:
1.49 ! lukem 268: MKX11 Can be set to ``yes'' or ``no''. Indicates whether X11R6 is
! 269: built from X11SRCDIR.
! 270:
! 271: Default: ``no''
! 272:
1.1 tv 273: TOOLDIR Directory to hold the host tools, once built. This directory
274: should be unique to a given host system and NetBSD source
275: tree. (However, multiple targets may share the same TOOLDIR;
276: the target-dependent files have unique names.) If unset, a
277: default based on the uname(1) information of the host plat-
1.39 lukem 278: form will be created in the .OBJDIR of src.
1.1 tv 279:
280: Default: Unset.
281:
282: USETOOLS Indicates whether the tools specified by TOOLDIR should be
283: used as part of a build in progress. Must be set to ``yes''
284: if cross-compiling.
285:
286: yes Use the tools from TOOLDIR.
287:
288: no Do not use the tools from TOOLDIR, but refuse to build
289: native compilation tool components that are version-
290: specific for that tool.
291:
292: never Do not use the tools from TOOLDIR, even when building
293: native tool components. This is similar to the tradi-
294: tional NetBSD build method, but does not verify that
295: the compilation tools in use are up-to-date enough in
296: order to build the tree successfully. This may cause
297: build or runtime problems when building the whole
298: NetBSD source tree.
299:
300: Default: ``yes'' if building all or part of a whole NetBSD
301: source tree (detected automatically); ``no'' otherwise (to
1.44 lukem 302: preserve traditional semantics of the <bsd.*.mk> make(1)
303: include files).
1.1 tv 304:
1.49 ! lukem 305: X11SRCDIR Directory containing the X11R6 source. The main X11R6 source
! 306: is found in X11SRCDIR/xfree/xc.
! 307:
! 308: Default: ``/usr/xsrc''
! 309:
1.1 tv 310: "make" variables for full builds
1.7 lukem 311: These variables only affect the top level ``Makefile'' and do not affect
312: manually building subtrees of the NetBSD source code.
1.1 tv 313:
1.20 lukem 314: INSTALLWORLDDIR Location for the ``make installworld'' target to install
315: to.
1.1 tv 316:
1.20 lukem 317: Default: ``/''
1.1 tv 318:
1.44 lukem 319: MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether
320: object directories will be created automatically (via a
1.20 lukem 321: ``make obj'' pass) at the start of a build.
1.1 tv 322:
1.34 lukem 323: Default: ``no''
1.1 tv 324:
1.38 lukem 325: MKUPDATE Can be set to ``yes'' or ``no''. If set, then in addi-
326: tion to the effects described for MKUPDATE=yes above,
327: this implies the effects of NOCLEANDIR (i.e., ``make
328: cleandir'' is avoided).
329:
330: Default: ``no''
331:
1.20 lukem 332: NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see
333: below)
1.1 tv 334:
1.20 lukem 335: Default: Unset.
1.1 tv 336:
1.20 lukem 337: NOCLEANDIR If set, avoids the ``make cleandir'' phase of a full
338: build. This has the effect of allowing only changed
339: files in a source tree to be recompiled. This can speed
340: up builds when updating only a few files in the tree.
1.1 tv 341:
1.20 lukem 342: Default: Unset.
1.1 tv 343:
1.20 lukem 344: NODISTRIBDIRS If set, avoids the ``make distrib-dirs'' phase of a full
345: build. This skips running mtree(8) on DESTDIR, useful
346: on systems where building as an unprivileged user, or
347: where it is known that the system-wide mtree files have
348: not changed.
1.1 tv 349:
1.20 lukem 350: Default: Unset.
1.1 tv 351:
1.20 lukem 352: NOINCLUDES If set, avoids the ``make includes'' phase of a full
353: build. This has the effect of preventing make(1) from
1.44 lukem 354: thinking that some programs are out-of-date simply
355: because the system include files have changed. However,
1.20 lukem 356: this option should not be used when updating the entire
357: NetBSD source tree arbitrarily; it is suggested to use
1.38 lukem 358: MKUPDATE=yes in that case.
1.1 tv 359:
1.20 lukem 360: Default: Unset.
1.1 tv 361:
1.20 lukem 362: RELEASEDIR If set, specifies the directory to which a release(7)
363: layout will be written at the end of a ``make release''.
364:
365: Default: Unset.
366:
1.30 lukem 367: Note: build.sh will provide a default of releasedir (in
368: the top-level .OBJDIR) unless run in `expert' mode
369:
1.1 tv 370: BUILDING
371: "make" command line options
372: This is only a summary of options available to make(1); only the options
373: used most frequently with NetBSD builds are listed here.
374:
1.10 sommerfe 375: -j njob Run up to njob make(1) subjobs in parallel. Makefiles should
1.44 lukem 376: use .WAIT or have explicit dependancies as necessary to
377: enforce build ordering. If you see build failures with -j,
1.10 sommerfe 378: please save complete build logs so the failures can be ana-
379: lyzed.
380:
1.1 tv 381: -m dir Specify the default directory for searching for system Make-
382: file segments, mainly the <bsd.*.mk> files. When building any
383: full NetBSD source tree, this should be set to the
384: ``share/mk'' directory in the source tree. (This is set auto-
385: matically when building from the top level.)
386:
387: -n Display the commands that would have been executed, but do not
388: actually execute them. This will still cause recursion to
389: take place.
390:
1.47 zuntum 391: -V var Print make(1)'s idea of the value of var. Does not build any
1.1 tv 392: targets.
393:
394: var=value Set the variable var to value, overriding any setting speci-
395: fied by the process environment, the MAKECONF configuration
396: file, or the system Makefile segments.
397:
398: "make" targets
399: These default targets may be built by running make(1) in any subtree of
400: the NetBSD source code. It is recommended that none of these be used
401: from the top level Makefile; as a specific exception, ``make obj'' and
402: ``make cleandir'' are useful in that context.
403:
404: all Build programs, libraries, and preformatted documentation.
405:
406: clean Remove program and library object code files.
407:
1.44 lukem 408: cleandir Same as clean, but also remove preformatted documentation,
409: dependency files generated by ``make depend'', and any other
1.49 ! lukem 410: files known to be created at build time.
1.1 tv 411:
1.44 lukem 412: depend Create dependency files (.depend) containing more detailed
413: information about the dependencies of source code on header
1.1 tv 414: files. Allows programs to be recompiled automatically when a
415: dependency changes.
416:
417: dependall Does a ``make depend'' immediately followed by a ``make all''.
1.10 sommerfe 418: This improves cache locality of the build since both passes
419: read the source files in their entirety.
1.1 tv 420:
1.49 ! lukem 421: distclean Synonym for cleandir.
! 422:
1.44 lukem 423: includes Build and install system header files. Typically needed
424: before any system libraries or programs can be built.
1.1 tv 425:
426: install Install programs, libraries, and documentation into DESTDIR.
1.27 lukem 427: Few files will be installed to DESTDIR/dev, DESTDIR/etc,
428: DESTDIR/root or DESTDIR/var in order to prevent user supplied
429: configuration data from being overwritten.
1.1 tv 430:
431: lint Run lint(1) against the C source code, where appropriate, and
432: generate system-installed lint libraries.
433:
434: obj Create object directories to be used for built files, instead
435: of building directly in the source tree.
436:
437: tags Create ctags(1) searchable function lists usable by the ex(1)
438: and vi(1) text editors.
439:
440: "make" targets for the top level
441: Additional make(1) targets are usable specifically from the top source
442: level to facilitate building the entire NetBSD source tree.
443:
1.20 lukem 444: build Build the entire NetBSD system. This orders portions of
445: the source tree such that prerequisites will be built in
446: the proper order.
447:
448: distribution Do a ``make build'', and then install a full distribution
1.27 lukem 449: into DESTDIR, including files in DESTDIR/dev, DESTDIR/etc,
450: DESTDIR/root and DESTDIR/var.
1.20 lukem 451:
452: buildworld As per ``make distribution'', except that it ensures that
453: DESTDIR is not the root directory.
454:
455: installworld Install the distribution from DESTDIR to INSTALLWORLDDIR
456: (which defaults to the root directory). Ensures that
457: INSTALLWORLDDIR is the not root directory if cross compil-
458: ing.
459:
460: Note: It is highly recommended that you upgrade your kernel
461: and reboot before performing this operation.
462:
1.25 lukem 463: sets Create distribution sets from DESTDIR into
464: RELEASEDIR/MACHINE/binary/sets. Should be run after ``make
465: distribution'' (as ``make build'' does not install all of
466: the required files).
467:
1.31 lukem 468: sourcesets Create source sets of the source tree into
469: RELEASEDIR/source/sets.
470:
1.44 lukem 471: release Do a ``make distribution'', build kernels, distribution
472: media, and install sets (this as per ``make sets''), and
473: then package the system into a standard release layout as
474: described by release(7). This requires that RELEASEDIR be
1.25 lukem 475: set (see above).
1.1 tv 476:
477: regression-tests
1.20 lukem 478: Can only be run after building the regression tests in the
479: directory ``regress''. Runs the compiled regression tests
480: on the local host.
1.1 tv 481:
482: The "build.sh" script
483: This script file is a Bourne shell script designed to build the entire
484: NetBSD system on any host with a Bourne shell in /bin/sh, including many
485: that are not POSIX compliant. Note that if a host system's /bin/sh is
486: unusually old and broken, the Korn Shell (/bin/ksh), if available, may be
487: a usable alternative.
488:
489: All cross-compile builds, and most native builds, of the entire system
490: should make use of build.sh rather than just running ``make''. This way,
491: the make(1) program will be bootstrapped properly, in case the host sys-
492: tem has an older or incompatible ``make'' program.
493:
494: When compiling the entire system via build.sh, many make(1) variables are
495: set for you in order to help encapsulate the build process. In the list
496: of options below, variables that are automatically set by build.sh are
497: noted where applicable.
498:
1.22 lukem 499: The following operations are supported by build.sh:
500:
1.44 lukem 501: build Build the system as per ``make build''. This option
502: implies the obj and tools operations.
1.22 lukem 503:
504: distribution Build a full distribution as per ``make distribution''.
505: This option implies the build operation.
506:
507: release Build a full release as per ``make release''. This option
508: implies the distribution operation.
509:
1.23 lukem 510: makewrapper Create the nbmake-MACHINE wrapper. This operation is auto-
511: matically performed for any of the other operations.
512:
1.22 lukem 513: obj Perform ``make obj''.
514:
515: tools Build and install the host tools from src/tools.
516:
1.35 lukem 517: install=idir Install the contents of DESTDIR to idir, using ``make
518: installworld''.
519:
1.22 lukem 520: kernel=kconf Build a new kernel. The kconf argument is the name of a
521: configuration file suitable for use by config(8). If kconf
522: does not contain any `/' characters, the configuration file
523: is expected to be found in the KERNCONFDIR directory, which
524: is typically sys/arch/MACHINE/conf. The new kernel will be
525: built in a subdirectory of KERNOBJDIR, which is typically
526: sys/arch/MACHINE/compile or an associated object directory.
527: In order to ensure that the kernel is built using up-to-
528: date tools, it is strongly recommended that the tools be
529: rebuilt (using the tools operation).
530:
1.35 lukem 531: releasekernel=kconf
532: Install a gzip(1)ed copy of the kernel built by
533: kernel=kconf into RELEASEDIR/MACHINE/binary/kernel, usually
1.44 lukem 534: as netbsd-kconf.gz, although the ``netbsd'' prefix is
535: determined from the ``config'' directives in kconf.
1.24 lukem 536:
537: sets Perform ``make sets''.
1.31 lukem 538:
539: sourcesets Perform ``make sourcesets''.
1.22 lukem 540:
541: The following command line options alter the behaviour of the above oper-
542: ations: The following command line options alter the behaviour of the
543: build.sh operations described above:
1.1 tv 544:
545: -a arch Set the value of MACHINE_ARCH to arch.
1.9 thorpej 546:
547: -B buildid
548: Set the value of BUILDID to buildid. This will also append the
549: build idenfitier to the name of the ``make'' wrapper script so
1.37 lukem 550: that the resulting name is of the form
551: ``nbmake-MACHINE-BUILDID''.
1.1 tv 552:
1.18 lukem 553: -D dest Set the value of DESTDIR to dest.
554:
1.23 lukem 555: -E Set `expert' mode. This overrides various sanity checks, and
556: allows: DESTDIR does not have to be set to a non-root path for
1.38 lukem 557: builds, and MKUNPRIVED=yes does not have to be set when build-
558: ing as a non-root user.
1.23 lukem 559:
560: Note: It is highly recommended that you know what you are doing
561: when you use this option.
1.19 lukem 562:
1.10 sommerfe 563: -j njob Passed through to make(1). Makefiles should use .WAIT or have
564: explicit dependancies as necessary to enforce build ordering.
565: If you see build failures with -j, please save complete build
566: logs so the failures can be analyzed.
1.1 tv 567:
1.40 lukem 568: -M obj Set MAKEOBJDIRPREFIX to obj. Unsets MAKEOBJDIR.
1.18 lukem 569:
1.1 tv 570: -m mach Set the value of MACHINE to mach. This will also override any
571: value of MACHINE_ARCH in the process environment with a value
1.33 lukem 572: deduced from mach, unless -a is specified, or mach is a special
573: case listed below. All cross builds require -m, but if unset
574: on a NetBSD host, the host's value of MACHINE will be detected
575: and used automatically.
576:
577: Some machines support multiple values for MACHINE_ARCH. For a
578: given value of mach, the following MACHINE and MACHINE_ARCH
579: values will result:
580:
581: mach MACHINE MACHINE_ARCH
582: evbmips evbmips (not set)
583: evbmips-eb evbmips mipseb
584: evbmips-el evbmips mipsel
585: evbsh3 evbsh3 (not set)
586: evbsh3-eb evbsh3 sh3eb
587: evbsh3-el evbsh3 sh3el
588: sbmips sbmips (not set)
589: sbmips-eb sbmips mipseb
590: sbmips-el sbmips mipsel
1.1 tv 591:
1.45 lukem 592: -N noiselevel
1.46 lukem 593: Set the ``noisyness'' level of the build, by setting
594: MAKEVERBOSE to noiselevel.
1.45 lukem 595:
1.1 tv 596: -n Show the commands that would be executed by build.sh, but do
597: not make any changes. This is similar in concept to ``make
598: -n''.
599:
1.18 lukem 600: -O obj Create an appropriate transform macro for MAKEOBJDIR that will
601: place the built object files under obj. For instance, a set-
602: ting of /usr/obj will place build-time files under
1.40 lukem 603: /usr/obj/bin, /usr/obj/lib, /usr/obj/usr.bin, and so forth.
604: Unsets MAKEOBJDIRPREFIX.
1.18 lukem 605:
1.34 lukem 606: -o Set the value of MKOBJDIRS to ``no''. Otherwise, it will be
607: automatically set to ``yes'' (which is opposite to the default
608: behaviour).
1.1 tv 609:
1.22 lukem 610: -R rel Set the value of RELEASEDIR to rel.
1.18 lukem 611:
1.1 tv 612: -r Remove the contents of DESTDIR and TOOLDIR before building
613: (provides a clean starting point). This will skip deleting
614: DESTDIR if building on a native system to the root directory.
615:
1.18 lukem 616: -T tools Set the value of TOOLDIR to tools. If set, the bootstrap
617: ``make'' will only be rebuilt as needed (when the source files
618: for make(1) change).
619:
1.38 lukem 620: -U Set MKUNPRIVED=yes.
1.18 lukem 621:
1.38 lukem 622: -u Set MKUPDATE=yes.
1.1 tv 623:
1.21 lukem 624: -V var=[value]
1.40 lukem 625: Set the environment variable var to an optional value. This is
626: propagated to the nbmake wrapper.
1.21 lukem 627:
1.1 tv 628: -w wrapper
629: Create the nbmake wrapper script (see below) in a custom loca-
630: tion, specified by wrapper. This allows, for instance, to
631: place the wrapper in PATH automatically. Note that wrapper is
632: the full name of the file, not just a directory name.
633:
1.49 ! lukem 634: -X x11src
! 635: Set the value of X11SRCDIR to x11src.
! 636:
! 637: -x Set MKX11=yes.
! 638:
1.40 lukem 639: -Z var Unset ("zap") the environment variable var. This is propagated
640: to the nbmake wrapper.
641:
1.1 tv 642: The "nbmake-MACHINE" wrapper script
643: If using the build.sh script to build NetBSD, a nbmake-MACHINE script
644: will be created in TOOLDIR/bin upon the first build to assist in building
645: subtrees on a cross-compile host.
646:
647: nbmake-MACHINE can be invoked in lieu of make(1), and will instead call
648: the up-to-date version of ``nbmake'' installed into TOOLDIR/bin with sev-
649: eral key variables pre-set, including MACHINE, MACHINE_ARCH, and TOOLDIR.
1.40 lukem 650: build.sh will also set variables specified with -V, and unset variables
651: specified with -Z.
652:
1.1 tv 653: This script can be symlinked into a directory listed in PATH, or called
654: with an absolute path.
655:
1.16 lukem 656: EXAMPLES
1.44 lukem 657: 1. % ./build.sh tools kernel=GENERIC
1.28 lukem 658:
659: Build a new toolchain, and use the new toolchain to configure and
660: build a new GENERIC kernel.
661:
1.44 lukem 662: 2. % ./build.sh -U distribution
1.28 lukem 663:
1.30 lukem 664: Using unprivileged mode, build a complete distribution to a DESTDIR
665: directory that build.sh selects (and will display).
1.28 lukem 666:
1.43 martti 667: 3. # ./build.sh -U install=/
1.28 lukem 668:
1.29 lukem 669: As root, install to / the distribution that was built by example 2.
670: Even though this is run as root, -U is required so that the permis-
1.30 lukem 671: sions stored in DESTDIR/METALOG are correctly applied to the files
672: as they're copied to /.
1.28 lukem 673:
1.44 lukem 674: 4. % ./build.sh -U -u release
1.28 lukem 675:
1.30 lukem 676: Using unprivileged mode, build a complete release to DESTDIR and
677: RELEASEDIR directories that build.sh selects (and will display).
1.38 lukem 678: MKUPDATE=yes (-u) is set to prevent the ``make cleandir'', so that
679: if this is run after example 2, it doesn't need to redo that portion
680: of the release build.
1.16 lukem 681:
1.10 sommerfe 682: OBSOLETE VARIABLES
1.15 lukem 683: NBUILDJOBS Use the make(1) option -j, instead.
684:
685: USE_NEW_TOOLCHAIN
686: The new toolchain is now the default. To disable, use
687: TOOLCHAIN_MISSING=yes.
1.10 sommerfe 688:
1.1 tv 689: SEE ALSO
690: make(1), hier(7), release(7)
691:
692: HISTORY
1.15 lukem 693: The build.sh based build scheme was introduced for NetBSD 1.6 as
694: USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that.
1.1 tv 695:
696: BUGS
1.15 lukem 697: A few platforms are not yet using this build system.
1.1 tv 698:
1.49 ! lukem 699: NetBSD February 6, 2003 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