xref: /freebsd/share/man/man7/build.7 (revision 805c3af898a8fed6a92caa069011c0ce7fa542ef)
1786aa69aSBen Smithurst.\" Copyright (c) 2000
2786aa69aSBen Smithurst.\"	Mike W. Meyer
3786aa69aSBen Smithurst.\"
4786aa69aSBen Smithurst.\" Redistribution and use in source and binary forms, with or without
5786aa69aSBen Smithurst.\" modification, are permitted provided that the following conditions
6786aa69aSBen Smithurst.\" are met:
7786aa69aSBen Smithurst.\" 1. Redistributions of source code must retain the above copyright
8786aa69aSBen Smithurst.\"    notice, this list of conditions and the following disclaimer.
9786aa69aSBen Smithurst.\" 2. Redistributions in binary form must reproduce the above copyright
10786aa69aSBen Smithurst.\"    notice, this list of conditions and the following disclaimer in the
11786aa69aSBen Smithurst.\"    documentation and/or other materials provided with the distribution.
12786aa69aSBen Smithurst.\"
13786aa69aSBen Smithurst.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14786aa69aSBen Smithurst.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15786aa69aSBen Smithurst.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16786aa69aSBen Smithurst.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
17786aa69aSBen Smithurst.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18786aa69aSBen Smithurst.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19786aa69aSBen Smithurst.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20786aa69aSBen Smithurst.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21786aa69aSBen Smithurst.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22786aa69aSBen Smithurst.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23786aa69aSBen Smithurst.\" SUCH DAMAGE.
24786aa69aSBen Smithurst.\"
25786aa69aSBen Smithurst.\" $FreeBSD$
26786aa69aSBen Smithurst.\"
27e7a13643SMark Johnston.Dd August 10, 2021
28786aa69aSBen Smithurst.Dt BUILD 7
293d45e180SRuslan Ermilov.Os
30786aa69aSBen Smithurst.Sh NAME
31786aa69aSBen Smithurst.Nm build
32e6ca6901SGordon Bergling.Nd General instructions on how to build the system
33786aa69aSBen Smithurst.Sh DESCRIPTION
347b710ab2SJoseph KoshyThe sources for the
35d003b779SRuslan Ermilov.Fx
367b710ab2SJoseph Koshysystem and its applications are contained in three different directories,
37786aa69aSBen Smithurstnormally
38786aa69aSBen Smithurst.Pa /usr/src ,
39786aa69aSBen Smithurst.Pa /usr/doc ,
40786aa69aSBen Smithurstand
41786aa69aSBen Smithurst.Pa /usr/ports .
4250a994c9SWarren BlockThese directories may be initially empty or non-existent until updated with
43e444a4c6SFernando ApesteguíaGit
44e444a4c6SFernando Apesteguía.Po installed from packages with
45e444a4c6SFernando Apesteguía.Xr pkg 7
46e444a4c6SFernando Apesteguíaor from
47e444a4c6SFernando Apesteguía.Xr ports 7 Pc .
487b710ab2SJoseph KoshyDirectory
49786aa69aSBen Smithurst.Pa /usr/src
50786aa69aSBen Smithurstcontains the
51786aa69aSBen Smithurst.Dq "base system"
52786aa69aSBen Smithurstsources, which is loosely defined as the things required to rebuild
53786aa69aSBen Smithurstthe system to a useful state.
547b710ab2SJoseph KoshyDirectory
55786aa69aSBen Smithurst.Pa /usr/doc
56786aa69aSBen Smithurstcontains the source for the system documentation, excluding the manual
57786aa69aSBen Smithurstpages.
587b710ab2SJoseph KoshyDirectory
59786aa69aSBen Smithurst.Pa /usr/ports
607b710ab2SJoseph Koshycontains a tree that provides a consistent interface for building and
61786aa69aSBen Smithurstinstalling third party applications.
627b710ab2SJoseph KoshyFor more information about the ports build process, see
637b710ab2SJoseph Koshy.Xr ports 7 .
64786aa69aSBen Smithurst.Pp
65786aa69aSBen SmithurstThe
66786aa69aSBen Smithurst.Xr make 1
67786aa69aSBen Smithurstcommand is used in each of these directories to build and install the
681caae057SRuslan Ermilovthings in that directory.
691caae057SRuslan ErmilovIssuing the
701caae057SRuslan Ermilov.Xr make 1
71e6ca6901SGordon Berglingcommand in any directory issues the
72e6ca6901SGordon Bergling.Xr make 1
73e6ca6901SGordon Berglingcommand recursively in all subdirectories.
74e6ca6901SGordon BerglingWith no target specified, the items in the directories are built
75e6ca6901SGordon Berglingand no further action is taken.
767b710ab2SJoseph Koshy.Pp
777b710ab2SJoseph KoshyA source tree is allowed to be read-only.
787b710ab2SJoseph KoshyAs described in
797b710ab2SJoseph Koshy.Xr make 1 ,
807b710ab2SJoseph Koshyobjects are usually built in a separate object directory hierarchy
817b710ab2SJoseph Koshyspecified by the environment variable
827b710ab2SJoseph Koshy.Va MAKEOBJDIRPREFIX ,
837b710ab2SJoseph Koshyor under
847b710ab2SJoseph Koshy.Pa /usr/obj
857b710ab2SJoseph Koshyif variable
867b710ab2SJoseph Koshy.Va MAKEOBJDIRPREFIX
877b710ab2SJoseph Koshyis not set.
88dfa09989SBryan DreweryThe canonical object directory is described in the documentation for the
897b710ab2SJoseph Koshy.Cm buildworld
907b710ab2SJoseph Koshytarget below.
917b710ab2SJoseph Koshy.Pp
927b710ab2SJoseph KoshyThe build may be controlled by defining
937b710ab2SJoseph Koshy.Xr make 1
947b710ab2SJoseph Koshyvariables described in the
957b710ab2SJoseph Koshy.Sx ENVIRONMENT
967b710ab2SJoseph Koshysection below, and by the variables documented in
977b710ab2SJoseph Koshy.Xr make.conf 5 .
987b710ab2SJoseph Koshy.Pp
99e6ca6901SGordon BerglingThe default components included in the build are specified in the file
100e6ca6901SGordon Bergling.Pa /etc/src.conf
101e6ca6901SGordon Berglingin the source tree.
102e6ca6901SGordon BerglingTo override the default file, include the SRCCONF option in the make steps,
103e6ca6901SGordon Berglingpointing to a custom src.conf file.
104e6ca6901SGordon BerglingFor more information see
105e6ca6901SGordon Bergling.Xr src.conf 5 .
106e6ca6901SGordon Bergling.Pp
1077b710ab2SJoseph KoshyThe following list provides the names and actions for the targets
1087b710ab2SJoseph Koshysupported by the build system:
1097b710ab2SJoseph Koshy.Bl -tag -width ".Cm cleandepend"
110aae63957SBryan Drewery.It Cm analyze
111aae63957SBryan DreweryRun Clang static analyzer against all objects and present output on stdout.
11271b7fa12SEnji Cooper.It Cm check
11371b7fa12SEnji CooperRun tests for a given subdirectory.
11471b7fa12SEnji CooperThe default directory used is
11571b7fa12SEnji Cooper.Pa ${.OBJDIR} ,
11671b7fa12SEnji Cooperbut the check directory can be changed with
11771b7fa12SEnji Cooper.Pa ${CHECKDIR} .
11871b7fa12SEnji Cooper.It Cm checkworld
11971b7fa12SEnji CooperRun the
12071b7fa12SEnji Cooper.Fx
12171b7fa12SEnji Coopertest suite on installed world.
1221caae057SRuslan Ermilov.It Cm clean
1237b710ab2SJoseph KoshyRemove any files created during the build process.
1247b710ab2SJoseph Koshy.It Cm cleandepend
125497e8091SBryan DreweryRemove the
126497e8091SBryan Drewery.Pa ${.OBJDIR}/${DEPENDFILE}*
127497e8091SBryan Dreweryfiles generated by prior
128497e8091SBryan Drewery.Dq Li "make"
129497e8091SBryan Dreweryand
1307b710ab2SJoseph Koshy.Dq Li "make depend"
131497e8091SBryan Drewerysteps.
1327b710ab2SJoseph Koshy.It Cm cleandir
1337b710ab2SJoseph KoshyRemove the canonical object directory if it exists, or perform
1347b710ab2SJoseph Koshyactions equivalent to
1357b710ab2SJoseph Koshy.Dq Li "make clean cleandepend"
1367b710ab2SJoseph Koshyif it does not.
1377b710ab2SJoseph KoshyThis target will also remove an
1387b710ab2SJoseph Koshy.Pa obj
1397b710ab2SJoseph Koshylink in
1407b710ab2SJoseph Koshy.Pa ${.CURDIR}
1417b710ab2SJoseph Koshyif that exists.
1427b710ab2SJoseph Koshy.Pp
1437b710ab2SJoseph KoshyIt is advisable to run
1447b710ab2SJoseph Koshy.Dq Li "make cleandir"
1457b710ab2SJoseph Koshytwice: the first invocation will remove the canonical object directory
1467b710ab2SJoseph Koshyand the second one will clean up
1477b710ab2SJoseph Koshy.Pa ${.CURDIR} .
1487b710ab2SJoseph Koshy.It Cm depend
1497b710ab2SJoseph KoshyGenerate a list of build dependencies in file
1507b710ab2SJoseph Koshy.Pa ${.OBJDIR}/${DEPENDFILE} .
151497e8091SBryan DreweryPer-object dependencies are generated at build time and stored in
152497e8091SBryan Drewery.Pa ${.OBJDIR}/${DEPENDFILE}.${OBJ} .
1531caae057SRuslan Ermilov.It Cm install
1547b710ab2SJoseph KoshyInstall the results of the build to the appropriate location in the
1557b710ab2SJoseph Koshyinstallation directory hierarchy specified in variable
1567b710ab2SJoseph Koshy.Va DESTDIR .
1577b710ab2SJoseph Koshy.It Cm obj
1587b710ab2SJoseph KoshyCreate the canonical object directory associated with the current
1597b710ab2SJoseph Koshydirectory.
1607b710ab2SJoseph Koshy.It Cm objlink
1617b710ab2SJoseph KoshyCreate a symbolic link to the canonical object directory in
1627b710ab2SJoseph Koshy.Pa ${.CURDIR} .
1637b710ab2SJoseph Koshy.It Cm tags
1647b710ab2SJoseph KoshyGenerate a tags file using the program specified in the
1657b710ab2SJoseph Koshy.Xr make 1
1667b710ab2SJoseph Koshyvariable
1677b710ab2SJoseph Koshy.Va CTAGS .
1687b710ab2SJoseph KoshyThe build system supports
1697b710ab2SJoseph Koshy.Xr ctags 1
1707b710ab2SJoseph Koshyand
1717b710ab2SJoseph Koshy.Nm "GNU Global" .
1727b710ab2SJoseph Koshy.El
1737b710ab2SJoseph Koshy.Pp
1747b710ab2SJoseph KoshyThe other supported targets under directory
1757b710ab2SJoseph Koshy.Pa /usr/src
1767b710ab2SJoseph Koshyare:
1777b710ab2SJoseph Koshy.Bl -tag -width ".Cm distributeworld"
1787b710ab2SJoseph Koshy.It Cm buildenv
1797b710ab2SJoseph KoshySpawn an interactive shell with environment variables set up for
1804a238795SEd Mastebuilding the system or individual components.
1814a238795SEd MasteFor cross-building the target architecture needs to be specified with
1827b710ab2SJoseph Koshy.Xr make 1
1837b710ab2SJoseph Koshyvariables
1847b710ab2SJoseph Koshy.Va TARGET_ARCH
1857b710ab2SJoseph Koshyand
1867b710ab2SJoseph Koshy.Va TARGET .
1877b710ab2SJoseph Koshy.Pp
1884a238795SEd MasteThis target is only useful after a complete toolchain (including
1894a238795SEd Mastethe compiler, linker, assembler, headers and libraries) has been
1907b710ab2SJoseph Koshybuilt; see the
1917b710ab2SJoseph Koshy.Cm toolchain
1927b710ab2SJoseph Koshytarget below.
1937b710ab2SJoseph Koshy.It Cm buildworld
1947b710ab2SJoseph KoshyBuild everything but the kernel, configure files in
1957b710ab2SJoseph Koshy.Pa etc ,
1967b710ab2SJoseph Koshyand
1977b710ab2SJoseph Koshy.Pa release .
198d90f12e3SWarren BlockThe object directory can be changed from the default
199d90f12e3SWarren Block.Pa /usr/obj
200d90f12e3SWarren Blockby setting the
201d90f12e3SWarren Block.Pa MAKEOBJDIRPREFIX
202d90f12e3SWarren Block.Xr make 1
203d90f12e3SWarren Blockvariable.
204dfa09989SBryan DreweryThe actual build location prefix used
205dfa09989SBryan Drewerydepends on the
206dfa09989SBryan Drewery.Va WITH_UNIFIED_OBJDIR
207dfa09989SBryan Dreweryoption from
208dfa09989SBryan Drewery.Xr src.conf 5 .
209dfa09989SBryan DreweryIf enabled it is
210dfa09989SBryan Drewery.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}/${TARGET}.${TARGET_ARCH}
211dfa09989SBryan Dreweryfor all builds.
212dfa09989SBryan DreweryIf disabled it is
2137b710ab2SJoseph Koshy.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
2147b710ab2SJoseph Koshyfor native builds, and
215dfa09989SBryan Drewery.Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}${.CURDIR}
2167b710ab2SJoseph Koshyfor cross builds and native builds with variable
2177b710ab2SJoseph Koshy.Va CROSS_BUILD_TESTING
2187b710ab2SJoseph Koshyset.
2197b710ab2SJoseph Koshy.It Cm cleanworld
2207b710ab2SJoseph KoshyAttempt to clean up targets built by a preceding
221c10062b9SBryan Drewery.Cm buildworld ,
222c10062b9SBryan Dreweryor similar step built from this source directory.
223c10062b9SBryan Drewery.It Cm cleanuniverse
224c10062b9SBryan DreweryWhen
225c10062b9SBryan Drewery.Va WITH_UNIFIED_OBJDIR
226c10062b9SBryan Dreweryis enabled, attempt to clean up targets built by a preceding
227c10062b9SBryan Drewery.Cm buildworld ,
228c10062b9SBryan Drewery.Cm universe ,
229c10062b9SBryan Dreweryor similar step, for any architecture built from this source directory.
2307b710ab2SJoseph Koshy.It Cm distributeworld
2317b710ab2SJoseph KoshyDistribute everything compiled by a preceding
2327b710ab2SJoseph Koshy.Cm buildworld
2337b710ab2SJoseph Koshystep.
2347b710ab2SJoseph KoshyFiles are placed in the directory hierarchy specified by
2357b710ab2SJoseph Koshy.Xr make 1
2367b710ab2SJoseph Koshyvariable
2377b710ab2SJoseph Koshy.Va DISTDIR .
2387b710ab2SJoseph KoshyThis target is used while building a release; see
2397b710ab2SJoseph Koshy.Xr release 7 .
2407441e255SBryan Drewery.It Cm native-xtools
2417441e255SBryan DreweryThis target builds a cross-toolchain for the given
2427441e255SBryan Drewery.Sy TARGET
2437441e255SBryan Dreweryand
2447441e255SBryan Drewery.Sy TARGET_ARCH ,
2457441e255SBryan Dreweryas well as a select list of static userland tools for the host system.
2467441e255SBryan DreweryThis is intended to be used in a jail where QEMU is used to improve
2477441e255SBryan Dreweryperformance by avoiding emulating binaries that do not need to be emulated.
2487441e255SBryan Drewery.Sy TARGET
2497441e255SBryan Dreweryand
2507441e255SBryan Drewery.Sy TARGET_ARCH
2517441e255SBryan Dreweryshould be defined.
2525bd47cc5SBryan Drewery.It Cm native-xtools-install
2535bd47cc5SBryan DreweryInstalls the results to
2545bd47cc5SBryan Drewery.Pa ${DESTDIR}/${NXTP}
2555bd47cc5SBryan Drewerywhere
2565bd47cc5SBryan Drewery.Va NXTP
2575bd47cc5SBryan Drewerydefaults to
2585bd47cc5SBryan Drewery.Pa nxb-bin .
2595bd47cc5SBryan Drewery.Sy TARGET
2605bd47cc5SBryan Dreweryand
2615bd47cc5SBryan Drewery.Sy TARGET_ARCH
2625bd47cc5SBryan Drewerymust be defined.
263e8423d00SNathan Whitehorn.It Cm packageworld
264e8423d00SNathan WhitehornArchive the results of
265e8423d00SNathan Whitehorn.Cm distributeworld ,
266e8423d00SNathan Whitehornplacing the results in
267e8423d00SNathan Whitehorn.Va DISTDIR .
268e8423d00SNathan WhitehornThis target is used while building a release; see
269e8423d00SNathan Whitehorn.Xr release 7 .
2707b710ab2SJoseph Koshy.It Cm installworld
2717b710ab2SJoseph KoshyInstall everything built by a preceding
2727b710ab2SJoseph Koshy.Cm buildworld
2737b710ab2SJoseph Koshystep into the directory hierarchy pointed to by
2747b710ab2SJoseph Koshy.Xr make 1
2757b710ab2SJoseph Koshyvariable
2767b710ab2SJoseph Koshy.Va DESTDIR .
277a3aed80dSRuslan Ermilov.Pp
27804876cf3SRuslan ErmilovIf installing onto an NFS file system and running
2798ed6451eSRuslan Ermilov.Xr make 1
2808ed6451eSRuslan Ermilovwith the
28104876cf3SRuslan Ermilov.Fl j
28204876cf3SRuslan Ermilovoption, make sure that
283a3aed80dSRuslan Ermilov.Xr rpc.lockd 8
284a3aed80dSRuslan Ermilovis running on both client and server.
285a3aed80dSRuslan ErmilovSee
286a3aed80dSRuslan Ermilov.Xr rc.conf 5
287a3aed80dSRuslan Ermilovon how to make it start at boot time.
2887b710ab2SJoseph Koshy.It Cm toolchain
2897b710ab2SJoseph KoshyCreate the build toolchain needed to build the rest of the system.
2907b710ab2SJoseph KoshyFor cross-architecture builds, this step creates a cross-toolchain.
2917b710ab2SJoseph Koshy.It Cm universe
2924e889921SJohn BaldwinFor each architecture,
2934e889921SJohn Baldwinexecute a
2947b710ab2SJoseph Koshy.Cm buildworld
2954e889921SJohn Baldwinfollowed by a
2967b710ab2SJoseph Koshy.Cm buildkernel
2974e889921SJohn Baldwinfor all kernels for that architecture,
2984e889921SJohn Baldwinincluding
2994e889921SJohn Baldwin.Pa LINT .
3007b710ab2SJoseph KoshyThis command takes a long time.
301e1b9162fSWarner Losh.It Cm kernels
302e1b9162fSWarner LoshLike
303e1b9162fSWarner Losh.Cm universe
304e1b9162fSWarner Loshwith
305e1b9162fSWarner Losh.Va WITHOUT_WORLDS
306e1b9162fSWarner Loshdefined so only the kernels for each architecture are built.
307e1b9162fSWarner Losh.It Cm worlds
308e1b9162fSWarner LoshLike
309e1b9162fSWarner Losh.Cm universe
310e1b9162fSWarner Loshwith
311e1b9162fSWarner Losh.Va WITHOUT_KERNELS
312e1b9162fSWarner Loshdefined so only the worlds for each architecture are built.
313f1d16bd8SBjoern A. Zeeb.It Cm targets
314f1d16bd8SBjoern A. ZeebPrint a list of supported
315f1d16bd8SBjoern A. Zeeb.Va TARGET
316f1d16bd8SBjoern A. Zeeb/
317f1d16bd8SBjoern A. Zeeb.Va TARGET_ARCH
318f1d16bd8SBjoern A. Zeebpairs for world and kernel targets.
319eee8163bSBjoern A. Zeeb.It Cm tinderbox
320eee8163bSBjoern A. ZeebExecute the same targets as
321eee8163bSBjoern A. Zeeb.Cm universe .
322eee8163bSBjoern A. ZeebIn addition print a summary of all failed targets at the end and
323eee8163bSBjoern A. Zeebexit with an error if there were any.
3244e889921SJohn Baldwin.It Cm toolchains
3254e889921SJohn BaldwinCreate a build toolchain for each architecture supported by the build system.
326b135fb6eSBryan Drewery.It Cm xdev
327b135fb6eSBryan DreweryBuilds and installs a cross-toolchain and sysroot for the given
328b135fb6eSBryan Drewery.Sy TARGET
329b135fb6eSBryan Dreweryand
330b135fb6eSBryan Drewery.Sy TARGET_ARCH .
331b135fb6eSBryan DreweryThe sysroot contains target library and headers.
332b135fb6eSBryan DreweryThe target is an alias for
333b135fb6eSBryan Drewery.Cm xdev-build
334b135fb6eSBryan Dreweryand
335b135fb6eSBryan Drewery.Cm xdev-install .
336b135fb6eSBryan DreweryThe location of the files installed can be controlled with
337b135fb6eSBryan Drewery.Va DESTDIR .
338b135fb6eSBryan DreweryThe target location in
339b135fb6eSBryan Drewery.Va DESTDIR
340b135fb6eSBryan Dreweryis
341b135fb6eSBryan Drewery.Pa ${DESTDIR}/${XDTP}
342b135fb6eSBryan Drewerywhere
343b135fb6eSBryan Drewery.Va XDTP
344b135fb6eSBryan Drewerydefaults to
345b135fb6eSBryan Drewery.Pa /usr/${XDDIR}
346b135fb6eSBryan Dreweryand
347b135fb6eSBryan Drewery.Va XDDIR
348b135fb6eSBryan Drewerydefaults to
349b135fb6eSBryan Drewery.Pa ${TARGET_ARCH}-freebsd .
350b135fb6eSBryan Drewery.It Cm xdev-build
351b135fb6eSBryan DreweryBuilds for the
352b135fb6eSBryan Drewery.Cm xdev
353b135fb6eSBryan Drewerytarget.
354b135fb6eSBryan Drewery.It Cm xdev-install
355b135fb6eSBryan DreweryInstalls the files for the
356b135fb6eSBryan Drewery.Cm xdev
357b135fb6eSBryan Drewerytarget.
358b135fb6eSBryan Drewery.It Cm xdev-links
359b135fb6eSBryan DreweryInstalls autoconf-style symlinks to
360b135fb6eSBryan Drewery.Pa ${DESTDIR}/usr/bin
361b135fb6eSBryan Drewerypointing into the xdev toolchain in
362b135fb6eSBryan Drewery.Pa ${DESTDIR}/${XDTP} .
363786aa69aSBen Smithurst.El
364786aa69aSBen Smithurst.Pp
3657b710ab2SJoseph KoshyKernel specific build targets in
366786aa69aSBen Smithurst.Pa /usr/src
3677b710ab2SJoseph Koshyare:
368e8423d00SNathan Whitehorn.Bl -tag -width ".Cm distributekernel"
3691caae057SRuslan Ermilov.It Cm buildkernel
3701caae057SRuslan ErmilovRebuild the kernel and the kernel modules.
371d90f12e3SWarren BlockThe object directory can be changed from the default
372d90f12e3SWarren Block.Pa /usr/obj
373d90f12e3SWarren Blockby setting the
374d90f12e3SWarren Block.Pa MAKEOBJDIRPREFIX
375d90f12e3SWarren Block.Xr make 1
376d90f12e3SWarren Blockvariable.
3771caae057SRuslan Ermilov.It Cm installkernel
3787b710ab2SJoseph KoshyInstall the kernel and the kernel modules to directory
3797b710ab2SJoseph Koshy.Pa ${DESTDIR}/boot/kernel ,
3807b710ab2SJoseph Koshyrenaming any pre-existing directory with this name to
3817b710ab2SJoseph Koshy.Pa kernel.old
3827b710ab2SJoseph Koshyif it contained the currently running kernel.
3837b710ab2SJoseph KoshyThe target directory under
3847b710ab2SJoseph Koshy.Pa ${DESTDIR}
3857b710ab2SJoseph Koshymay be modified using the
3867b710ab2SJoseph Koshy.Va INSTKERNNAME
3877b710ab2SJoseph Koshyand
3887b710ab2SJoseph Koshy.Va KODIR
3897b710ab2SJoseph Koshy.Xr make 1
3907b710ab2SJoseph Koshyvariables.
391e8423d00SNathan Whitehorn.It Cm distributekernel
392e8423d00SNathan WhitehornInstall the kernel to the directory
393e8423d00SNathan Whitehorn.Pa ${DISTDIR}/kernel/boot/kernel .
394e8423d00SNathan WhitehornThis target is used while building a release; see
395e8423d00SNathan Whitehorn.Xr release 7 .
396e8423d00SNathan Whitehorn.It Cm packagekernel
397e8423d00SNathan WhitehornArchive the results of
398e8423d00SNathan Whitehorn.Cm distributekernel ,
399e8423d00SNathan Whitehornplacing the results in
400e8423d00SNathan Whitehorn.Va DISTDIR .
401e8423d00SNathan WhitehornThis target is used while building a release; see
402e8423d00SNathan Whitehorn.Xr release 7 .
403389e98a7STom Rhodes.It Cm kernel
404389e98a7STom RhodesEquivalent to
405389e98a7STom Rhodes.Cm buildkernel
406389e98a7STom Rhodesfollowed by
407389e98a7STom Rhodes.Cm installkernel
4087b710ab2SJoseph Koshy.It Cm kernel-toolchain
4097b710ab2SJoseph KoshyRebuild the tools needed for kernel compilation.
4107b710ab2SJoseph KoshyUse this if you did not do a
4117b710ab2SJoseph Koshy.Cm buildworld
4127b710ab2SJoseph Koshyfirst.
4137b710ab2SJoseph Koshy.It Cm reinstallkernel
4147b710ab2SJoseph KoshyReinstall the kernel and the kernel modules, overwriting the contents
4157b710ab2SJoseph Koshyof the target directory.
4167b710ab2SJoseph KoshyAs with the
4177b710ab2SJoseph Koshy.Cm installkernel
4187b710ab2SJoseph Koshytarget, the target directory can be specified using the
4197b710ab2SJoseph Koshy.Xr make 1
4207b710ab2SJoseph Koshyvariable
4217b710ab2SJoseph Koshy.Va INSTKERNNAME .
4227b710ab2SJoseph Koshy.El
4237b710ab2SJoseph Koshy.Pp
4247b710ab2SJoseph KoshyConvenience targets for cleaning up the install destination directory
4257b710ab2SJoseph Koshydenoted by variable
4267b710ab2SJoseph Koshy.Va DESTDIR
4277b710ab2SJoseph Koshyinclude:
4287b710ab2SJoseph Koshy.Bl -tag -width ".Cm delete-old-libs"
4297b710ab2SJoseph Koshy.It Cm check-old
430abfabbeaSMike PritchardPrint a list of old files and directories in the system.
431e2a36081SAlexander Leidinger.It Cm delete-old
432e2a36081SAlexander LeidingerDelete obsolete base system files and directories interactively.
43378ad5421SRuslan ErmilovWhen
43478ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES
4357b710ab2SJoseph Koshyis specified at the command line, the delete operation will be
4367b710ab2SJoseph Koshynon-interactive.
437c8ef0ed5SRuslan ErmilovThe variables
4387b710ab2SJoseph Koshy.Va DESTDIR ,
4397b710ab2SJoseph Koshy.Va TARGET_ARCH
440c8ef0ed5SRuslan Ermilovand
441c8ef0ed5SRuslan Ermilov.Va TARGET
442c8ef0ed5SRuslan Ermilovshould be set as with
443c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" .
444e2a36081SAlexander Leidinger.It Cm delete-old-libs
445e2a36081SAlexander LeidingerDelete obsolete base system libraries interactively.
446d90f12e3SWarren BlockThis target should only be used if no third party software uses these
4477b710ab2SJoseph Koshylibraries.
44878ad5421SRuslan ErmilovWhen
44978ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES
4507b710ab2SJoseph Koshyis specified at the command line, the delete operation will be
4517b710ab2SJoseph Koshynon-interactive.
452c8ef0ed5SRuslan ErmilovThe variables
4537b710ab2SJoseph Koshy.Va DESTDIR ,
4547b710ab2SJoseph Koshy.Va TARGET_ARCH
455c8ef0ed5SRuslan Ermilovand
456c8ef0ed5SRuslan Ermilov.Va TARGET
457c8ef0ed5SRuslan Ermilovshould be set as with
458c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" .
459786aa69aSBen Smithurst.El
460b82e53e2SMurray Stokely.Sh ENVIRONMENT
4617b710ab2SJoseph KoshyVariables that influence all builds include:
4627b710ab2SJoseph Koshy.Bl -tag -width ".Va MAKEOBJDIRPREFIX"
463fea87c03SGiorgos Keramidas.It Va DEBUG_FLAGS
464fea87c03SGiorgos KeramidasDefines a set of debugging flags that will be used to build all userland
465fea87c03SGiorgos Keramidasbinaries under
466fea87c03SGiorgos Keramidas.Pa /usr/src .
467fea87c03SGiorgos KeramidasWhen
468fea87c03SGiorgos Keramidas.Va DEBUG_FLAGS
469fea87c03SGiorgos Keramidasis defined, the
470fea87c03SGiorgos Keramidas.Cm install
471fea87c03SGiorgos Keramidasand
472fea87c03SGiorgos Keramidas.Cm installworld
473fea87c03SGiorgos Keramidastargets install binaries from the current
474fea87c03SGiorgos Keramidas.Va MAKEOBJDIRPREFIX
475fea87c03SGiorgos Keramidaswithout stripping,
476fea87c03SGiorgos Keramidasso that debugging information is retained in the installed binaries.
4777b710ab2SJoseph Koshy.It Va DESTDIR
4787b710ab2SJoseph KoshyThe directory hierarchy prefix where built objects will be installed.
4797b710ab2SJoseph KoshyIf not set,
4807b710ab2SJoseph Koshy.Va DESTDIR
4817b710ab2SJoseph Koshydefaults to the empty string.
4827b710ab2SJoseph Koshy.It Va MAKEOBJDIRPREFIX
4837b710ab2SJoseph KoshyDefines the prefix for directory names in the tree of built objects.
4847b710ab2SJoseph KoshyDefaults to
4857b710ab2SJoseph Koshy.Pa /usr/obj
4867b710ab2SJoseph Koshyif not defined.
487dfa09989SBryan DreweryThis variable should only be set in the environment or
488dfa09989SBryan Drewery.Pa /etc/src-env.conf
489dfa09989SBryan Dreweryand not via
4907b710ab2SJoseph Koshy.Pa /etc/make.conf
491dfa09989SBryan Dreweryor
492dfa09989SBryan Drewery.Pa /etc/src.conf
4937b710ab2SJoseph Koshyor the command line.
4947fa2f2a6SAlex Richardson.It Va WITHOUT_WERROR
4957b710ab2SJoseph KoshyIf defined, compiler warnings will not cause the build to halt,
4967b710ab2SJoseph Koshyeven if the makefile says otherwise.
49721edb039SAlexander Leidinger.It Va WITH_CTF
49821edb039SAlexander LeidingerIf defined, the build process will run the DTrace CTF conversion
49921edb039SAlexander Leidingertools on built objects.
5007b710ab2SJoseph Koshy.El
5017b710ab2SJoseph Koshy.Pp
5027b710ab2SJoseph KoshyAdditionally, builds in
5037b710ab2SJoseph Koshy.Pa /usr/src
5047b710ab2SJoseph Koshyare influenced by the following
5057b710ab2SJoseph Koshy.Xr make 1
5067b710ab2SJoseph Koshyvariables:
5077b710ab2SJoseph Koshy.Bl -tag -width ".Va SUBDIR_OVERRIDE"
508e6cdeeddSWarner Losh.It Va KERNCONF
509e6cdeeddSWarner LoshOverrides which kernel to build and install for the various kernel
510e6cdeeddSWarner Loshmake targets.
511e6cdeeddSWarner LoshIt defaults to
512e6cdeeddSWarner Losh.Cm GENERIC .
5134b2cc4d1SKyle Evans.It Va KERNCONFDIR
5144b2cc4d1SKyle EvansOverrides the directory in which
5154b2cc4d1SKyle Evans.Va KERNCONF
5164b2cc4d1SKyle Evansand any files included by
5174b2cc4d1SKyle Evans.Va KERNCONF
5184b2cc4d1SKyle Evansshould be found.
5194b2cc4d1SKyle EvansDefaults to
5204b2cc4d1SKyle Evans.Pa sys/${ARCH}/conf .
521e6cdeeddSWarner Losh.It Va KERNFAST
522e6cdeeddSWarner LoshIf set, the build target
523e6cdeeddSWarner Losh.Cm buildkernel
524e6cdeeddSWarner Loshdefaults to setting
525e6cdeeddSWarner Losh.Va NO_KERNELCLEAN ,
5266d50d5e4SWarner Losh.Va NO_KERNELCONFIG ,
527e6cdeeddSWarner Loshand
5286d50d5e4SWarner Losh.Va NO_KERNELOBJ .
529e6cdeeddSWarner LoshWhen set to a value other than
530e6cdeeddSWarner Losh.Cm 1
531e6cdeeddSWarner Loshthen
532e6cdeeddSWarner Losh.Va KERNCONF
533e6cdeeddSWarner Loshis set to the value of
534e6cdeeddSWarner Losh.Va KERNFAST .
5357b710ab2SJoseph Koshy.It Va LOCAL_DIRS
536ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
537ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
538ca6a54ceSBryan Drewery.Cm everything
539ca6a54ceSBryan Drewerytarget.
540e93e5bb0SIan LeporeThe directories are built in parallel with each other,
541e93e5bb0SIan Leporeand with the base system directories.
542e93e5bb0SIan LeporeInsert a
543e93e5bb0SIan Lepore.Va .WAIT
544e93e5bb0SIan Leporedirective at the beginning of the
545e93e5bb0SIan Lepore.Va LOCAL_DIRS
546e93e5bb0SIan Leporelist to ensure all base system directories are built first.
547e93e5bb0SIan Lepore.Va .WAIT
548e93e5bb0SIan Leporemay also be used as needed elsewhere within the list.
549a0e6a013SBryan Drewery.It Va LOCAL_ITOOLS
550a0e6a013SBryan DreweryIf set, this variable supplies a list of additional tools that are used by the
551a0e6a013SBryan Drewery.Cm installworld
552a0e6a013SBryan Dreweryand
553a0e6a013SBryan Drewery.Cm distributeworld
554a0e6a013SBryan Drewerytargets.
555ca6a54ceSBryan Drewery.It Va LOCAL_LIB_DIRS
556ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
557ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
558ca6a54ceSBryan Drewery.Cm libraries
559ca6a54ceSBryan Drewerytarget.
560e93e5bb0SIan LeporeThe directories are built in parallel with each other,
561e93e5bb0SIan Leporeand with the base system libraries.
562e93e5bb0SIan LeporeInsert a
563e93e5bb0SIan Lepore.Va .WAIT
564e93e5bb0SIan Leporedirective at the beginning of the
565e93e5bb0SIan Lepore.Va LOCAL_DIRS
566e93e5bb0SIan Leporelist to ensure all base system libraries are built first.
567e93e5bb0SIan Lepore.Va .WAIT
568e93e5bb0SIan Leporemay also be used as needed elsewhere within the list.
569ca6a54ceSBryan Drewery.It Va LOCAL_MTREE
570ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional mtrees relative to the
571ca6a54ceSBryan Dreweryroot of the source tree to use as part of the
572ca6a54ceSBryan Drewery.Cm hierarchy
573ca6a54ceSBryan Drewerytarget.
57480cedb80SBryan Drewery.It Va LOCAL_LEGACY_DIRS
57580cedb80SBryan DreweryIf set, this variable supplies a list of additional directories relative to
57680cedb80SBryan Drewerythe root of the source tree to build as part of the
57780cedb80SBryan Drewery.Cm legacy
57880cedb80SBryan Drewerytarget.
57980cedb80SBryan Drewery.It Va LOCAL_BSTOOL_DIRS
58080cedb80SBryan DreweryIf set, this variable supplies a list of additional directories relative to
58180cedb80SBryan Drewerythe root of the source tree to build as part of the
58280cedb80SBryan Drewery.Cm bootstrap-tools
58380cedb80SBryan Drewerytarget.
584ca6a54ceSBryan Drewery.It Va LOCAL_TOOL_DIRS
585ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
586ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
587ca6a54ceSBryan Drewery.Cm build-tools
588ca6a54ceSBryan Drewerytarget.
5894143850bSBryan Drewery.It Va LOCAL_XTOOL_DIRS
5904143850bSBryan DreweryIf set, this variable supplies a list of additional directories relative to
5914143850bSBryan Drewerythe root of the source tree to build as part of the
5924143850bSBryan Drewery.Cm cross-tools
5934143850bSBryan Drewerytarget.
594170c2788SGlen Barber.It Va PORTS_MODULES
595170c2788SGlen BarberA list of ports with kernel modules that should be built and installed
596170c2788SGlen Barberas part of the
597170c2788SGlen Barber.Cm buildkernel
598170c2788SGlen Barberand
599170c2788SGlen Barber.Cm installkernel
600170c2788SGlen Barberprocess.
601170c2788SGlen Barber.Bd -literal -offset indent
6027fbc0c98SMitchell Hornemake PORTS_MODULES=emulators/virtualbox-ose-kmod kernel
603170c2788SGlen Barber.Ed
604e7a13643SMark Johnston.It Va LOCAL_MODULES
605e7a13643SMark JohnstonA list of external kernel modules that should be built and installed
606e7a13643SMark Johnstonas part of the
607e7a13643SMark Johnston.Cm buildkernel
608e7a13643SMark Johnstonand
609e7a13643SMark Johnston.Cm installkernel
610e7a13643SMark Johnstonprocess.
611*805c3af8SMark JohnstonDefaults to the list of sub-directories of
612*805c3af8SMark Johnston.Va LOCAL_MODULES_DIR .
613e7a13643SMark Johnston.It Va LOCAL_MODULES_DIR
614e7a13643SMark JohnstonThe directory in which to search for the kernel modules specified by
615e7a13643SMark Johnston.Va LOCAL_MODULES .
616e7a13643SMark JohnstonEach kernel module should consist of a directory containing a makefile.
617e7a13643SMark JohnstonDefaults to
618e7a13643SMark Johnston.Pa ${LOCALBASE}/sys/modules .
619e6ca6901SGordon Bergling.It Va SRCCONF
620e6ca6901SGordon BerglingSpecify a file to override the default
621e6ca6901SGordon Bergling.Pa /etc/src.conf .
622e6ca6901SGordon BerglingThe src.conf file controls the components to build.
623e6ca6901SGordon BerglingSee
624e6ca6901SGordon Bergling.Xr src.conf 5
62542e7be20SEnji Cooper.It Va STRIPBIN
6263547290fSEnji CooperCommand to use at install time when stripping binaries.
6273547290fSEnji CooperBe sure to add any additional tools required to run
62842e7be20SEnji Cooper.Va STRIPBIN
6293547290fSEnji Cooperto the
6303547290fSEnji Cooper.Va LOCAL_ITOOLS
6313547290fSEnji Cooper.Xr make 1
6323547290fSEnji Coopervariable before running the
6333547290fSEnji Cooper.Cm distributeworld
6343547290fSEnji Cooperor
6353547290fSEnji Cooper.Cm installworld
6363547290fSEnji Coopertargets.
6373547290fSEnji CooperSee
6383547290fSEnji Cooper.Xr install 1
6393547290fSEnji Cooperfor more details.
6407b710ab2SJoseph Koshy.It Va SUBDIR_OVERRIDE
6417b710ab2SJoseph KoshyOverride the default list of sub-directories and only build the
6427b710ab2SJoseph Koshysub-directory named in this variable.
6437f1636b7SBryan DreweryIf combined with
6447f1636b7SBryan Drewery.Cm buildworld
6457f1636b7SBryan Drewerythen all libraries and includes, and some of the build tools will still build
6467f1636b7SBryan Dreweryas well.
647c889d480SBryan DrewerySpecifying
648c889d480SBryan Drewery.Cm -DNO_LIBS ,
649c889d480SBryan Dreweryand
650c889d480SBryan Drewery.Cm -DWORLDFAST
651c889d480SBryan Drewerywill only build the specified directory as was done historically.
6527f1636b7SBryan DreweryWhen combined with
6537f1636b7SBryan Drewery.Cm buildworld
6547f1636b7SBryan Dreweryit is necesarry to override
6557f1636b7SBryan Drewery.Va LOCAL_LIB_DIRS
6567f1636b7SBryan Drewerywith any custom directories containing libraries.
6577f1636b7SBryan DreweryThis allows building a subset of the system in the same way as
6587f1636b7SBryan Drewery.Cm buildworld
6597f1636b7SBryan Drewerydoes using its sysroot handling.
6607f1636b7SBryan DreweryThis variable can also be useful when debugging failed builds.
6617b710ab2SJoseph Koshy.Bd -literal -offset indent
6627b710ab2SJoseph Koshymake some-target SUBDIR_OVERRIDE=foo/bar
6637b710ab2SJoseph Koshy.Ed
664def657b8SWarner Losh.It Va SYSDIR
665def657b8SWarner LoshSpecify the location of the kernel source to override the default
666def657b8SWarner Losh.Pa /usr/src/sys .
667def657b8SWarner LoshThe kernel source is located in the
668def657b8SWarner Losh.Pa sys
669def657b8SWarner Loshsubdirectory of the source tree checked out from the
670def657b8SWarner Losh.Pa src.git
671def657b8SWarner Loshrepository.
6726f9ac6feSMurray Stokely.It Va TARGET
673b3a43ea3SMurray StokelyThe target hardware platform.
674365a17c0SMurray StokelyThis is analogous to the
6751caae057SRuslan Ermilov.Dq Nm uname Fl m
676b3a43ea3SMurray Stokelyoutput.
677b3a43ea3SMurray StokelyThis is necessary to cross-build some target architectures.
6782f6a7e42SEnji CooperFor example, cross-building for ARM64 machines requires
6792f6a7e42SEnji Cooper.Va TARGET_ARCH Ns = Ns Li aarch64
680b3a43ea3SMurray Stokelyand
6812f6a7e42SEnji Cooper.Va TARGET Ns = Ns Li arm64 .
6827b710ab2SJoseph KoshyIf not set,
6837b710ab2SJoseph Koshy.Va TARGET
684f4721165SEdward Tomasz Napieraladefaults to the current hardware platform, unless
685f4721165SEdward Tomasz Napierala.Va TARGET_ARCH
686f4721165SEdward Tomasz Napieralais also set, in which case it defaults to the appropriate
687f4721165SEdward Tomasz Napieralavalue for that architecture.
6887b710ab2SJoseph Koshy.It Va TARGET_ARCH
6897b710ab2SJoseph KoshyThe target machine processor architecture.
6907b710ab2SJoseph KoshyThis is analogous to the
6917b710ab2SJoseph Koshy.Dq Nm uname Fl p
6927b710ab2SJoseph Koshyoutput.
6937b710ab2SJoseph KoshySet this to cross-build for a different architecture.
6947b710ab2SJoseph KoshyIf not set,
6957b710ab2SJoseph Koshy.Va TARGET_ARCH
696531b260aSWarner Loshdefaults to the current machine architecture, unless
697531b260aSWarner Losh.Va TARGET
698531b260aSWarner Loshis also set, in which case it defaults to the appropriate
699531b260aSWarner Loshvalue for that platform.
700c22c7f86SWarner LoshTypically, one only needs to set
701c22c7f86SWarner Losh.Va TARGET .
7027b710ab2SJoseph Koshy.El
7037b710ab2SJoseph Koshy.Pp
7047b710ab2SJoseph KoshyBuilds under directory
705fd23b461SGiorgos Keramidas.Pa /usr/src
7067d6af40dSGlen Barberare also influenced by defining one or more of the following symbols,
707fd23b461SGiorgos Keramidasusing the
708fd23b461SGiorgos Keramidas.Fl D
709fd23b461SGiorgos Keramidasoption of
710fd23b461SGiorgos Keramidas.Xr make 1 :
711497e8091SBryan Drewery.Bl -tag -width ".Va -DNO_KERNELCONFIG"
71201012c64SWarner Losh.It Va LOADER_DEFAULT_INTERP
71301012c64SWarner LoshDefines what interpreter the default loader program will have.
71401012c64SWarner LoshValid values include
71501012c64SWarner Losh.Dq 4th ,
71601012c64SWarner Losh.Dq lua ,
71701012c64SWarner Loshand
71801012c64SWarner Losh.Dq simp .
71901012c64SWarner LoshThis creates the default link for
72001012c64SWarner Losh.Pa /boot/loader
72101012c64SWarner Loshto the loader with that interpreter.
72201012c64SWarner LoshIt also determines what interpreter is compiled into
72301012c64SWarner Losh.Pa userboot .
724fd23b461SGiorgos Keramidas.It Va NO_CLEANDIR
725fd23b461SGiorgos KeramidasIf set, the build targets that clean parts of the object tree use the
726fd23b461SGiorgos Keramidasequivalent of
727fd23b461SGiorgos Keramidas.Dq make clean
728fd23b461SGiorgos Keramidasinstead of
729fd23b461SGiorgos Keramidas.Dq make cleandir .
730fd23b461SGiorgos Keramidas.It Va NO_CLEAN
731fd23b461SGiorgos KeramidasIf set, no object tree files are cleaned at all.
732473fda75SBryan DreweryThis is the default when
733473fda75SBryan Drewery.Va WITH_META_MODE
734473fda75SBryan Dreweryis used with
735473fda75SBryan Drewery.Xr filemon 4
736473fda75SBryan Dreweryloaded.
737473fda75SBryan DrewerySee
738473fda75SBryan Drewery.Xr src.conf 5
739473fda75SBryan Dreweryfor more details.
740fd23b461SGiorgos KeramidasSetting
741fd23b461SGiorgos Keramidas.Va NO_CLEAN
742fd23b461SGiorgos Keramidasimplies
743fd23b461SGiorgos Keramidas.Va NO_KERNELCLEAN ,
744fd23b461SGiorgos Keramidasso when
745fd23b461SGiorgos Keramidas.Va NO_CLEAN
746fd23b461SGiorgos Keramidasis set no kernel objects are cleaned either.
747fd23b461SGiorgos Keramidas.It Va NO_CTF
748fd23b461SGiorgos KeramidasIf set, the build process does not run the DTrace CTF conversion tools
749fd23b461SGiorgos Keramidason built objects.
750fd23b461SGiorgos Keramidas.It Va NO_SHARE
751fd23b461SGiorgos KeramidasIf set, the build does not descend into the
752fd23b461SGiorgos Keramidas.Pa /usr/src/share
753d90f12e3SWarren Blocksubdirectory (i.e., manual pages, locale data files, timezone data files and
754fd23b461SGiorgos Keramidasother
755fd23b461SGiorgos Keramidas.Pa /usr/src/share
756fd23b461SGiorgos Keramidasfiles will not be rebuild from their sources).
757fd23b461SGiorgos Keramidas.It Va NO_KERNELCLEAN
758fd23b461SGiorgos KeramidasIf set, the build process does not run
759fd23b461SGiorgos Keramidas.Dq make clean
760fd23b461SGiorgos Keramidasas part of the
761fd23b461SGiorgos Keramidas.Cm buildkernel
762fd23b461SGiorgos Keramidastarget.
763fd23b461SGiorgos Keramidas.It Va NO_KERNELCONFIG
764fd23b461SGiorgos KeramidasIf set, the build process does not run
765fd23b461SGiorgos Keramidas.Xr config 8
766fd23b461SGiorgos Keramidasas part of the
767fd23b461SGiorgos Keramidas.Cm buildkernel
768fd23b461SGiorgos Keramidastarget.
7696d50d5e4SWarner Losh.It Va NO_KERNELOBJ
7706d50d5e4SWarner LoshIf set, the build process does not run
7716d50d5e4SWarner Losh.Dq make obj
7726d50d5e4SWarner Loshas part of the
7736d50d5e4SWarner Losh.Cm buildkernel
7746d50d5e4SWarner Loshtarget.
775c596c287SBryan Drewery.It Va NO_LIBS
776c596c287SBryan DreweryIf set, the libraries phase will be skipped.
7772abeba9dSBryan Drewery.It Va NO_OBJWALK
7786d75a7a8SBryan DreweryIf set, no object directories will be created.
7796d75a7a8SBryan DreweryThis should only be used if object directories were created in a
7806d75a7a8SBryan Dreweryprevious build and no new directories are connected.
78116892c77SBryan Drewery.It Va WORLDFAST
78216892c77SBryan DreweryIf set, the build target
78316892c77SBryan Drewery.Cm buildworld
78416892c77SBryan Drewerydefaults to setting
78516892c77SBryan Drewery.Va NO_CLEAN ,
7862abeba9dSBryan Drewery.Va NO_OBJWALK ,
78716892c77SBryan Dreweryand will skip most bootstrap phases.
78816892c77SBryan DreweryIt will only bootstrap libraries and build all of userland.
78916892c77SBryan DreweryThis option should be used only when it is known that none of the bootstrap
79016892c77SBryan Dreweryneeds changed and that no new directories have been connected to the build.
791fd23b461SGiorgos Keramidas.El
792fd23b461SGiorgos Keramidas.Pp
793fd23b461SGiorgos KeramidasBuilds under directory
7947b710ab2SJoseph Koshy.Pa /usr/doc
7957b710ab2SJoseph Koshyare influenced by the following
7967b710ab2SJoseph Koshy.Xr make 1
7977b710ab2SJoseph Koshyvariables:
7987b710ab2SJoseph Koshy.Bl -tag -width ".Va DOC_LANG"
7997b710ab2SJoseph Koshy.It Va DOC_LANG
8007b710ab2SJoseph KoshyIf set, restricts the documentation build to the language subdirectories
8017b710ab2SJoseph Koshyspecified as its content.
8027b710ab2SJoseph KoshyThe default action is to build documentation for all languages.
803b82e53e2SMurray Stokely.El
8044e889921SJohn Baldwin.Pp
8054e889921SJohn BaldwinBuilds using the
8064e889921SJohn Baldwin.Cm universe
807e1b9162fSWarner Loshand related targets are influenced by the following
8084e889921SJohn Baldwin.Xr make 1
8094e889921SJohn Baldwinvariables:
8104e889921SJohn Baldwin.Bl -tag -width ".Va MAKE_JUST_KERNELS"
8114e889921SJohn Baldwin.It Va JFLAG
8124e889921SJohn BaldwinPass the value of this variable to each
8134e889921SJohn Baldwin.Xr make 1
8144e889921SJohn Baldwininvocation used to build worlds and kernels.
8154e889921SJohn BaldwinThis can be used to enable multiple jobs within a single architecture's build
8164e889921SJohn Baldwinwhile still building each architecture serially.
8174e889921SJohn Baldwin.It Va MAKE_JUST_KERNELS
8184e889921SJohn BaldwinOnly build kernels for each supported architecture.
8194e889921SJohn Baldwin.It Va MAKE_JUST_WORLDS
8204e889921SJohn BaldwinOnly build worlds for each supported architecture.
821a7783b5aSWarner Losh.It Va WITHOUT_WORLDS
822a7783b5aSWarner LoshOnly build kernels for each supported architecture.
823a7783b5aSWarner Losh.It Va WITHOUT_KERNELS
824a7783b5aSWarner LoshOnly build worlds for each supported architecture.
8254e889921SJohn Baldwin.It Va UNIVERSE_TARGET
8264e889921SJohn BaldwinExecute the specified
8274e889921SJohn Baldwin.Xr make 1
8284e889921SJohn Baldwintarget for each supported architecture instead of the default action of
8294e889921SJohn Baldwinbuilding a world and one or more kernels.
830a7783b5aSWarner LoshThis variable implies
831a7783b5aSWarner Losh.Va WITHOUT_KERNELS .
832e1b9162fSWarner Losh.It Va TARGETS
833e1b9162fSWarner LoshOnly build the listed targets instead of each supported architecture.
834e1b9162fSWarner Losh.It Va EXTRA_TARGETS
835e1b9162fSWarner LoshIn addition to the supported architectures, build the semi-supported
836e1b9162fSWarner Losharchitectures.
837e1b9162fSWarner LoshA semi-supported architecture has build support in the
838e1b9162fSWarner Losh.Fx
839e1b9162fSWarner Loshtree, but receives significantly less testing and is generally for
840e1b9162fSWarner Loshfringe uses that do not have a wide appeal.
8414e889921SJohn Baldwin.El
842786aa69aSBen Smithurst.Sh FILES
8430c0eb9beSRuslan Ermilov.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
844786aa69aSBen Smithurst.It Pa /usr/doc/Makefile
845786aa69aSBen Smithurst.It Pa /usr/doc/share/mk/doc.project.mk
846786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.port.mk
847786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.sites.mk
8481caae057SRuslan Ermilov.It Pa /usr/share/examples/etc/make.conf
8490c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile
8500c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile.inc1
8513136363fSRuslan Ermilov.El
8523faf5fc9SBen Smithurst.Sh EXAMPLES
853be6a4760SRuslan ErmilovFor an
8543faf5fc9SBen Smithurst.Dq approved
8557b710ab2SJoseph Koshymethod of updating your system from the latest sources, please see the
856be6a4760SRuslan Ermilov.Sx COMMON ITEMS
857be6a4760SRuslan Ermilovsection in
858be6a4760SRuslan Ermilov.Pa src/UPDATING .
859b82e53e2SMurray Stokely.Pp
860b82e53e2SMurray StokelyThe following sequence of commands can be used to cross-build the
861f4721165SEdward Tomasz Napieralasystem for the armv6 architecture on an amd64 host:
862b82e53e2SMurray Stokely.Bd -literal -offset indent
863b82e53e2SMurray Stokelycd /usr/src
864f4721165SEdward Tomasz Napieralamake TARGET_ARCH=armv6 buildworld buildkernel
865ecc0f5f6SEdward Tomasz Napieralamake TARGET_ARCH=armv6 DESTDIR=/clients/arm installworld installkernel
866b82e53e2SMurray Stokely.Ed
86759e11f39SBenedict Reuschling.Sh HISTORY
86859e11f39SBenedict ReuschlingThe
86959e11f39SBenedict Reuschling.Nm
87059e11f39SBenedict Reuschlingmanpage first appeared in
87159e11f39SBenedict Reuschling.Fx 4.3 .
872786aa69aSBen Smithurst.Sh SEE ALSO
8737c20a493SBen Smithurst.Xr cc 1 ,
874786aa69aSBen Smithurst.Xr install 1 ,
875786aa69aSBen Smithurst.Xr make 1 ,
876786aa69aSBen Smithurst.Xr make.conf 5 ,
877157376baSJoseph Koshy.Xr src.conf 5 ,
878f4721165SEdward Tomasz Napierala.Xr arch 7 ,
879e444a4c6SFernando Apesteguía.Xr pkg 7 ,
880a81996b6SBen Smithurst.Xr ports 7 ,
881a54bda91SMurray Stokely.Xr release 7 ,
88253837b18SEnji Cooper.Xr tests 7 ,
88361001d75STom Rhodes.Xr config 8 ,
884664eefe2SMateusz Piotrowski.Xr etcupdate 8 ,
88547f77d8cSBen Smithurst.Xr mergemaster 8 ,
886a81996b6SBen Smithurst.Xr reboot 8 ,
88753837b18SEnji Cooper.Xr shutdown 8
888786aa69aSBen Smithurst.Sh AUTHORS
889a63d6c94SBaptiste Daroussin.An Mike W. Meyer Aq Mt mwm@mired.org
890