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