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