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
52 sources, which is loosely defined as the things required to rebuild
53 the system to a useful state.
56 contains the source for the system documentation, excluding the manual
60 contains a tree that provides a consistent interface for building and
61 installing third party applications.
62 For more information about the ports build process, see
67 command is used in each of these directories to build and install the
68 things in that directory.
71 command in any directory or
72 subdirectory of those directories has the same effect as issuing the
73 same command in all subdirectories of that directory.
74 With no target specified, the things in that directory are just built.
76 A source tree is allowed to be read-only.
79 objects are usually built in a separate object directory hierarchy
80 specified by the environment variable
81 .Va MAKEOBJDIRPREFIX ,
87 The canonical object directory is described in the documentation for the
91 The build may be controlled by defining
93 variables described in the
95 section below, and by the variables documented in
98 The following list provides the names and actions for the targets
99 supported by the build system:
100 .Bl -tag -width ".Cm cleandepend"
102 Run Clang static analyzer against all objects and present output on stdout.
104 Run tests for a given subdirectory.
105 The default directory used is
107 but the check directory can be changed with
112 test suite on installed world.
114 Remove any files created during the build process.
117 .Pa ${.OBJDIR}/${DEPENDFILE}*
118 files generated by prior
124 Remove the canonical object directory if it exists, or perform
125 actions equivalent to
126 .Dq Li "make clean cleandepend"
128 This target will also remove an
134 It is advisable to run
135 .Dq Li "make cleandir"
136 twice: the first invocation will remove the canonical object directory
137 and the second one will clean up
140 Generate a list of build dependencies in file
141 .Pa ${.OBJDIR}/${DEPENDFILE} .
142 Per-object dependencies are generated at build time and stored in
143 .Pa ${.OBJDIR}/${DEPENDFILE}.${OBJ} .
145 Install the results of the build to the appropriate location in the
146 installation directory hierarchy specified in variable
149 Create the canonical object directory associated with the current
152 Create a symbolic link to the canonical object directory in
155 Generate a tags file using the program specified in the
159 The build system supports
165 The other supported targets under directory
168 .Bl -tag -width ".Cm distributeworld"
170 Spawn an interactive shell with environment variables set up for
171 building the system or individual components.
172 For cross-building the target architecture needs to be specified with
179 This target is only useful after a complete toolchain (including
180 the compiler, linker, assembler, headers and libraries) has been
185 Build everything but the kernel, configure files in
189 The object directory can be changed from the default
195 The actual build location prefix used
197 .Va WITH_UNIFIED_OBJDIR
201 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}/${TARGET}.${TARGET_ARCH}
204 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
205 for native builds, and
206 .Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}${.CURDIR}
207 for cross builds and native builds with variable
208 .Va CROSS_BUILD_TESTING
211 Attempt to clean up targets built by a preceding
213 or similar step built from this source directory.
216 .Va WITH_UNIFIED_OBJDIR
217 is enabled, attempt to clean up targets built by a preceding
220 or similar step, for any architecture built from this source directory.
221 .It Cm distributeworld
222 Distribute everything compiled by a preceding
225 Files are placed in the directory hierarchy specified by
229 This target is used while building a release; see
232 This target builds a cross-toolchain for the given
236 as well as a select list of static userland tools for the host system.
237 This is intended to be used in a jail where QEMU is used to improve
238 performance by avoiding emulating binaries that do not need to be emulated.
243 .It Cm native-xtools-install
244 Installs the results to
245 .Pa ${DESTDIR}/${NXTP}
255 Archive the results of
256 .Cm distributeworld ,
257 placing the results in
259 This target is used while building a release; see
262 Install everything built by a preceding
264 step into the directory hierarchy pointed to by
269 If installing onto an NFS file system and running
273 option, make sure that
275 is running on both client and server.
278 on how to make it start at boot time.
280 Create the build toolchain needed to build the rest of the system.
281 For cross-architecture builds, this step creates a cross-toolchain.
283 For each architecture,
288 for all kernels for that architecture,
291 This command takes a long time.
293 Get updated sources as configured in
296 Print a list of supported
300 pairs for world and kernel targets.
302 Execute the same targets as
304 In addition print a summary of all failed targets at the end and
305 exit with an error if there were any.
307 Create a build toolchain for each architecture supported by the build system.
309 Builds and installs a cross-toolchain and sysroot for the given
313 The sysroot contains target library and headers.
314 The target is an alias for
318 The location of the files installed can be controlled with
320 The target location in
323 .Pa ${DESTDIR}/${XDTP}
331 .Pa ${TARGET_ARCH}-freebsd .
337 Installs the files for the
341 Installs autoconf-style symlinks to
342 .Pa ${DESTDIR}/usr/bin
343 pointing into the xdev toolchain in
344 .Pa ${DESTDIR}/${XDTP} .
347 Kernel specific build targets in
350 .Bl -tag -width ".Cm distributekernel"
352 Rebuild the kernel and the kernel modules.
353 The object directory can be changed from the default
360 Install the kernel and the kernel modules to directory
361 .Pa ${DESTDIR}/boot/kernel ,
362 renaming any pre-existing directory with this name to
364 if it contained the currently running kernel.
365 The target directory under
367 may be modified using the
373 .It Cm distributekernel
374 Install the kernel to the directory
375 .Pa ${DISTDIR}/kernel/boot/kernel .
376 This target is used while building a release; see
379 Archive the results of
380 .Cm distributekernel ,
381 placing the results in
383 This target is used while building a release; see
390 .It Cm kernel-toolchain
391 Rebuild the tools needed for kernel compilation.
392 Use this if you did not do a
395 .It Cm reinstallkernel
396 Reinstall the kernel and the kernel modules, overwriting the contents
397 of the target directory.
400 target, the target directory can be specified using the
406 Convenience targets for cleaning up the install destination directory
410 .Bl -tag -width ".Cm delete-old-libs"
412 Print a list of old files and directories in the system.
414 Delete obsolete base system files and directories interactively.
416 .Li -DBATCH_DELETE_OLD_FILES
417 is specified at the command line, the delete operation will be
424 should be set as with
425 .Dq Li "make installworld" .
426 .It Cm delete-old-libs
427 Delete obsolete base system libraries interactively.
428 This target should only be used if no third party software uses these
431 .Li -DBATCH_DELETE_OLD_FILES
432 is specified at the command line, the delete operation will be
439 should be set as with
440 .Dq Li "make installworld" .
443 Variables that influence all builds include:
444 .Bl -tag -width ".Va MAKEOBJDIRPREFIX"
446 Defines a set of debugging flags that will be used to build all userland
455 targets install binaries from the current
458 so that debugging information is retained in the installed binaries.
460 The directory hierarchy prefix where built objects will be installed.
463 defaults to the empty string.
464 .It Va MAKEOBJDIRPREFIX
465 Defines the prefix for directory names in the tree of built objects.
469 This variable should only be set in the environment or
470 .Pa /etc/src-env.conf
477 If defined, compiler warnings will not cause the build to halt,
478 even if the makefile says otherwise.
480 If defined, the build process will run the DTrace CTF conversion
481 tools on built objects.
484 Additionally, builds in
486 are influenced by the following
489 .Bl -tag -width ".Va SUBDIR_OVERRIDE"
491 Overrides which kernel to build and install for the various kernel
496 Overrides the directory in which
498 and any files included by
502 .Pa sys/${ARCH}/conf .
504 If set, the build target
508 .Va NO_KERNELCONFIG ,
511 When set to a value other than
515 is set to the value of
518 If set, this variable supplies a list of additional directories relative to
519 the root of the source tree to build as part of the
522 The directories are built in parallel with each other,
523 and with the base system directories.
526 directive at the beginning of the
528 list to ensure all base system directories are built first.
530 may also be used as needed elsewhere within the list.
532 If set, this variable supplies a list of additional tools that are used by the
537 .It Va LOCAL_LIB_DIRS
538 If set, this variable supplies a list of additional directories relative to
539 the root of the source tree to build as part of the
542 The directories are built in parallel with each other,
543 and with the base system libraries.
546 directive at the beginning of the
548 list to ensure all base system libraries are built first.
550 may also be used as needed elsewhere within the list.
552 If set, this variable supplies a list of additional mtrees relative to the
553 root of the source tree to use as part of the
556 .It Va LOCAL_TOOL_DIRS
557 If set, this variable supplies a list of additional directories relative to
558 the root of the source tree to build as part of the
561 .It Va LOCAL_XTOOL_DIRS
562 If set, this variable supplies a list of additional directories relative to
563 the root of the source tree to build as part of the
567 A list of ports with kernel modules that should be built and installed
573 .Bd -literal -offset indent
574 make PORTS_MODULES=emulators/kqemu-kmod kernel
577 Command to use at install time when stripping binaries.
578 Be sure to add any additional tools required to run
583 variable before running the
591 .It Va SUBDIR_OVERRIDE
592 Override the default list of sub-directories and only build the
593 sub-directory named in this variable.
596 then all libraries and includes, and some of the build tools will still build
602 will only build the specified directory as was done historically.
605 it is necesarry to override
607 with any custom directories containing libraries.
608 This allows building a subset of the system in the same way as
610 does using its sysroot handling.
611 This variable can also be useful when debugging failed builds.
612 .Bd -literal -offset indent
613 make some-target SUBDIR_OVERRIDE=foo/bar
616 The target hardware platform.
617 This is analogous to the
620 This is necessary to cross-build some target architectures.
621 For example, cross-building for ARM64 machines requires
622 .Va TARGET_ARCH Ns = Ns Li aarch64
624 .Va TARGET Ns = Ns Li arm64 .
627 defaults to the current hardware platform, unless
629 is also set, in which case it defaults to the appropriate
630 value for that architecture.
632 The target machine processor architecture.
633 This is analogous to the
636 Set this to cross-build for a different architecture.
639 defaults to the current machine architecture, unless
641 is also set, in which case it defaults to the appropriate
642 value for that platform.
643 Typically, one only needs to set
647 Builds under directory
649 are also influenced by defining one or more of the following symbols,
654 .Bl -tag -width ".Va -DNO_KERNELCONFIG"
655 .It Va LOADER_DEFAULT_INTERP
656 Defines what interpreter the default loader program will have.
662 This creates the default link for
664 to the loader with that interpreter.
665 It also determines what interpreter is compiled into
668 If set, the build targets that clean parts of the object tree use the
674 If set, no object tree files are cleaned at all.
675 This is the default when
689 is set no kernel objects are cleaned either.
691 If set, the build process does not run the DTrace CTF conversion tools
694 If set, the build does not descend into the
696 subdirectory (i.e., manual pages, locale data files, timezone data files and
699 files will not be rebuild from their sources).
700 .It Va NO_KERNELCLEAN
701 If set, the build process does not run
706 .It Va NO_KERNELCONFIG
707 If set, the build process does not run
713 If set, the build process does not run
719 If set, the update process does not update the source of the
721 documentation as part of the
725 If set, the libraries phase will be skipped.
727 If set, no object directories will be created.
728 This should only be used if object directories were created in a
729 previous build and no new directories are connected.
730 .It Va NO_PORTSUPDATE
731 If set, the update process does not update the Ports tree as part of the
735 If set, the update process does not update the www tree as part of the
739 If set, the build target
744 and will skip most bootstrap phases.
745 It will only bootstrap libraries and build all of userland.
746 This option should be used only when it is known that none of the bootstrap
747 needs changed and that no new directories have been connected to the build.
750 Builds under directory
752 are influenced by the following
755 .Bl -tag -width ".Va DOC_LANG"
757 If set, restricts the documentation build to the language subdirectories
758 specified as its content.
759 The default action is to build documentation for all languages.
764 target are influenced by the following
767 .Bl -tag -width ".Va MAKE_JUST_KERNELS"
769 Pass the value of this variable to each
771 invocation used to build worlds and kernels.
772 This can be used to enable multiple jobs within a single architecture's build
773 while still building each architecture serially.
774 .It Va MAKE_JUST_KERNELS
775 Only build kernels for each supported architecture.
776 .It Va MAKE_JUST_WORLDS
777 Only build worlds for each supported architecture.
778 .It Va UNIVERSE_TARGET
779 Execute the specified
781 target for each supported architecture instead of the default action of
782 building a world and one or more kernels.
785 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
786 .It Pa /usr/doc/Makefile
787 .It Pa /usr/doc/share/mk/doc.project.mk
788 .It Pa /usr/ports/Mk/bsd.port.mk
789 .It Pa /usr/ports/Mk/bsd.sites.mk
790 .It Pa /usr/share/examples/etc/make.conf
791 .It Pa /usr/src/Makefile
792 .It Pa /usr/src/Makefile.inc1
797 method of updating your system from the latest sources, please see the
802 The following sequence of commands can be used to cross-build the
803 system for the armv6 architecture on an amd64 host:
804 .Bd -literal -offset indent
806 make TARGET_ARCH=armv6 buildworld buildkernel
807 make TARGET_ARCH=armv6 DESTDIR=/clients/arm installworld installkernel
827 .An Mike W. Meyer Aq Mt mwm@mired.org
projects / FreeBSD / FreeBSD.git / blob