share/man/man7/build.7

   1 .\" Copyright (c) 2000
   2 .\"     Mike W. Meyer
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 20, 2006
  28 .Dt BUILD 7
  29 .Os
  30 .Sh NAME
  31 .Nm build
  32 .Nd information on how to build the system
  33 .Sh DESCRIPTION
  34 The sources for the
  35 .Fx
  36 system and its applications are contained in three different directories,
  37 normally
  38 .Pa /usr/src ,
  39 .Pa /usr/doc ,
  40 and
  41 .Pa /usr/ports .
  42 Directory
  43 .Pa /usr/src
  44 contains the
  45 .Dq "base system"
  46 sources, which is loosely defined as the things required to rebuild
  47 the system to a useful state.
  48 Directory
  49 .Pa /usr/doc
  50 contains the source for the system documentation, excluding the manual
  51 pages.
  52 Directory
  53 .Pa /usr/ports
  54 contains a tree that provides a consistent interface for building and
  55 installing third party applications.
  56 For more information about the ports build process, see
  57 .Xr ports 7 .
  58 .Pp
  59 The
  60 .Xr make 1
  61 command is used in each of these directories to build and install the
  62 things in that directory.
  63 Issuing the
  64 .Xr make 1
  65 command in any directory or
  66 subdirectory of those directories has the same effect as issuing the
  67 same command in all subdirectories of that directory.
  68 With no target specified, the things in that directory are just built.
  69 .Pp
  70 A source tree is allowed to be read-only.
  71 As described in
  72 .Xr make 1 ,
  73 objects are usually built in a separate object directory hierarchy
  74 specified by the environment variable
  75 .Va MAKEOBJDIRPREFIX ,
  76 or under
  77 .Pa /usr/obj
  78 if variable
  79 .Va MAKEOBJDIRPREFIX
  80 is not set.
  81 For a given source directory, its canonical object directory
  82 would be
  83 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
  84 if
  85 .Xr make 1
  86 variable
  87 .Va MAKEOBJDIRPREFIX
  88 is set, or
  89 .Pa /usr/obj${.CURDIR}
  90 if this variable is not set.
  91 Cross-builds set the object directory as described in the
  92 documentation for the
  93 .Cm buildworld
  94 target below.
  95 .Pp
  96 The build may be controlled by defining
  97 .Xr make 1
  98 variables described in the
  99 .Sx ENVIRONMENT
 100 section below, and by the variables documented in
 101 .Xr make.conf 5 .
 102 .Pp
 103 The following list provides the names and actions for the targets
 104 supported by the build system:
 105 .Bl -tag -width ".Cm cleandepend"
 106 .It Cm clean
 107 Remove any files created during the build process.
 108 .It Cm cleandepend
 109 Remove the file
 110 .Pa ${.OBJDIR}/${DEPENDFILE}
 111 generated by a prior
 112 .Dq Li "make depend"
 113 step.
 114 .It Cm cleandir
 115 Remove the canonical object directory if it exists, or perform
 116 actions equivalent to
 117 .Dq Li "make clean cleandepend"
 118 if it does not.
 119 This target will also remove an
 120 .Pa obj
 121 link in
 122 .Pa ${.CURDIR}
 123 if that exists.
 124 .Pp
 125 It is advisable to run
 126 .Dq Li "make cleandir"
 127 twice: the first invocation will remove the canonical object directory
 128 and the second one will clean up
 129 .Pa ${.CURDIR} .
 130 .It Cm depend
 131 Generate a list of build dependencies in file
 132 .Pa ${.OBJDIR}/${DEPENDFILE} .
 133 .It Cm install
 134 Install the results of the build to the appropriate location in the
 135 installation directory hierarchy specified in variable
 136 .Va DESTDIR .
 137 .It Cm obj
 138 Create the canonical object directory associated with the current
 139 directory.
 140 .It Cm objlink
 141 Create a symbolic link to the canonical object directory in
 142 .Pa ${.CURDIR} .
 143 .It Cm tags
 144 Generate a tags file using the program specified in the
 145 .Xr make 1
 146 variable
 147 .Va CTAGS .
 148 The build system supports
 149 .Xr ctags 1
 150 and
 151 .Nm "GNU Global" .
 152 .El
 153 .Pp
 154 The other supported targets under directory
 155 .Pa /usr/src
 156 are:
 157 .Bl -tag -width ".Cm distributeworld"
 158 .It Cm buildenv
 159 Spawn an interactive shell with environment variables set up for
 160 cross-building the system.
 161 The target architecture needs to be specified with
 162 .Xr make 1
 163 variables
 164 .Va TARGET_ARCH
 165 and
 166 .Va TARGET .
 167 .Pp
 168 This target is only useful after a complete cross-toolchain including
 169 the compiler, linker, assembler, headers and libraries has been
 170 built; see the
 171 .Cm toolchain
 172 target below.
 173 .It Cm buildworld
 174 Build everything but the kernel, configure files in
 175 .Pa etc ,
 176 and
 177 .Pa release .
 178 The actual build location prefix used is
 179 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
 180 for native builds, and
 181 .Pa ${MAKEOBJDIRPREFIX}/${TARGET}${.CURDIR}
 182 for cross builds and native builds with variable
 183 .Va CROSS_BUILD_TESTING
 184 set.
 185 .It Cm cleanworld
 186 Attempt to clean up targets built by a preceding
 187 .Cm buildworld
 188 step.
 189 .It Cm distributeworld
 190 Distribute everything compiled by a preceding
 191 .Cm buildworld
 192 step.
 193 Files are placed in the directory hierarchy specified by
 194 .Xr make 1
 195 variable
 196 .Va DISTDIR .
 197 This target is used while building a release; see
 198 .Xr release 7 .
 199 .It Cm installworld
 200 Install everything built by a preceding
 201 .Cm buildworld
 202 step into the directory hierarchy pointed to by
 203 .Xr make 1
 204 variable
 205 .Va DESTDIR .
 206 .Pp
 207 If installing onto an NFS file system, make sure that
 208 .Xr rpc.lockd 8
 209 is running on both client and server.
 210 See
 211 .Xr rc.conf 5
 212 on how to make it start at boot time.
 213 .It Cm toolchain
 214 Create the build toolchain needed to build the rest of the system.
 215 For cross-architecture builds, this step creates a cross-toolchain.
 216 .It Cm universe
 217 Execute a
 218 .Cm buildworld
 219 and
 220 .Cm buildkernel
 221 for all kernels including
 222 .Pa LINT ,
 223 for each architecture supported by the build system.
 224 This command takes a long time.
 225 .It Cm update
 226 Get updated sources as configured in
 227 .Xr make.conf 5 .
 228 .El
 229 .Pp
 230 Kernel specific build targets in
 231 .Pa /usr/src
 232 are:
 233 .Bl -tag -width ".Cm reinstallkernel"
 234 .It Cm buildkernel
 235 Rebuild the kernel and the kernel modules.
 236 .It Cm installkernel
 237 Install the kernel and the kernel modules to directory
 238 .Pa ${DESTDIR}/boot/kernel ,
 239 renaming any pre-existing directory with this name to
 240 .Pa kernel.old
 241 if it contained the currently running kernel.
 242 The target directory under
 243 .Pa ${DESTDIR}
 244 may be modified using the
 245 .Va INSTKERNNAME
 246 and
 247 .Va KODIR
 248 .Xr make 1
 249 variables.
 250 .It Cm kernel
 251 Equivalent to
 252 .Cm buildkernel
 253 followed by
 254 .Cm installkernel
 255 .It Cm kernel-toolchain
 256 Rebuild the tools needed for kernel compilation.
 257 Use this if you did not do a
 258 .Cm buildworld
 259 first.
 260 .It Cm reinstallkernel
 261 Reinstall the kernel and the kernel modules, overwriting the contents
 262 of the target directory.
 263 As with the
 264 .Cm installkernel
 265 target, the target directory can be specified using the
 266 .Xr make 1
 267 variable
 268 .Va INSTKERNNAME .
 269 .El
 270 .Pp
 271 Convenience targets for cleaning up the install destination directory
 272 denoted by variable
 273 .Va DESTDIR
 274 include:
 275 .Bl -tag -width ".Cm delete-old-libs"
 276 .It Cm check-old
 277 Print a list of old files and directores in the system.
 278 .It Cm delete-old
 279 Delete obsolete base system files and directories interactively.
 280 When
 281 .Li -DBATCH_DELETE_OLD_FILES
 282 is specified at the command line, the delete operation will be
 283 non-interactive.
 284 The variables
 285 .Va DESTDIR ,
 286 .Va TARGET_ARCH
 287 and
 288 .Va TARGET
 289 should be set as with
 290 .Dq Li "make installworld" .
 291 .It Cm delete-old-libs
 292 Delete obsolete base system libraries interactively.
 293 This target should only be used if no 3rd party software uses these
 294 libraries.
 295 When
 296 .Li -DBATCH_DELETE_OLD_FILES
 297 is specified at the command line, the delete operation will be
 298 non-interactive.
 299 The variables
 300 .Va DESTDIR ,
 301 .Va TARGET_ARCH
 302 and
 303 .Va TARGET
 304 should be set as with
 305 .Dq Li "make installworld" .
 306 .El
 307 .Sh ENVIRONMENT
 308 Variables that influence all builds include:
 309 .Bl -tag -width ".Va MAKEOBJDIRPREFIX"
 310 .It Va DESTDIR
 311 The directory hierarchy prefix where built objects will be installed.
 312 If not set,
 313 .Va DESTDIR
 314 defaults to the empty string.
 315 .It Va MAKEOBJDIRPREFIX
 316 Defines the prefix for directory names in the tree of built objects.
 317 Defaults to
 318 .Pa /usr/obj
 319 if not defined.
 320 This variable should only be set in the environment and not via
 321 .Pa /etc/make.conf
 322 or the command line.
 323 .It Va NO_WERROR
 324 If defined, compiler warnings will not cause the build to halt,
 325 even if the makefile says otherwise.
 326 .El
 327 .Pp
 328 Additionally, builds in
 329 .Pa /usr/src
 330 are influenced by the following
 331 .Xr make 1
 332 variables:
 333 .Bl -tag -width ".Va SUBDIR_OVERRIDE"
 334 .It Va LOCAL_DIRS
 335 If set, this variable supplies a list of additional directories to
 336 build, relative to the root of the source tree.
 337 .It Va SUBDIR_OVERRIDE
 338 Override the default list of sub-directories and only build the
 339 sub-directory named in this variable.
 340 This variable is useful when debugging failed builds.
 341 .Bd -literal -offset indent
 342 make some-target SUBDIR_OVERRIDE=foo/bar
 343 .Ed
 344 .It Va TARGET
 345 The target hardware platform.
 346 This is analogous to the
 347 .Dq Nm uname Fl m
 348 output.
 349 This is necessary to cross-build some target architectures.
 350 For example, cross-building for PC98 machines requires
 351 .Va TARGET_ARCH Ns = Ns Li i386
 352 and
 353 .Va TARGET Ns = Ns Li pc98 .
 354 If not set,
 355 .Va TARGET
 356 defaults to the current hardware platform.
 357 .It Va TARGET_ARCH
 358 The target machine processor architecture.
 359 This is analogous to the
 360 .Dq Nm uname Fl p
 361 output.
 362 Set this to cross-build for a different architecture.
 363 If not set,
 364 .Va TARGET_ARCH
 365 defaults to the current machine architecture.
 366 .El
 367 .Pp
 368 Builds under directory
 369 .Pa /usr/doc
 370 are influenced by the following
 371 .Xr make 1
 372 variables:
 373 .Bl -tag -width ".Va DOC_LANG"
 374 .It Va DOC_LANG
 375 If set, restricts the documentation build to the language subdirectories
 376 specified as its content.
 377 The default action is to build documentation for all languages.
 378 .El
 379 .Sh FILES
 380 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
 381 .It Pa /usr/doc/Makefile
 382 .It Pa /usr/doc/share/mk/doc.project.mk
 383 .It Pa /usr/ports/Mk/bsd.port.mk
 384 .It Pa /usr/ports/Mk/bsd.sites.mk
 385 .It Pa /usr/share/examples/etc/make.conf
 386 .It Pa /usr/src/Makefile
 387 .It Pa /usr/src/Makefile.inc1
 388 .El
 389 .Sh EXAMPLES
 390 For an
 391 .Dq approved
 392 method of updating your system from the latest sources, please see the
 393 .Sx COMMON ITEMS
 394 section in
 395 .Pa src/UPDATING .
 396 .Pp
 397 The following sequence of commands can be used to cross-build the
 398 system for the sparc64 architecture on an i386 host:
 399 .Bd -literal -offset indent
 400 cd /usr/src
 401 make TARGET_ARCH=sparc64 buildworld
 402 make TARGET_ARCH=sparc64 DESTDIR=/clients/sparc64 installworld
 403 .Ed
 404 .Sh SEE ALSO
 405 .Xr cc 1 ,
 406 .Xr install 1 ,
 407 .Xr make 1 ,
 408 .Xr make.conf 5 ,
 409 .Xr src.conf 5 ,
 410 .Xr ports 7 ,
 411 .Xr release 7 ,
 412 .Xr config 8 ,
 413 .Xr mergemaster 8 ,
 414 .Xr reboot 8 ,
 415 .Xr shutdown 8
 416 .Sh AUTHORS
 417 .An Mike W. Meyer Aq mwm@mired.org .