4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd information on how to build the system
36 system and its applications are contained in three different directories,
42 These directories may be initially empty or non-existent until updated with
50 sources, which is loosely defined as the things required to rebuild
51 the system to a useful state.
54 contains the source for the system documentation, excluding the manual
58 contains a tree that provides a consistent interface for building and
59 installing third party applications.
60 For more information about the ports build process, see
65 command is used in each of these directories to build and install the
66 things in that directory.
69 command in any directory or
70 subdirectory of those directories has the same effect as issuing the
71 same command in all subdirectories of that directory.
72 With no target specified, the things in that directory are just built.
74 A source tree is allowed to be read-only.
77 objects are usually built in a separate object directory hierarchy
78 specified by the environment variable
79 .Va MAKEOBJDIRPREFIX ,
85 For a given source directory, its canonical object directory
87 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
93 .Pa /usr/obj${.CURDIR}
94 if this variable is not set.
95 Cross-builds set the object directory as described in the
100 The build may be controlled by defining
102 variables described in the
104 section below, and by the variables documented in
107 The following list provides the names and actions for the targets
108 supported by the build system:
109 .Bl -tag -width ".Cm cleandepend"
111 Remove any files created during the build process.
114 .Pa ${.OBJDIR}/${DEPENDFILE}
119 Remove the canonical object directory if it exists, or perform
120 actions equivalent to
121 .Dq Li "make clean cleandepend"
123 This target will also remove an
129 It is advisable to run
130 .Dq Li "make cleandir"
131 twice: the first invocation will remove the canonical object directory
132 and the second one will clean up
135 Generate a list of build dependencies in file
136 .Pa ${.OBJDIR}/${DEPENDFILE} .
138 Install the results of the build to the appropriate location in the
139 installation directory hierarchy specified in variable
142 Create the canonical object directory associated with the current
145 Create a symbolic link to the canonical object directory in
148 Generate a tags file using the program specified in the
152 The build system supports
158 The other supported targets under directory
161 .Bl -tag -width ".Cm distributeworld"
163 Spawn an interactive shell with environment variables set up for
164 cross-building the system.
165 The target architecture needs to be specified with
172 This target is only useful after a complete cross-toolchain including
173 the compiler, linker, assembler, headers and libraries has been
178 Build everything but the kernel, configure files in
182 The actual build location prefix used is
183 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
184 for native builds, and
185 .Pa ${MAKEOBJDIRPREFIX}/${TARGET}${.CURDIR}
186 for cross builds and native builds with variable
187 .Va CROSS_BUILD_TESTING
190 Attempt to clean up targets built by a preceding
193 .It Cm distributeworld
194 Distribute everything compiled by a preceding
197 Files are placed in the directory hierarchy specified by
201 This target is used while building a release; see
204 Archive the results of
205 .Cm distributeworld ,
206 placing the results in
208 This target is used while building a release; see
211 Install everything built by a preceding
213 step into the directory hierarchy pointed to by
218 If installing onto an NFS file system and running
222 option, make sure that
224 is running on both client and server.
227 on how to make it start at boot time.
229 Create the build toolchain needed to build the rest of the system.
230 For cross-architecture builds, this step creates a cross-toolchain.
232 For each architecture,
237 for all kernels for that architecture,
240 This command takes a long time.
242 Get updated sources as configured in
245 Print a list of supported
249 pairs for world and kernel targets.
251 Execute the same targets as
253 In addition print a summary of all failed targets at the end and
254 exit with an error if there were any.
256 Create a build toolchain for each architecture supported by the build system.
259 Kernel specific build targets in
262 .Bl -tag -width ".Cm distributekernel"
264 Rebuild the kernel and the kernel modules.
266 Install the kernel and the kernel modules to directory
267 .Pa ${DESTDIR}/boot/kernel ,
268 renaming any pre-existing directory with this name to
270 if it contained the currently running kernel.
271 The target directory under
273 may be modified using the
279 .It Cm distributekernel
280 Install the kernel to the directory
281 .Pa ${DISTDIR}/kernel/boot/kernel .
282 This target is used while building a release; see
285 Archive the results of
286 .Cm distributekernel ,
287 placing the results in
289 This target is used while building a release; see
296 .It Cm kernel-toolchain
297 Rebuild the tools needed for kernel compilation.
298 Use this if you did not do a
301 .It Cm reinstallkernel
302 Reinstall the kernel and the kernel modules, overwriting the contents
303 of the target directory.
306 target, the target directory can be specified using the
312 Convenience targets for cleaning up the install destination directory
316 .Bl -tag -width ".Cm delete-old-libs"
318 Print a list of old files and directories in the system.
320 Delete obsolete base system files and directories interactively.
322 .Li -DBATCH_DELETE_OLD_FILES
323 is specified at the command line, the delete operation will be
330 should be set as with
331 .Dq Li "make installworld" .
332 .It Cm delete-old-libs
333 Delete obsolete base system libraries interactively.
334 This target should only be used if no 3rd party software uses these
337 .Li -DBATCH_DELETE_OLD_FILES
338 is specified at the command line, the delete operation will be
345 should be set as with
346 .Dq Li "make installworld" .
349 Variables that influence all builds include:
350 .Bl -tag -width ".Va MAKEOBJDIRPREFIX"
352 Defines a set of debugging flags that will be used to build all userland
361 targets install binaries from the current
364 so that debugging information is retained in the installed binaries.
366 The directory hierarchy prefix where built objects will be installed.
369 defaults to the empty string.
370 .It Va MAKEOBJDIRPREFIX
371 Defines the prefix for directory names in the tree of built objects.
375 This variable should only be set in the environment and not via
379 If defined, compiler warnings will not cause the build to halt,
380 even if the makefile says otherwise.
382 If defined, the build process will run the DTrace CTF conversion
383 tools on built objects.
386 Additionally, builds in
388 are influenced by the following
391 .Bl -tag -width ".Va SUBDIR_OVERRIDE"
393 Overrides which kernel to build and install for the various kernel
398 If set, the build target
402 .Va NO_KERNELCONFIG ,
406 When set to a value other than
410 is set to the value of
413 If set, this variable supplies a list of additional directories relative to
414 the root of the source tree to build as part of the
418 If set, this variable supplies a list of additional tools that are used by the
423 .It Va LOCAL_LIB_DIRS
424 If set, this variable supplies a list of additional directories relative to
425 the root of the source tree to build as part of the
429 If set, this variable supplies a list of additional mtrees relative to the
430 root of the source tree to use as part of the
433 .It Va LOCAL_TOOL_DIRS
434 If set, this variable supplies a list of additional directories relative to
435 the root of the source tree to build as part of the
439 A list of ports with kernel modules that should be built and installed
445 .Bd -literal -offset indent
446 make PORTS_MODULES=emulators/kqemu-kmod kernel
449 Command to use at install time when stripping binaries.
450 Be sure to add any additional tools required to run
455 variable before running the
463 .It Va SUBDIR_OVERRIDE
464 Override the default list of sub-directories and only build the
465 sub-directory named in this variable.
466 This variable is useful when debugging failed builds.
467 .Bd -literal -offset indent
468 make some-target SUBDIR_OVERRIDE=foo/bar
471 The target hardware platform.
472 This is analogous to the
475 This is necessary to cross-build some target architectures.
476 For example, cross-building for PC98 machines requires
477 .Va TARGET_ARCH Ns = Ns Li i386
479 .Va TARGET Ns = Ns Li pc98 .
482 defaults to the current hardware platform.
484 The target machine processor architecture.
485 This is analogous to the
488 Set this to cross-build for a different architecture.
491 defaults to the current machine architecture, unless
493 is also set, in which case it defaults to the appropriate
494 value for that platform.
495 Typically, one only needs to set
499 Builds under directory
501 are also influenced by defining one or more of the following symbols,
506 .Bl -tag -width ".Va -DNO_KERNELDEPEND"
508 If set, the build targets that clean parts of the object tree use the
514 If set, no object tree files are cleaned at all.
521 is set no kernel objects are cleaned either.
523 If set, the build process does not run the DTrace CTF conversion tools
526 If set, the build does not descend into the
528 subdirectory (i.e., manpages, locale data files, timezone data files and
531 files will not be rebuild from their sources).
532 .It Va NO_KERNELCLEAN
533 If set, the build process does not run
538 .It Va NO_KERNELCONFIG
539 If set, the build process does not run
544 .It Va NO_KERNELDEPEND
545 If set, the build process does not run
551 If set, the build process does not run
557 If set, the update process does not update the source of the
559 documentation as part of the
562 .It Va NO_PORTSUPDATE
563 If set, the update process does not update the Ports tree as part of the
567 If set, the update process does not update the www tree as part of the
572 Builds under directory
574 are influenced by the following
577 .Bl -tag -width ".Va DOC_LANG"
579 If set, restricts the documentation build to the language subdirectories
580 specified as its content.
581 The default action is to build documentation for all languages.
586 target are influenced by the following
589 .Bl -tag -width ".Va MAKE_JUST_KERNELS"
591 Pass the value of this variable to each
593 invocation used to build worlds and kernels.
594 This can be used to enable multiple jobs within a single architecture's build
595 while still building each architecture serially.
596 .It Va MAKE_JUST_KERNELS
597 Only build kernels for each supported architecture.
598 .It Va MAKE_JUST_WORLDS
599 Only build worlds for each supported architecture.
600 .It Va UNIVERSE_TARGET
601 Execute the specified
603 target for each supported architecture instead of the default action of
604 building a world and one or more kernels.
607 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
608 .It Pa /usr/doc/Makefile
609 .It Pa /usr/doc/share/mk/doc.project.mk
610 .It Pa /usr/ports/Mk/bsd.port.mk
611 .It Pa /usr/ports/Mk/bsd.sites.mk
612 .It Pa /usr/share/examples/etc/make.conf
613 .It Pa /usr/src/Makefile
614 .It Pa /usr/src/Makefile.inc1
619 method of updating your system from the latest sources, please see the
624 The following sequence of commands can be used to cross-build the
625 system for the sparc64 architecture on an i386 host:
626 .Bd -literal -offset indent
628 make TARGET=sparc64 buildworld
629 make TARGET=sparc64 DESTDIR=/clients/sparc64 installworld
646 .An Mike W. Meyer Aq mwm@mired.org .