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