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