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