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