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 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
44 .Po installed from packages 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.
306 defined so only the kernels for each architecture are built.
312 defined so only the worlds for each architecture are built.
314 Get updated sources as configured in
317 Print a list of supported
321 pairs for world and kernel targets.
323 Execute the same targets as
325 In addition print a summary of all failed targets at the end and
326 exit with an error if there were any.
328 Create a build toolchain for each architecture supported by the build system.
330 Builds and installs a cross-toolchain and sysroot for the given
334 The sysroot contains target library and headers.
335 The target is an alias for
339 The location of the files installed can be controlled with
341 The target location in
344 .Pa ${DESTDIR}/${XDTP}
352 .Pa ${TARGET_ARCH}-freebsd .
358 Installs the files for the
362 Installs autoconf-style symlinks to
363 .Pa ${DESTDIR}/usr/bin
364 pointing into the xdev toolchain in
365 .Pa ${DESTDIR}/${XDTP} .
368 Kernel specific build targets in
371 .Bl -tag -width ".Cm distributekernel"
373 Rebuild the kernel and the kernel modules.
374 The object directory can be changed from the default
381 Install the kernel and the kernel modules to directory
382 .Pa ${DESTDIR}/boot/kernel ,
383 renaming any pre-existing directory with this name to
385 if it contained the currently running kernel.
386 The target directory under
388 may be modified using the
394 .It Cm distributekernel
395 Install the kernel to the directory
396 .Pa ${DISTDIR}/kernel/boot/kernel .
397 This target is used while building a release; see
400 Archive the results of
401 .Cm distributekernel ,
402 placing the results in
404 This target is used while building a release; see
411 .It Cm kernel-toolchain
412 Rebuild the tools needed for kernel compilation.
413 Use this if you did not do a
416 .It Cm reinstallkernel
417 Reinstall the kernel and the kernel modules, overwriting the contents
418 of the target directory.
421 target, the target directory can be specified using the
427 Convenience targets for cleaning up the install destination directory
431 .Bl -tag -width ".Cm delete-old-libs"
433 Print a list of old files and directories in the system.
435 Delete obsolete base system files and directories interactively.
437 .Li -DBATCH_DELETE_OLD_FILES
438 is specified at the command line, the delete operation will be
445 should be set as with
446 .Dq Li "make installworld" .
447 .It Cm delete-old-libs
448 Delete obsolete base system libraries interactively.
449 This target should only be used if no third party software uses these
452 .Li -DBATCH_DELETE_OLD_FILES
453 is specified at the command line, the delete operation will be
460 should be set as with
461 .Dq Li "make installworld" .
464 Variables that influence all builds include:
465 .Bl -tag -width ".Va MAKEOBJDIRPREFIX"
467 Defines a set of debugging flags that will be used to build all userland
476 targets install binaries from the current
479 so that debugging information is retained in the installed binaries.
481 The directory hierarchy prefix where built objects will be installed.
484 defaults to the empty string.
485 .It Va MAKEOBJDIRPREFIX
486 Defines the prefix for directory names in the tree of built objects.
490 This variable should only be set in the environment or
491 .Pa /etc/src-env.conf
497 .It Va WITHOUT_WERROR
498 If defined, compiler warnings will not cause the build to halt,
499 even if the makefile says otherwise.
501 If defined, the build process will run the DTrace CTF conversion
502 tools on built objects.
505 Additionally, builds in
507 are influenced by the following
510 .Bl -tag -width ".Va SUBDIR_OVERRIDE"
512 Overrides which kernel to build and install for the various kernel
517 Overrides the directory in which
519 and any files included by
523 .Pa sys/${ARCH}/conf .
525 If set, the build target
529 .Va NO_KERNELCONFIG ,
532 When set to a value other than
536 is set to the value of
539 If set, this variable supplies a list of additional directories relative to
540 the root of the source tree to build as part of the
543 The directories are built in parallel with each other,
544 and with the base system directories.
547 directive at the beginning of the
549 list to ensure all base system directories are built first.
551 may also be used as needed elsewhere within the list.
553 If set, this variable supplies a list of additional tools that are used by the
558 .It Va LOCAL_LIB_DIRS
559 If set, this variable supplies a list of additional directories relative to
560 the root of the source tree to build as part of the
563 The directories are built in parallel with each other,
564 and with the base system libraries.
567 directive at the beginning of the
569 list to ensure all base system libraries are built first.
571 may also be used as needed elsewhere within the list.
573 If set, this variable supplies a list of additional mtrees relative to the
574 root of the source tree to use as part of the
577 .It Va LOCAL_LEGACY_DIRS
578 If set, this variable supplies a list of additional directories relative to
579 the root of the source tree to build as part of the
582 .It Va LOCAL_BSTOOL_DIRS
583 If set, this variable supplies a list of additional directories relative to
584 the root of the source tree to build as part of the
587 .It Va LOCAL_TOOL_DIRS
588 If set, this variable supplies a list of additional directories relative to
589 the root of the source tree to build as part of the
592 .It Va LOCAL_XTOOL_DIRS
593 If set, this variable supplies a list of additional directories relative to
594 the root of the source tree to build as part of the
598 A list of ports with kernel modules that should be built and installed
604 .Bd -literal -offset indent
605 make PORTS_MODULES=emulators/virtualbox-ose-kmod kernel
608 Specify a file to override the default
610 The src.conf file controls the components to build.
614 Command to use at install time when stripping binaries.
615 Be sure to add any additional tools required to run
620 variable before running the
628 .It Va SUBDIR_OVERRIDE
629 Override the default list of sub-directories and only build the
630 sub-directory named in this variable.
633 then all libraries and includes, and some of the build tools will still build
639 will only build the specified directory as was done historically.
642 it is necesarry to override
644 with any custom directories containing libraries.
645 This allows building a subset of the system in the same way as
647 does using its sysroot handling.
648 This variable can also be useful when debugging failed builds.
649 .Bd -literal -offset indent
650 make some-target SUBDIR_OVERRIDE=foo/bar
653 Specify the location of the kernel source to override the default
655 The kernel source is located in the
657 subdirectory of the source tree checked out from the
661 The target hardware platform.
662 This is analogous to the
665 This is necessary to cross-build some target architectures.
666 For example, cross-building for ARM64 machines requires
667 .Va TARGET_ARCH Ns = Ns Li aarch64
669 .Va TARGET Ns = Ns Li arm64 .
672 defaults to the current hardware platform, unless
674 is also set, in which case it defaults to the appropriate
675 value for that architecture.
677 The target machine processor architecture.
678 This is analogous to the
681 Set this to cross-build for a different architecture.
684 defaults to the current machine architecture, unless
686 is also set, in which case it defaults to the appropriate
687 value for that platform.
688 Typically, one only needs to set
692 Builds under directory
694 are also influenced by defining one or more of the following symbols,
699 .Bl -tag -width ".Va -DNO_KERNELCONFIG"
700 .It Va LOADER_DEFAULT_INTERP
701 Defines what interpreter the default loader program will have.
707 This creates the default link for
709 to the loader with that interpreter.
710 It also determines what interpreter is compiled into
713 If set, the build targets that clean parts of the object tree use the
719 If set, no object tree files are cleaned at all.
720 This is the default when
734 is set no kernel objects are cleaned either.
736 If set, the build process does not run the DTrace CTF conversion tools
739 If set, the build does not descend into the
741 subdirectory (i.e., manual pages, locale data files, timezone data files and
744 files will not be rebuild from their sources).
745 .It Va NO_KERNELCLEAN
746 If set, the build process does not run
751 .It Va NO_KERNELCONFIG
752 If set, the build process does not run
758 If set, the build process does not run
764 If set, the update process does not update the source of the
766 documentation as part of the
770 If set, the libraries phase will be skipped.
772 If set, no object directories will be created.
773 This should only be used if object directories were created in a
774 previous build and no new directories are connected.
775 .It Va NO_PORTSUPDATE
776 If set, the update process does not update the Ports tree as part of the
780 If set, the update process does not update the www tree as part of the
784 If set, the build target
789 and will skip most bootstrap phases.
790 It will only bootstrap libraries and build all of userland.
791 This option should be used only when it is known that none of the bootstrap
792 needs changed and that no new directories have been connected to the build.
795 Builds under directory
797 are influenced by the following
800 .Bl -tag -width ".Va DOC_LANG"
802 If set, restricts the documentation build to the language subdirectories
803 specified as its content.
804 The default action is to build documentation for all languages.
809 and related targets are influenced by the following
812 .Bl -tag -width ".Va MAKE_JUST_KERNELS"
814 Pass the value of this variable to each
816 invocation used to build worlds and kernels.
817 This can be used to enable multiple jobs within a single architecture's build
818 while still building each architecture serially.
819 .It Va MAKE_JUST_KERNELS
820 Only build kernels for each supported architecture.
821 .It Va MAKE_JUST_WORLDS
822 Only build worlds for each supported architecture.
823 .It Va WITHOUT_WORLDS
824 Only build kernels for each supported architecture.
825 .It Va WITHOUT_KERNELS
826 Only build worlds for each supported architecture.
827 .It Va UNIVERSE_TARGET
828 Execute the specified
830 target for each supported architecture instead of the default action of
831 building a world and one or more kernels.
832 This variable implies
833 .Va WITHOUT_KERNELS .
835 Only build the listed targets instead of each supported architecture.
837 In addition to the supported architectures, build the semi-supported
839 A semi-supported architecture has build support in the
841 tree, but receives significantly less testing and is generally for
842 fringe uses that do not have a wide appeal.
845 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
846 .It Pa /usr/doc/Makefile
847 .It Pa /usr/doc/share/mk/doc.project.mk
848 .It Pa /usr/ports/Mk/bsd.port.mk
849 .It Pa /usr/ports/Mk/bsd.sites.mk
850 .It Pa /usr/share/examples/etc/make.conf
851 .It Pa /usr/src/Makefile
852 .It Pa /usr/src/Makefile.inc1
857 method of updating your system from the latest sources, please see the
862 The following sequence of commands can be used to cross-build the
863 system for the armv6 architecture on an amd64 host:
864 .Bd -literal -offset indent
866 make TARGET_ARCH=armv6 buildworld buildkernel
867 make TARGET_ARCH=armv6 DESTDIR=/clients/arm installworld installkernel
872 manpage first appeared in
891 .An Mike W. Meyer Aq Mt mwm@mired.org
projects / FreeBSD / FreeBSD.git / blob