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