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