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
27 .Dd September 11, 2020
32 .Nd General instructions 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 issues the
73 command recursively in all subdirectories.
74 With no target specified, the items in the directories are built
75 and no further action is taken.
77 A source tree is allowed to be read-only.
80 objects are usually built in a separate object directory hierarchy
81 specified by the environment variable
82 .Va MAKEOBJDIRPREFIX ,
88 The canonical object directory is described in the documentation for the
92 The build may be controlled by defining
94 variables described in the
96 section below, and by the variables documented in
99 The default components included in the build are specified in the file
102 To override the default file, include the SRCCONF option in the make steps,
103 pointing to a custom src.conf file.
104 For more information see
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 building the system or individual components.
181 For cross-building the target architecture needs to be specified with
188 This target is only useful after a complete 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
206 .Va WITH_UNIFIED_OBJDIR
210 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}/${TARGET}.${TARGET_ARCH}
213 .Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
214 for native builds, and
215 .Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}${.CURDIR}
216 for cross builds and native builds with variable
217 .Va CROSS_BUILD_TESTING
220 Attempt to clean up targets built by a preceding
222 or similar step built from this source directory.
225 .Va WITH_UNIFIED_OBJDIR
226 is enabled, attempt to clean up targets built by a preceding
229 or similar step, for any architecture built from this source directory.
230 .It Cm distributeworld
231 Distribute everything compiled by a preceding
234 Files are placed in the directory hierarchy specified by
238 This target is used while building a release; see
241 This target builds a cross-toolchain for the given
245 as well as a select list of static userland tools for the host system.
246 This is intended to be used in a jail where QEMU is used to improve
247 performance by avoiding emulating binaries that do not need to be emulated.
252 .It Cm native-xtools-install
253 Installs the results to
254 .Pa ${DESTDIR}/${NXTP}
264 Archive the results of
265 .Cm distributeworld ,
266 placing the results in
268 This target is used while building a release; see
271 Install everything built by a preceding
273 step into the directory hierarchy pointed to by
278 If installing onto an NFS file system and running
282 option, make sure that
284 is running on both client and server.
287 on how to make it start at boot time.
289 Create the build toolchain needed to build the rest of the system.
290 For cross-architecture builds, this step creates a cross-toolchain.
292 For each architecture,
297 for all kernels for that architecture,
300 This command takes a long time.
302 Get updated sources as configured in
305 Print a list of supported
309 pairs for world and kernel targets.
311 Execute the same targets as
313 In addition print a summary of all failed targets at the end and
314 exit with an error if there were any.
316 Create a build toolchain for each architecture supported by the build system.
318 Builds and installs a cross-toolchain and sysroot for the given
322 The sysroot contains target library and headers.
323 The target is an alias for
327 The location of the files installed can be controlled with
329 The target location in
332 .Pa ${DESTDIR}/${XDTP}
340 .Pa ${TARGET_ARCH}-freebsd .
346 Installs the files for the
350 Installs autoconf-style symlinks to
351 .Pa ${DESTDIR}/usr/bin
352 pointing into the xdev toolchain in
353 .Pa ${DESTDIR}/${XDTP} .
356 Kernel specific build targets in
359 .Bl -tag -width ".Cm distributekernel"
361 Rebuild the kernel and the kernel modules.
362 The object directory can be changed from the default
369 Install the kernel and the kernel modules to directory
370 .Pa ${DESTDIR}/boot/kernel ,
371 renaming any pre-existing directory with this name to
373 if it contained the currently running kernel.
374 The target directory under
376 may be modified using the
382 .It Cm distributekernel
383 Install the kernel to the directory
384 .Pa ${DISTDIR}/kernel/boot/kernel .
385 This target is used while building a release; see
388 Archive the results of
389 .Cm distributekernel ,
390 placing the results in
392 This target is used while building a release; see
399 .It Cm kernel-toolchain
400 Rebuild the tools needed for kernel compilation.
401 Use this if you did not do a
404 .It Cm reinstallkernel
405 Reinstall the kernel and the kernel modules, overwriting the contents
406 of the target directory.
409 target, the target directory can be specified using the
415 Convenience targets for cleaning up the install destination directory
419 .Bl -tag -width ".Cm delete-old-libs"
421 Print a list of old files and directories in the system.
423 Delete obsolete base system files and directories interactively.
425 .Li -DBATCH_DELETE_OLD_FILES
426 is specified at the command line, the delete operation will be
433 should be set as with
434 .Dq Li "make installworld" .
435 .It Cm delete-old-libs
436 Delete obsolete base system libraries interactively.
437 This target should only be used if no third party software uses these
440 .Li -DBATCH_DELETE_OLD_FILES
441 is specified at the command line, the delete operation will be
448 should be set as with
449 .Dq Li "make installworld" .
452 Variables that influence all builds include:
453 .Bl -tag -width ".Va MAKEOBJDIRPREFIX"
455 Defines a set of debugging flags that will be used to build all userland
464 targets install binaries from the current
467 so that debugging information is retained in the installed binaries.
469 The directory hierarchy prefix where built objects will be installed.
472 defaults to the empty string.
473 .It Va MAKEOBJDIRPREFIX
474 Defines the prefix for directory names in the tree of built objects.
478 This variable should only be set in the environment or
479 .Pa /etc/src-env.conf
486 If defined, compiler warnings will not cause the build to halt,
487 even if the makefile says otherwise.
489 If defined, the build process will run the DTrace CTF conversion
490 tools on built objects.
493 Additionally, builds in
495 are influenced by the following
498 .Bl -tag -width ".Va SUBDIR_OVERRIDE"
500 Overrides which kernel to build and install for the various kernel
505 Overrides the directory in which
507 and any files included by
511 .Pa sys/${ARCH}/conf .
513 If set, the build target
517 .Va NO_KERNELCONFIG ,
520 When set to a value other than
524 is set to the value of
527 If set, this variable supplies a list of additional directories relative to
528 the root of the source tree to build as part of the
531 The directories are built in parallel with each other,
532 and with the base system directories.
535 directive at the beginning of the
537 list to ensure all base system directories are built first.
539 may also be used as needed elsewhere within the list.
541 If set, this variable supplies a list of additional tools that are used by the
546 .It Va LOCAL_LIB_DIRS
547 If set, this variable supplies a list of additional directories relative to
548 the root of the source tree to build as part of the
551 The directories are built in parallel with each other,
552 and with the base system libraries.
555 directive at the beginning of the
557 list to ensure all base system libraries are built first.
559 may also be used as needed elsewhere within the list.
561 If set, this variable supplies a list of additional mtrees relative to the
562 root of the source tree to use as part of the
565 .It Va LOCAL_TOOL_DIRS
566 If set, this variable supplies a list of additional directories relative to
567 the root of the source tree to build as part of the
570 .It Va LOCAL_XTOOL_DIRS
571 If set, this variable supplies a list of additional directories relative to
572 the root of the source tree to build as part of the
576 A list of ports with kernel modules that should be built and installed
582 .Bd -literal -offset indent
583 make PORTS_MODULES=emulators/kqemu-kmod kernel
586 Specify a file to override the default
588 The src.conf file controls the components to build.
592 Command to use at install time when stripping binaries.
593 Be sure to add any additional tools required to run
598 variable before running the
606 .It Va SUBDIR_OVERRIDE
607 Override the default list of sub-directories and only build the
608 sub-directory named in this variable.
611 then all libraries and includes, and some of the build tools will still build
617 will only build the specified directory as was done historically.
620 it is necesarry to override
622 with any custom directories containing libraries.
623 This allows building a subset of the system in the same way as
625 does using its sysroot handling.
626 This variable can also be useful when debugging failed builds.
627 .Bd -literal -offset indent
628 make some-target SUBDIR_OVERRIDE=foo/bar
631 The target hardware platform.
632 This is analogous to the
635 This is necessary to cross-build some target architectures.
636 For example, cross-building for ARM64 machines requires
637 .Va TARGET_ARCH Ns = Ns Li aarch64
639 .Va TARGET Ns = Ns Li arm64 .
642 defaults to the current hardware platform, unless
644 is also set, in which case it defaults to the appropriate
645 value for that architecture.
647 The target machine processor architecture.
648 This is analogous to the
651 Set this to cross-build for a different architecture.
654 defaults to the current machine architecture, unless
656 is also set, in which case it defaults to the appropriate
657 value for that platform.
658 Typically, one only needs to set
662 Builds under directory
664 are also influenced by defining one or more of the following symbols,
669 .Bl -tag -width ".Va -DNO_KERNELCONFIG"
670 .It Va LOADER_DEFAULT_INTERP
671 Defines what interpreter the default loader program will have.
677 This creates the default link for
679 to the loader with that interpreter.
680 It also determines what interpreter is compiled into
683 If set, the build targets that clean parts of the object tree use the
689 If set, no object tree files are cleaned at all.
690 This is the default when
704 is set no kernel objects are cleaned either.
706 If set, the build process does not run the DTrace CTF conversion tools
709 If set, the build does not descend into the
711 subdirectory (i.e., manual pages, locale data files, timezone data files and
714 files will not be rebuild from their sources).
715 .It Va NO_KERNELCLEAN
716 If set, the build process does not run
721 .It Va NO_KERNELCONFIG
722 If set, the build process does not run
728 If set, the build process does not run
734 If set, the update process does not update the source of the
736 documentation as part of the
740 If set, the libraries phase will be skipped.
742 If set, no object directories will be created.
743 This should only be used if object directories were created in a
744 previous build and no new directories are connected.
745 .It Va NO_PORTSUPDATE
746 If set, the update process does not update the Ports tree as part of the
750 If set, the update process does not update the www tree as part of the
754 If set, the build target
759 and will skip most bootstrap phases.
760 It will only bootstrap libraries and build all of userland.
761 This option should be used only when it is known that none of the bootstrap
762 needs changed and that no new directories have been connected to the build.
765 Builds under directory
767 are influenced by the following
770 .Bl -tag -width ".Va DOC_LANG"
772 If set, restricts the documentation build to the language subdirectories
773 specified as its content.
774 The default action is to build documentation for all languages.
779 target are influenced by the following
782 .Bl -tag -width ".Va MAKE_JUST_KERNELS"
784 Pass the value of this variable to each
786 invocation used to build worlds and kernels.
787 This can be used to enable multiple jobs within a single architecture's build
788 while still building each architecture serially.
789 .It Va MAKE_JUST_KERNELS
790 Only build kernels for each supported architecture.
791 .It Va MAKE_JUST_WORLDS
792 Only build worlds for each supported architecture.
793 .It Va UNIVERSE_TARGET
794 Execute the specified
796 target for each supported architecture instead of the default action of
797 building a world and one or more kernels.
800 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
801 .It Pa /usr/doc/Makefile
802 .It Pa /usr/doc/share/mk/doc.project.mk
803 .It Pa /usr/ports/Mk/bsd.port.mk
804 .It Pa /usr/ports/Mk/bsd.sites.mk
805 .It Pa /usr/share/examples/etc/make.conf
806 .It Pa /usr/src/Makefile
807 .It Pa /usr/src/Makefile.inc1
812 method of updating your system from the latest sources, please see the
817 The following sequence of commands can be used to cross-build the
818 system for the armv6 architecture on an amd64 host:
819 .Bd -literal -offset indent
821 make TARGET_ARCH=armv6 buildworld buildkernel
822 make TARGET_ARCH=armv6 DESTDIR=/clients/arm64 installworld installkernel
842 .An Mike W. Meyer Aq Mt mwm@mired.org
projects / FreeBSD / FreeBSD.git / blob