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