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