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