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