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