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