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