BUILDING revision 1.147
1 BUILDING(8) System Manager's Manual BUILDING(8) 2 3 NAME 4 BUILDING - Procedure for building NetBSD from source code. 5 6 REQUIREMENTS 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 19 FILES 20 Source tree layout 21 doc/BUILDING.mdoc 22 This document (in -mdoc troff format; the original copy). 23 24 BUILDING This document (in plaintext). 25 26 tools/compat/README 27 Special notes for cross-hosting a NetBSD build on non- 28 NetBSD platforms. 29 30 Makefile The main Makefile for NetBSD; should only be run for 31 native builds with an appropriately up-to-date version of 32 NetBSD make(1). Intended for expert use with knowledge of 33 its shortcomings, it has been superseded by the build.sh 34 shell script as the recommended means for building NetBSD. 35 36 UPDATING Special notes for updating from an earlier revision of 37 NetBSD. It is important to read this file before every 38 build of an updated source tree. 39 40 build.sh Bourne-compatible shell script used for building the host 41 build tools and the NetBSD system from scratch. Can be 42 used for both native and cross builds, and should be used 43 instead of make(1) as it performs additional checks to 44 prevent common issues going undetected, such as building 45 with an outdated version of make(1). 46 47 crypto/dist/, dist/, gnu/dist/ 48 Sources imported verbatim from third parties, without 49 mangling the existing build structure. Other source trees 50 in bin through usr.sbin use the NetBSD make(1) "reachover" 51 Makefile semantics when building these programs for a 52 native host. 53 54 external, sys/external 55 Sources and build infrastructure for components imported 56 (mostly) unchanged from upstream maintainers, sorted by 57 applicable license. This is (slowly) replacing the 58 crypto/dist, dist, and gnu/dist directories. 59 60 distrib/, etc/ 61 Sources for items used when making a full release 62 snapshot, such as files installed in DESTDIR/etc on the 63 destination system, boot media, and release notes. 64 65 tests/, regress/ 66 Regression test harness. Can be cross-compiled, but only 67 run natively. tests/ uses the atf(7) test framework; 68 regress/ contains older tests that have not yet been 69 migrated to atf(7). 70 71 sys/ NetBSD kernel sources. 72 73 tools/ "Reachover" build structure for the host build tools. 74 This has a special method of determining out-of-date 75 status. 76 77 bin/ ... usr.sbin/ 78 Sources to the NetBSD userland (non-kernel) programs. If 79 any of these directories are missing, they will be skipped 80 during the build. 81 82 external/mit/xorg/ 83 "Reachover" build structure for modular Xorg; the source 84 is in X11SRCDIR. 85 86 Build tree layout 87 The NetBSD build tree is described in hier(7), and the release layout is 88 described in release(7). 89 90 CONFIGURATION 91 Environment variables 92 Several environment variables control the behaviour of NetBSD builds. 93 94 HOST_SH Path name to a shell available on the host system and 95 suitable for use during the build. The NetBSD build 96 system requires a modern Bourne-like shell with POSIX- 97 compliant features, and also requires support for the 98 "local" keyword to declare local variables in shell 99 functions (which is a widely-implemented but non- 100 standardised feature). 101 102 Depending on the host system, a suitable shell may be 103 /bin/sh, /usr/xpg4/bin/sh, /bin/ksh (provided it is a 104 variant of ksh that supports the "local" keyword, such 105 as ksh88, but not ksh93), or /usr/local/bin/bash. 106 107 Most parts of the build require HOST_SH to be an 108 absolute path; however, build.sh allows it to be a 109 simple command name, which will be converted to an 110 absolute path by searching the PATH. 111 112 HOST_CC Path name to C compiler used to create the toolchain. 113 114 HOST_CFLAGS Flags passed to the host C compiler. 115 116 HOST_CXX Path name to C++ compiler used to create the toolchain. 117 118 HOST_CXXFLAGS Flags passed to the host C++ compiler. 119 120 INSTALLBOOT_UBOOT_PATHS 121 A colon-separated list of search paths used by 122 installboot(8) to find U-Boot packages. 123 124 MACHINE Machine type, e.g., "macppc". 125 126 MACHINE_ARCH Machine architecture, e.g., "powerpc". 127 128 MAKE Path name to invoke make(1) as. 129 130 MAKEFLAGS Flags to invoke make(1) with. Note that build.sh 131 ignores the value of MAKEFLAGS passed in the 132 environment, but allows MAKEFLAGS to be set via the -V 133 option. 134 135 MAKEOBJDIR Directory to use as the .OBJDIR for the current 136 directory. The value is subjected to variable 137 expansion by make(1). Typical usage is to set this 138 variable to a value involving the use of 139 `${.CURDIR:S...}' or `${.CURDIR:C...}', to derive the 140 value of .OBJDIR from the value of .CURDIR. Used only 141 if MAKEOBJDIRPREFIX is not defined. MAKEOBJDIR can be 142 provided only in the environment or via the -O flag of 143 build.sh; it cannot usefully be set inside a Makefile, 144 including mk.conf or ${MAKECONF}. 145 146 MAKEOBJDIRPREFIX Top level directory of the object directory tree. The 147 value is subjected to variable expansion by make(1). 148 build.sh will create the ${MAKEOBJDIRPREFIX} directory 149 if necessary, but if make(1) is used without build.sh, 150 then rules in <bsd.obj.mk> will abort the build if the 151 ${MAKEOBJDIRPREFIX} directory does not exist. If the 152 value is defined and valid, then 153 ${MAKEOBJDIRPREFIX}/${.CURDIR} is used as the .OBJDIR 154 for the current directory. The current directory may 155 be read only. MAKEOBJDIRPREFIX can be provided only in 156 the environment or via the -M flag of build.sh; it 157 cannot usefully be set inside a Makefile, including 158 mk.conf or ${MAKECONF}. 159 160 "make" variables 161 Several variables control the behavior of NetBSD builds. Unless 162 otherwise specified, these variables may be set in either the process 163 environment or the make(1) configuration file specified by MAKECONF. 164 165 BUILDID Identifier for the build. If set, this should be a short 166 string that is suitable for use as part of a file or 167 directory name. The identifier will be appended to object 168 directory names, and can be consulted in the make(1) 169 configuration file in order to set additional build 170 parameters, such as compiler flags. It will also be used as 171 part of the kernel version string, which can be printed by 172 "uname -v". 173 174 Default: Unset. 175 176 BUILDINFO This may be a multi-line string containing information about 177 the build. This will appear in DESTDIR/etc/release, and it 178 will be stored in the buildinfo variable in any kernels that 179 are built. When such kernels are booted, the sysctl(7) 180 kern.buildinfo variable will report this value. The string 181 may contain backslash escape sequences, such as "\\" 182 (representing a backslash character) and "\n" (representing a 183 newline). 184 185 Default: Unset. 186 187 BUILDSEED GCC uses random numbers when compiling C++ code. This 188 variable seeds the gcc random number generator using the 189 -frandom-seed flag with this value. By default, it is set to 190 NetBSD-(majorversion). Using a fixed value causes C++ 191 binaries to be the same when built from the same sources, 192 resulting in identical (reproducible) builds. Additional 193 information is available in the GCC documentation of 194 -frandom-seed. 195 196 CPUFLAGS Additional flags to the compiler/assembler to select CPU 197 instruction set options, CPU tuning options, etc. 198 199 Default: Unset. 200 201 DESTDIR Directory to contain the built NetBSD system. If set, 202 special options are passed to the compilation tools to 203 prevent their default use of the host system's /usr/include, 204 /usr/lib, and so forth. This pathname must be an absolute 205 path, and should not end with a slash (/) character. (For 206 installation into the system's root directory, set DESTDIR to 207 an empty string, not to "/"). The directory must reside on a 208 file system which supports long file names and hard links. 209 210 Default: Empty string if USETOOLS is "yes"; unset otherwise. 211 212 Note: build.sh will provide a default of destdir.MACHINE (in 213 the top-level .OBJDIR) unless run in `expert' mode. 214 215 MAKECONF The name of the make(1) configuration file. Only settable in 216 the process environment. 217 218 Default: "/etc/mk.conf" 219 220 MAKEVERBOSE 221 Level of verbosity of status messages. Supported values: 222 223 0 No descriptive messages or commands executed by make(1) 224 are shown. 225 226 1 Brief messages are shown describing what is being done, 227 but the actual commands executed by make(1) are not 228 displayed. 229 230 2 Descriptive messages are shown as above (prefixed with a 231 `#'), and ordinary commands performed by make(1) are 232 displayed. 233 234 3 In addition to the above, all commands performed by 235 make(1) are displayed, even if they would ordinarily 236 have been hidden through use of the "@" prefix in the 237 relevant makefile. 238 239 4 In addition to the above, commands executed by make(1) 240 are traced through use of the sh(1) "-x" flag. 241 242 Default: 2 243 244 MKCATPAGES Can be set to "yes" or "no". Indicates whether preformatted 245 plaintext manual pages will be created during a build. 246 247 Default: "no" 248 249 MKCROSSGDB Can be set to "yes" or "no". Create a cross-gdb as a host 250 tool. 251 252 Default: "no" 253 254 MKDEBUG Can be set to "yes" or "no". Indicates whether debug 255 information should be generated for all userland binaries 256 compiled. The result is collected as an additional debug.tgz 257 and xdebug.tgz set and installed in /usr/libdata/debug. 258 259 Default: "no" 260 261 MKDEBUGLIB Can be set to "yes" or "no". Indicates whether debug 262 information (see MKDEBUG) should also be generated for all 263 libraries built. 264 265 Default: "no" 266 267 MKDOC Can be set to "yes" or "no". Indicates whether system 268 documentation destined for DESTDIR/usr/share/doc will be 269 installed during a build. 270 271 Default: "yes" 272 273 MKHTML Can be set to "yes" or "no". Indicates whether preformatted 274 HTML manual pages will be built and installed 275 276 Default: "yes" 277 278 MKHOSTOBJ Can be set to "yes" or "no". If set to "yes", then for 279 programs intended to be run on the compile host, the name, 280 release, and architecture of the host operating system will 281 be suffixed to the name of the object directory created by 282 "make obj". (This allows multiple host systems to compile 283 NetBSD for a single target.) If set to "no", then programs 284 built to be run on the compile host will use the same object 285 directory names as programs built to be run on the target. 286 287 Default: "no" 288 289 MKINFO Can be set to "yes" or "no". Indicates whether GNU Info 290 files will be created and installed during a build. GNU Info 291 files are used for providing documentation by most of the 292 compilation tools. 293 294 Default: "yes" 295 296 MKKDEBUG Can be set to "yes" or "no". Force generation of full-debug 297 symbol versions of all kernels compiled. Alongside of the 298 netbsd kernel file, an unstripped version netbsd.gdb is 299 created. This is useful if a cross-gdb is built as well (see 300 MKCROSSGDB). 301 302 Default: "no" 303 304 MKKMOD Can be set to "yes" or "no". Indicates whether kernel 305 modules are built and installed. 306 307 Default: "yes" 308 309 MKLINT Can be set to "yes" or "no". Indicates whether lint(1) will 310 be run against portions of the NetBSD source code during the 311 build, and whether lint libraries will be installed into 312 DESTDIR/usr/libdata/lint. 313 314 Default: "no" 315 316 MKMAN Can be set to "yes" or "no". Indicates whether manual pages 317 will be installed during a build. 318 319 Default: "yes" 320 321 MKNLS Can be set to "yes" or "no". Indicates whether Native 322 Language System locale zone files will be compiled and 323 installed during a build. 324 325 Default: "yes" 326 327 MKOBJ Can be set to "yes" or "no". Indicates whether object 328 directories will be created when running "make obj". If set 329 to "no", then all built files will be located inside the 330 regular source tree. 331 332 Default: "yes" 333 334 Note that setting MKOBJ to "no" is not recommended and may 335 cause problems when updating the tree with cvs(1). 336 337 MKPIC Can be set to "yes" or "no". Indicates whether shared 338 objects and libraries will be created and installed during a 339 build. If set to "no", the entire built system will be 340 statically linked. 341 342 Default: Platform dependent. As of this writing, all 343 platforms except m68000 default to "yes". 344 345 MKPICINSTALL 346 Can be set to "yes" or "no". Indicates whether the ar(1) 347 format libraries (lib*_pic.a), used to generate shared 348 libraries, are installed during a build. 349 350 Default: "yes" 351 352 MKPROFILE Can be set to "yes" or "no". Indicates whether profiled 353 libraries (lib*_p.a) will be built and installed during a 354 build. 355 356 Default: "yes"; however, some platforms turn off MKPROFILE by 357 default at times due to toolchain problems with profiled 358 code. 359 360 MKREPRO Can be set to "yes" or "no". Create reproducible builds. 361 This enables different switches to make two builds from the 362 same source tree result in the same build results. 363 364 Default: "no" This may be set to "yes" by giving build.sh the 365 -P option. 366 367 MKREPRO_TIMESTAMP 368 Unix timestamp. When MKREPRO is set, the timestamp of all 369 files in the sets will be set to this value. 370 371 Default: Unset. This may be set automatically to the latest 372 source tree timestamp using cvslatest(1) by giving build.sh 373 the -P option. 374 375 MKSHARE Can be set to "yes" or "no". Indicates whether files 376 destined to reside in DESTDIR/usr/share will be built and 377 installed during a build. If set to "no", then all of 378 MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to 379 "no" unconditionally. 380 381 Default: "yes" 382 383 MKSTRIPIDENT 384 Can be set to "yes" or "no". Indicates whether RCS IDs, for 385 use with ident(1), should be stripped from program binaries 386 and shared libraries. 387 388 Default: "no" 389 390 MKSTRIPSYM Can be set to "yes" or "no". Indicates whether all local 391 symbols should be stripped from shared libraries. If "yes", 392 strip all local symbols from shared libraries; the affect is 393 equivalent to the -x option of ld(1). If "no", strip only 394 temporary local symbols; the affect is equivalent to the -X 395 option of ld(1). Keeping non-temporary local symbols such as 396 static function names is useful on using DTrace for userland 397 libraries and getting a backtrace from a rump kernel loading 398 shared libraries. 399 400 Default: "yes" 401 402 MKUNPRIVED Can be set to "yes" or "no". Indicates whether an 403 unprivileged install will occur. The user, group, 404 permissions, and file flags, will not be set on the installed 405 items; instead the information will be appended to a file 406 called METALOG in DESTDIR. The contents of METALOG are used 407 during the generation of the distribution tar files to ensure 408 that the appropriate file ownership is stored. 409 410 Default: "no" 411 412 MKUPDATE Can be set to "yes" or "no". Indicates whether all install 413 operations intended to write to DESTDIR will compare file 414 timestamps before installing, and skip the install phase if 415 the destination files are up-to-date. This also has 416 implications on full builds (see next subsection). 417 418 Default: "no" 419 420 MKX11 Can be set to "yes" or "no". Indicates whether X11 is built 421 from X11SRCDIR. 422 423 Default: "no" 424 425 TOOLDIR Directory to hold the host tools, once built. If specified, 426 must be an absolute path. This directory should be unique to 427 a given host system and NetBSD source tree. (However, 428 multiple targets may share the same TOOLDIR; the target- 429 dependent files have unique names.) If unset, a default 430 based on the uname(1) information of the host platform will 431 be created in the .OBJDIR of src. 432 433 Default: Unset. 434 435 USETOOLS Indicates whether the tools specified by TOOLDIR should be 436 used as part of a build in progress. Must be set to "yes" if 437 cross-compiling. 438 439 yes Use the tools from TOOLDIR. 440 441 no Do not use the tools from TOOLDIR, but refuse to build 442 native compilation tool components that are version- 443 specific for that tool. 444 445 never Do not use the tools from TOOLDIR, even when building 446 native tool components. This is similar to the 447 traditional NetBSD build method, but does not verify 448 that the compilation tools in use are up-to-date 449 enough in order to build the tree successfully. This 450 may cause build or runtime problems when building the 451 whole NetBSD source tree. 452 453 Default: "yes", unless TOOLCHAIN_MISSING is set to "yes". 454 455 USETOOLS is also set to "no" when using <bsd.*.mk> outside 456 the NetBSD source tree. 457 458 X11SRCDIR Directory containing the modular Xorg source. If specified, 459 must be an absolute path. The main modular Xorg source is 460 found in X11SRCDIR/external/mit. 461 462 Default: NETBSDSRCDIR/../xsrc, if that exists; otherwise 463 /usr/xsrc. 464 465 "make" variables for full builds 466 These variables only affect the top level "Makefile" and do not affect 467 manually building subtrees of the NetBSD source code. 468 469 INSTALLBOOT_BOARDS 470 A list of boards to create bootable images for. If 471 corresponding U-Boot packages are installed, bootable 472 images are created as part of a release. See the 473 -o board=name option of installboot(8). 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 540 BUILDING 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 -Z var Unset ("zap") the environment variable var. This is propagated 1061 to the nbmake wrapper. 1062 1063 The "nbmake-MACHINE" wrapper script 1064 If using the build.sh script to build NetBSD, a nbmake-MACHINE script 1065 will be created in TOOLDIR/bin upon the first build to assist in building 1066 subtrees on a cross-compile host. 1067 1068 nbmake-MACHINE can be invoked in lieu of make(1), and will instead call 1069 the up-to-date version of "nbmake" installed into TOOLDIR/bin with 1070 several key variables pre-set, including MACHINE, MACHINE_ARCH, and 1071 TOOLDIR. nbmake-MACHINE will also set variables specified with -V, and 1072 unset variables specified with -Z. 1073 1074 This script can be symlinked into a directory listed in PATH, or called 1075 with an absolute path. 1076 1077 EXAMPLES 1078 1. % ./build.sh [options] tools kernel=GENERIC 1079 1080 Build a new toolchain, and use the new toolchain to configure and 1081 build a new GENERIC kernel. 1082 1083 2. % ./build.sh [options] -U distribution 1084 1085 Using unprivileged mode, build a complete distribution to a DESTDIR 1086 directory that build.sh selects (and will display). 1087 1088 3. # ./build.sh [options] -U install=/ 1089 1090 As root, install to / the distribution that was built by example 2. 1091 Even though this is run as root, -U is required so that the 1092 permissions stored in DESTDIR/METALOG are correctly applied to the 1093 files as they're copied to /. 1094 1095 4. % ./build.sh [options] -U -u release 1096 1097 Using unprivileged mode, build a complete release to DESTDIR and 1098 RELEASEDIR directories that build.sh selects (and will display). 1099 MKUPDATE=yes (-u) is set to prevent the "make cleandir", so that if 1100 this is run after example 2, it doesn't need to redo that portion of 1101 the release build. 1102 1103 OBSOLETE VARIABLES 1104 NBUILDJOBS Use the make(1) option -j instead. 1105 1106 USE_NEW_TOOLCHAIN 1107 The new toolchain is now the default. To disable, use 1108 TOOLCHAIN_MISSING=yes. 1109 1110 SEE ALSO 1111 make(1), hier(7), release(7), etcupdate(8), installboot(8), 1112 postinstall(8), sysinst(8), pkgsrc/sysutils/cdrtools 1113 1114 HISTORY 1115 The build.sh based build scheme was introduced for NetBSD 1.6 as 1116 USE_NEW_TOOLCHAIN, and re-worked to TOOLCHAIN_MISSING after that. 1117 1118 CAVEATS 1119 After significant updates to third-party components in the source tree, 1120 the "make cleandir" operation may be insufficient to clean out old files 1121 in object directories. Instead, one may have to manually remove the 1122 files. Consult the UPDATING file for notices concerning this. 1123 1124 NetBSD October 13, 2020 NetBSD 1125
Indexes created Fri Oct 10 14:10:03 GMT 2025