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