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