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