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 Run Clang static analyzer against all objects and present output on stdout.
113 Run tests for a given subdirectory.
114 The default directory used is
116 but the check directory can be changed with
121 test suite on installed world.
123 Remove any files created during the build process.
126 .Pa ${.OBJDIR}/${DEPENDFILE}*
127 files generated by prior
133 Remove the canonical object directory if it exists, or perform
134 actions equivalent to
135 .Dq Li "make clean cleandepend"
137 This target will also remove an
143 It is advisable to run
144 .Dq Li "make cleandir"
145 twice: the first invocation will remove the canonical object directory
146 and the second one will clean up
149 Generate a list of build dependencies in file
150 .Pa ${.OBJDIR}/${DEPENDFILE} .
151 Per-object dependencies are generated at build time and stored in
152 .Pa ${.OBJDIR}/${DEPENDFILE}.${OBJ} .
154 Install the results of the build to the appropriate location in the
155 installation directory hierarchy specified in variable
158 Create the canonical object directory associated with the current
161 Create a symbolic link to the canonical object directory in
164 Generate a tags file using the program specified in the
168 The build system supports
174 The other supported targets under directory
177 .Bl -tag -width ".Cm distributeworld"
179 Spawn an interactive shell with environment variables set up for
180 cross-building the system.
181 The target architecture needs to be specified with
188 This target is only useful after a complete cross-toolchain including
189 the compiler, linker, assembler, headers and libraries has been
194 Build everything but the kernel, configure files in
198 The actual build location prefix used is
199 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
200 for native builds, and
201 .Pa ${MAKEOBJDIRPREFIX}/${TARGET}${.CURDIR}
202 for cross builds and native builds with variable
203 .Va CROSS_BUILD_TESTING
206 Attempt to clean up targets built by a preceding
209 .It Cm distributeworld
210 Distribute everything compiled by a preceding
213 Files are placed in the directory hierarchy specified by
217 This target is used while building a release; see
220 Archive the results of
221 .Cm distributeworld ,
222 placing the results in
224 This target is used while building a release; see
227 Install everything built by a preceding
229 step into the directory hierarchy pointed to by
234 If installing onto an NFS file system and running
238 option, make sure that
240 is running on both client and server.
243 on how to make it start at boot time.
245 Create the build toolchain needed to build the rest of the system.
246 For cross-architecture builds, this step creates a cross-toolchain.
248 For each architecture,
253 for all kernels for that architecture,
256 This command takes a long time.
258 Get updated sources as configured in
261 Print a list of supported
265 pairs for world and kernel targets.
267 Execute the same targets as
269 In addition print a summary of all failed targets at the end and
270 exit with an error if there were any.
272 Create a build toolchain for each architecture supported by the build system.
275 Kernel specific build targets in
278 .Bl -tag -width ".Cm distributekernel"
280 Rebuild the kernel and the kernel modules.
282 Install the kernel and the kernel modules to directory
283 .Pa ${DESTDIR}/boot/kernel ,
284 renaming any pre-existing directory with this name to
286 if it contained the currently running kernel.
287 The target directory under
289 may be modified using the
295 .It Cm distributekernel
296 Install the kernel to the directory
297 .Pa ${DISTDIR}/kernel/boot/kernel .
298 This target is used while building a release; see
301 Archive the results of
302 .Cm distributekernel ,
303 placing the results in
305 This target is used while building a release; see
312 .It Cm kernel-toolchain
313 Rebuild the tools needed for kernel compilation.
314 Use this if you did not do a
317 .It Cm reinstallkernel
318 Reinstall the kernel and the kernel modules, overwriting the contents
319 of the target directory.
322 target, the target directory can be specified using the
328 Convenience targets for cleaning up the install destination directory
332 .Bl -tag -width ".Cm delete-old-libs"
334 Print a list of old files and directories in the system.
336 Delete obsolete base system files and directories interactively.
338 .Li -DBATCH_DELETE_OLD_FILES
339 is specified at the command line, the delete operation will be
346 should be set as with
347 .Dq Li "make installworld" .
348 .It Cm delete-old-libs
349 Delete obsolete base system libraries interactively.
350 This target should only be used if no 3rd party software uses these
353 .Li -DBATCH_DELETE_OLD_FILES
354 is specified at the command line, the delete operation will be
361 should be set as with
362 .Dq Li "make installworld" .
365 Variables that influence all builds include:
366 .Bl -tag -width ".Va MAKEOBJDIRPREFIX"
368 Defines a set of debugging flags that will be used to build all userland
377 targets install binaries from the current
380 so that debugging information is retained in the installed binaries.
382 The directory hierarchy prefix where built objects will be installed.
385 defaults to the empty string.
386 .It Va MAKEOBJDIRPREFIX
387 Defines the prefix for directory names in the tree of built objects.
391 This variable should only be set in the environment and not via
395 If defined, compiler warnings will not cause the build to halt,
396 even if the makefile says otherwise.
398 If defined, the build process will run the DTrace CTF conversion
399 tools on built objects.
402 Additionally, builds in
404 are influenced by the following
407 .Bl -tag -width ".Va SUBDIR_OVERRIDE"
409 Overrides which kernel to build and install for the various kernel
414 If set, the build target
418 .Va NO_KERNELCONFIG ,
421 When set to a value other than
425 is set to the value of
428 If set, this variable supplies a list of additional directories relative to
429 the root of the source tree to build as part of the
433 If set, this variable supplies a list of additional tools that are used by the
438 .It Va LOCAL_LIB_DIRS
439 If set, this variable supplies a list of additional directories relative to
440 the root of the source tree to build as part of the
444 If set, this variable supplies a list of additional mtrees relative to the
445 root of the source tree to use as part of the
448 .It Va LOCAL_TOOL_DIRS
449 If set, this variable supplies a list of additional directories relative to
450 the root of the source tree to build as part of the
454 A list of ports with kernel modules that should be built and installed
460 .Bd -literal -offset indent
461 make PORTS_MODULES=emulators/kqemu-kmod kernel
464 Command to use at install time when stripping binaries.
465 Be sure to add any additional tools required to run
470 variable before running the
478 .It Va SUBDIR_OVERRIDE
479 Override the default list of sub-directories and only build the
480 sub-directory named in this variable.
483 then all libraries and includes, and some of the build tools will still build
487 it is necesarry to override
489 with any custom directories containing libraries.
490 This allows building a subset of the system in the same way as
492 does using its sysroot handling.
493 This variable can also be useful when debugging failed builds.
494 .Bd -literal -offset indent
495 make some-target SUBDIR_OVERRIDE=foo/bar
498 The target hardware platform.
499 This is analogous to the
502 This is necessary to cross-build some target architectures.
503 For example, cross-building for PC98 machines requires
504 .Va TARGET_ARCH Ns = Ns Li i386
506 .Va TARGET Ns = Ns Li pc98 .
509 defaults to the current hardware platform.
511 The target machine processor architecture.
512 This is analogous to the
515 Set this to cross-build for a different architecture.
518 defaults to the current machine architecture, unless
520 is also set, in which case it defaults to the appropriate
521 value for that platform.
522 Typically, one only needs to set
526 Builds under directory
528 are also influenced by defining one or more of the following symbols,
533 .Bl -tag -width ".Va -DNO_KERNELCONFIG"
535 If set, the build targets that clean parts of the object tree use the
541 If set, no object tree files are cleaned at all.
542 This is the default when
556 is set no kernel objects are cleaned either.
558 If set, the build process does not run the DTrace CTF conversion tools
561 If set, the build does not descend into the
563 subdirectory (i.e., manpages, locale data files, timezone data files and
566 files will not be rebuild from their sources).
567 .It Va NO_KERNELCLEAN
568 If set, the build process does not run
573 .It Va NO_KERNELCONFIG
574 If set, the build process does not run
580 If set, the build process does not run
586 If set, the update process does not update the source of the
588 documentation as part of the
591 .It Va NO_PORTSUPDATE
592 If set, the update process does not update the Ports tree as part of the
596 If set, the update process does not update the www tree as part of the
601 Builds under directory
603 are influenced by the following
606 .Bl -tag -width ".Va DOC_LANG"
608 If set, restricts the documentation build to the language subdirectories
609 specified as its content.
610 The default action is to build documentation for all languages.
615 target are influenced by the following
618 .Bl -tag -width ".Va MAKE_JUST_KERNELS"
620 Pass the value of this variable to each
622 invocation used to build worlds and kernels.
623 This can be used to enable multiple jobs within a single architecture's build
624 while still building each architecture serially.
625 .It Va MAKE_JUST_KERNELS
626 Only build kernels for each supported architecture.
627 .It Va MAKE_JUST_WORLDS
628 Only build worlds for each supported architecture.
629 .It Va UNIVERSE_TARGET
630 Execute the specified
632 target for each supported architecture instead of the default action of
633 building a world and one or more kernels.
636 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
637 .It Pa /usr/doc/Makefile
638 .It Pa /usr/doc/share/mk/doc.project.mk
639 .It Pa /usr/ports/Mk/bsd.port.mk
640 .It Pa /usr/ports/Mk/bsd.sites.mk
641 .It Pa /usr/share/examples/etc/make.conf
642 .It Pa /usr/src/Makefile
643 .It Pa /usr/src/Makefile.inc1
648 method of updating your system from the latest sources, please see the
653 The following sequence of commands can be used to cross-build the
654 system for the sparc64 architecture on an i386 host:
655 .Bd -literal -offset indent
657 make TARGET=sparc64 buildworld
658 make TARGET=sparc64 DESTDIR=/clients/sparc64 installworld
676 .An Mike W. Meyer Aq Mt mwm@mired.org
projects / FreeBSD / FreeBSD.git / blob