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 object directory can be changed from the default
204 The actual build location prefix used is
205 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
206 for native builds, and
207 .Pa ${MAKEOBJDIRPREFIX}/${TARGET}${.CURDIR}
208 for cross builds and native builds with variable
209 .Va CROSS_BUILD_TESTING
212 Attempt to clean up targets built by a preceding
215 .It Cm distributeworld
216 Distribute everything compiled by a preceding
219 Files are placed in the directory hierarchy specified by
223 This target is used while building a release; see
226 Archive the results of
227 .Cm distributeworld ,
228 placing the results in
230 This target is used while building a release; see
233 Install everything built by a preceding
235 step into the directory hierarchy pointed to by
240 If installing onto an NFS file system and running
244 option, make sure that
246 is running on both client and server.
249 on how to make it start at boot time.
251 Create the build toolchain needed to build the rest of the system.
252 For cross-architecture builds, this step creates a cross-toolchain.
254 For each architecture,
259 for all kernels for that architecture,
262 This command takes a long time.
264 Get updated sources as configured in
267 Print a list of supported
271 pairs for world and kernel targets.
273 Execute the same targets as
275 In addition print a summary of all failed targets at the end and
276 exit with an error if there were any.
278 Create a build toolchain for each architecture supported by the build system.
281 Kernel specific build targets in
284 .Bl -tag -width ".Cm distributekernel"
286 Rebuild the kernel and the kernel modules.
287 The object directory can be changed from the default
294 Install the kernel and the kernel modules to directory
295 .Pa ${DESTDIR}/boot/kernel ,
296 renaming any pre-existing directory with this name to
298 if it contained the currently running kernel.
299 The target directory under
301 may be modified using the
307 .It Cm distributekernel
308 Install the kernel to the directory
309 .Pa ${DISTDIR}/kernel/boot/kernel .
310 This target is used while building a release; see
313 Archive the results of
314 .Cm distributekernel ,
315 placing the results in
317 This target is used while building a release; see
324 .It Cm kernel-toolchain
325 Rebuild the tools needed for kernel compilation.
326 Use this if you did not do a
329 .It Cm reinstallkernel
330 Reinstall the kernel and the kernel modules, overwriting the contents
331 of the target directory.
334 target, the target directory can be specified using the
340 Convenience targets for cleaning up the install destination directory
344 .Bl -tag -width ".Cm delete-old-libs"
346 Print a list of old files and directories in the system.
348 Delete obsolete base system files and directories interactively.
350 .Li -DBATCH_DELETE_OLD_FILES
351 is specified at the command line, the delete operation will be
358 should be set as with
359 .Dq Li "make installworld" .
360 .It Cm delete-old-libs
361 Delete obsolete base system libraries interactively.
362 This target should only be used if no third party software uses these
365 .Li -DBATCH_DELETE_OLD_FILES
366 is specified at the command line, the delete operation will be
373 should be set as with
374 .Dq Li "make installworld" .
377 Variables that influence all builds include:
378 .Bl -tag -width ".Va MAKEOBJDIRPREFIX"
380 Defines a set of debugging flags that will be used to build all userland
389 targets install binaries from the current
392 so that debugging information is retained in the installed binaries.
394 The directory hierarchy prefix where built objects will be installed.
397 defaults to the empty string.
398 .It Va MAKEOBJDIRPREFIX
399 Defines the prefix for directory names in the tree of built objects.
403 This variable should only be set in the environment and not via
407 If defined, compiler warnings will not cause the build to halt,
408 even if the makefile says otherwise.
410 If defined, the build process will run the DTrace CTF conversion
411 tools on built objects.
414 Additionally, builds in
416 are influenced by the following
419 .Bl -tag -width ".Va SUBDIR_OVERRIDE"
421 Overrides which kernel to build and install for the various kernel
426 If set, the build target
430 .Va NO_KERNELCONFIG ,
433 When set to a value other than
437 is set to the value of
440 If set, this variable supplies a list of additional directories relative to
441 the root of the source tree to build as part of the
445 If set, this variable supplies a list of additional tools that are used by the
450 .It Va LOCAL_LIB_DIRS
451 If set, this variable supplies a list of additional directories relative to
452 the root of the source tree to build as part of the
456 If set, this variable supplies a list of additional mtrees relative to the
457 root of the source tree to use as part of the
460 .It Va LOCAL_TOOL_DIRS
461 If set, this variable supplies a list of additional directories relative to
462 the root of the source tree to build as part of the
465 .It Va LOCAL_XTOOL_DIRS
466 If set, this variable supplies a list of additional directories relative to
467 the root of the source tree to build as part of the
471 A list of ports with kernel modules that should be built and installed
477 .Bd -literal -offset indent
478 make PORTS_MODULES=emulators/kqemu-kmod kernel
481 Command to use at install time when stripping binaries.
482 Be sure to add any additional tools required to run
487 variable before running the
495 .It Va SUBDIR_OVERRIDE
496 Override the default list of sub-directories and only build the
497 sub-directory named in this variable.
500 then all libraries and includes, and some of the build tools will still build
506 will only build the specified directory as was done historically.
509 it is necesarry to override
511 with any custom directories containing libraries.
512 This allows building a subset of the system in the same way as
514 does using its sysroot handling.
515 This variable can also be useful when debugging failed builds.
516 .Bd -literal -offset indent
517 make some-target SUBDIR_OVERRIDE=foo/bar
520 The target hardware platform.
521 This is analogous to the
524 This is necessary to cross-build some target architectures.
525 For example, cross-building for ARM64 machines requires
526 .Va TARGET_ARCH Ns = Ns Li aarch64
528 .Va TARGET Ns = Ns Li arm64 .
531 defaults to the current hardware platform, unless
533 is also set, in which case it defaults to the appropriate
534 value for that architecture.
536 The target machine processor architecture.
537 This is analogous to the
540 Set this to cross-build for a different architecture.
543 defaults to the current machine architecture, unless
545 is also set, in which case it defaults to the appropriate
546 value for that platform.
547 Typically, one only needs to set
551 Builds under directory
553 are also influenced by defining one or more of the following symbols,
558 .Bl -tag -width ".Va -DNO_KERNELCONFIG"
560 If set, the build targets that clean parts of the object tree use the
566 If set, no object tree files are cleaned at all.
567 This is the default when
581 is set no kernel objects are cleaned either.
583 If set, the build process does not run the DTrace CTF conversion tools
586 If set, the build does not descend into the
588 subdirectory (i.e., manual pages, locale data files, timezone data files and
591 files will not be rebuild from their sources).
592 .It Va NO_KERNELCLEAN
593 If set, the build process does not run
598 .It Va NO_KERNELCONFIG
599 If set, the build process does not run
605 If set, the build process does not run
611 If set, the update process does not update the source of the
613 documentation as part of the
617 If set, the libraries phase will be skipped.
619 If set, no object directories will be created.
620 This should only be used if object directories were created in a
621 previous build and no new directories are connected.
622 .It Va NO_PORTSUPDATE
623 If set, the update process does not update the Ports tree as part of the
627 If set, the update process does not update the www tree as part of the
631 If set, the build target
636 and will skip most bootstrap phases.
637 It will only bootstrap libraries and build all of userland.
638 This option should be used only when it is known that none of the bootstrap
639 needs changed and that no new directories have been connected to the build.
642 Builds under directory
644 are influenced by the following
647 .Bl -tag -width ".Va DOC_LANG"
649 If set, restricts the documentation build to the language subdirectories
650 specified as its content.
651 The default action is to build documentation for all languages.
656 target are influenced by the following
659 .Bl -tag -width ".Va MAKE_JUST_KERNELS"
661 Pass the value of this variable to each
663 invocation used to build worlds and kernels.
664 This can be used to enable multiple jobs within a single architecture's build
665 while still building each architecture serially.
666 .It Va MAKE_JUST_KERNELS
667 Only build kernels for each supported architecture.
668 .It Va MAKE_JUST_WORLDS
669 Only build worlds for each supported architecture.
670 .It Va UNIVERSE_TARGET
671 Execute the specified
673 target for each supported architecture instead of the default action of
674 building a world and one or more kernels.
677 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
678 .It Pa /usr/doc/Makefile
679 .It Pa /usr/doc/share/mk/doc.project.mk
680 .It Pa /usr/ports/Mk/bsd.port.mk
681 .It Pa /usr/ports/Mk/bsd.sites.mk
682 .It Pa /usr/share/examples/etc/make.conf
683 .It Pa /usr/src/Makefile
684 .It Pa /usr/src/Makefile.inc1
689 method of updating your system from the latest sources, please see the
694 The following sequence of commands can be used to cross-build the
695 system for the armv6 architecture on an amd64 host:
696 .Bd -literal -offset indent
698 make TARGET_ARCH=armv6 buildworld buildkernel
699 make TARGET_ARCH=armv6 DESTDIR=/clients/arm64 installworld installkernel
718 .An Mike W. Meyer Aq Mt mwm@mired.org
projects / FreeBSD / FreeBSD.git / blob