xref: /freebsd/share/man/man7/build.7 (revision 21ef3591b6119f6972896e6c00cbf9ffb759646e)
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.\"
27*21ef3591SJohn Baldwin.Dd August 1, 2023
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.
2193e65b7d9SWarner Losh.It Cm cleankernel
2203e65b7d9SWarner LoshAttempts to clean up targets built by a preceding
2213e65b7d9SWarner Losh.Cm buildkernel ,
2223e65b7d9SWarner Loshor similar step, built from the same source directory and
2233e65b7d9SWarner Losh.Va KERNCONF .
2247b710ab2SJoseph Koshy.It Cm cleanworld
2257b710ab2SJoseph KoshyAttempt to clean up targets built by a preceding
226c10062b9SBryan Drewery.Cm buildworld ,
2273e65b7d9SWarner Loshor similar step, built from this source directory.
228c10062b9SBryan Drewery.It Cm cleanuniverse
229c10062b9SBryan DreweryWhen
230c10062b9SBryan Drewery.Va WITH_UNIFIED_OBJDIR
231c10062b9SBryan Dreweryis enabled, attempt to clean up targets built by a preceding
232c10062b9SBryan Drewery.Cm buildworld ,
233c10062b9SBryan Drewery.Cm universe ,
234c10062b9SBryan Dreweryor similar step, for any architecture built from this source directory.
2357b710ab2SJoseph Koshy.It Cm distributeworld
2367b710ab2SJoseph KoshyDistribute everything compiled by a preceding
2377b710ab2SJoseph Koshy.Cm buildworld
2387b710ab2SJoseph Koshystep.
2397b710ab2SJoseph KoshyFiles are placed in the directory hierarchy specified by
2407b710ab2SJoseph Koshy.Xr make 1
2417b710ab2SJoseph Koshyvariable
2427b710ab2SJoseph Koshy.Va DISTDIR .
2437b710ab2SJoseph KoshyThis target is used while building a release; see
2447b710ab2SJoseph Koshy.Xr release 7 .
2457441e255SBryan Drewery.It Cm native-xtools
2467441e255SBryan DreweryThis target builds a cross-toolchain for the given
2477441e255SBryan Drewery.Sy TARGET
2487441e255SBryan Dreweryand
2497441e255SBryan Drewery.Sy TARGET_ARCH ,
2507441e255SBryan Dreweryas well as a select list of static userland tools for the host system.
2517441e255SBryan DreweryThis is intended to be used in a jail where QEMU is used to improve
2527441e255SBryan Dreweryperformance by avoiding emulating binaries that do not need to be emulated.
2537441e255SBryan Drewery.Sy TARGET
2547441e255SBryan Dreweryand
2557441e255SBryan Drewery.Sy TARGET_ARCH
2567441e255SBryan Dreweryshould be defined.
2575bd47cc5SBryan Drewery.It Cm native-xtools-install
2585bd47cc5SBryan DreweryInstalls the results to
2595bd47cc5SBryan Drewery.Pa ${DESTDIR}/${NXTP}
2605bd47cc5SBryan Drewerywhere
2615bd47cc5SBryan Drewery.Va NXTP
2625bd47cc5SBryan Drewerydefaults to
2635bd47cc5SBryan Drewery.Pa nxb-bin .
2645bd47cc5SBryan Drewery.Sy TARGET
2655bd47cc5SBryan Dreweryand
2665bd47cc5SBryan Drewery.Sy TARGET_ARCH
2675bd47cc5SBryan Drewerymust be defined.
268e8423d00SNathan Whitehorn.It Cm packageworld
269e8423d00SNathan WhitehornArchive the results of
270e8423d00SNathan Whitehorn.Cm distributeworld ,
271e8423d00SNathan Whitehornplacing the results in
272e8423d00SNathan Whitehorn.Va DISTDIR .
273e8423d00SNathan WhitehornThis target is used while building a release; see
274e8423d00SNathan Whitehorn.Xr release 7 .
2757b710ab2SJoseph Koshy.It Cm installworld
2767b710ab2SJoseph KoshyInstall everything built by a preceding
2777b710ab2SJoseph Koshy.Cm buildworld
2787b710ab2SJoseph Koshystep into the directory hierarchy pointed to by
2797b710ab2SJoseph Koshy.Xr make 1
2807b710ab2SJoseph Koshyvariable
2817b710ab2SJoseph Koshy.Va DESTDIR .
282a3aed80dSRuslan Ermilov.Pp
28304876cf3SRuslan ErmilovIf installing onto an NFS file system and running
2848ed6451eSRuslan Ermilov.Xr make 1
2858ed6451eSRuslan Ermilovwith the
28604876cf3SRuslan Ermilov.Fl j
28704876cf3SRuslan Ermilovoption, make sure that
288a3aed80dSRuslan Ermilov.Xr rpc.lockd 8
289a3aed80dSRuslan Ermilovis running on both client and server.
290a3aed80dSRuslan ErmilovSee
291a3aed80dSRuslan Ermilov.Xr rc.conf 5
292a3aed80dSRuslan Ermilovon how to make it start at boot time.
2937b710ab2SJoseph Koshy.It Cm toolchain
2947b710ab2SJoseph KoshyCreate the build toolchain needed to build the rest of the system.
2957b710ab2SJoseph KoshyFor cross-architecture builds, this step creates a cross-toolchain.
2967b710ab2SJoseph Koshy.It Cm universe
2974e889921SJohn BaldwinFor each architecture,
2984e889921SJohn Baldwinexecute a
2997b710ab2SJoseph Koshy.Cm buildworld
3004e889921SJohn Baldwinfollowed by a
3017b710ab2SJoseph Koshy.Cm buildkernel
3024e889921SJohn Baldwinfor all kernels for that architecture,
3034e889921SJohn Baldwinincluding
3044e889921SJohn Baldwin.Pa LINT .
3057b710ab2SJoseph KoshyThis command takes a long time.
306e1b9162fSWarner Losh.It Cm kernels
307e1b9162fSWarner LoshLike
308e1b9162fSWarner Losh.Cm universe
309e1b9162fSWarner Loshwith
310e1b9162fSWarner Losh.Va WITHOUT_WORLDS
311e1b9162fSWarner Loshdefined so only the kernels for each architecture are built.
312e1b9162fSWarner Losh.It Cm worlds
313e1b9162fSWarner LoshLike
314e1b9162fSWarner Losh.Cm universe
315e1b9162fSWarner Loshwith
316e1b9162fSWarner Losh.Va WITHOUT_KERNELS
317e1b9162fSWarner Loshdefined so only the worlds for each architecture are built.
318f1d16bd8SBjoern A. Zeeb.It Cm targets
319f1d16bd8SBjoern A. ZeebPrint a list of supported
320f1d16bd8SBjoern A. Zeeb.Va TARGET
321f1d16bd8SBjoern A. Zeeb/
322f1d16bd8SBjoern A. Zeeb.Va TARGET_ARCH
323f1d16bd8SBjoern A. Zeebpairs for world and kernel targets.
324eee8163bSBjoern A. Zeeb.It Cm tinderbox
325eee8163bSBjoern A. ZeebExecute the same targets as
326eee8163bSBjoern A. Zeeb.Cm universe .
327eee8163bSBjoern A. ZeebIn addition print a summary of all failed targets at the end and
328eee8163bSBjoern A. Zeebexit with an error if there were any.
3294e889921SJohn Baldwin.It Cm toolchains
3304e889921SJohn BaldwinCreate a build toolchain for each architecture supported by the build system.
331b135fb6eSBryan Drewery.It Cm xdev
332b135fb6eSBryan DreweryBuilds and installs a cross-toolchain and sysroot for the given
333b135fb6eSBryan Drewery.Sy TARGET
334b135fb6eSBryan Dreweryand
335b135fb6eSBryan Drewery.Sy TARGET_ARCH .
336b135fb6eSBryan DreweryThe sysroot contains target library and headers.
337b135fb6eSBryan DreweryThe target is an alias for
338b135fb6eSBryan Drewery.Cm xdev-build
339b135fb6eSBryan Dreweryand
340b135fb6eSBryan Drewery.Cm xdev-install .
341b135fb6eSBryan DreweryThe location of the files installed can be controlled with
342b135fb6eSBryan Drewery.Va DESTDIR .
343b135fb6eSBryan DreweryThe target location in
344b135fb6eSBryan Drewery.Va DESTDIR
345b135fb6eSBryan Dreweryis
346b135fb6eSBryan Drewery.Pa ${DESTDIR}/${XDTP}
347b135fb6eSBryan Drewerywhere
348b135fb6eSBryan Drewery.Va XDTP
349b135fb6eSBryan Drewerydefaults to
350b135fb6eSBryan Drewery.Pa /usr/${XDDIR}
351b135fb6eSBryan Dreweryand
352b135fb6eSBryan Drewery.Va XDDIR
353b135fb6eSBryan Drewerydefaults to
354b135fb6eSBryan Drewery.Pa ${TARGET_ARCH}-freebsd .
355b135fb6eSBryan Drewery.It Cm xdev-build
356b135fb6eSBryan DreweryBuilds for the
357b135fb6eSBryan Drewery.Cm xdev
358b135fb6eSBryan Drewerytarget.
359b135fb6eSBryan Drewery.It Cm xdev-install
360b135fb6eSBryan DreweryInstalls the files for the
361b135fb6eSBryan Drewery.Cm xdev
362b135fb6eSBryan Drewerytarget.
363b135fb6eSBryan Drewery.It Cm xdev-links
364b135fb6eSBryan DreweryInstalls autoconf-style symlinks to
365b135fb6eSBryan Drewery.Pa ${DESTDIR}/usr/bin
366b135fb6eSBryan Drewerypointing into the xdev toolchain in
367b135fb6eSBryan Drewery.Pa ${DESTDIR}/${XDTP} .
368786aa69aSBen Smithurst.El
369786aa69aSBen Smithurst.Pp
3707b710ab2SJoseph KoshyKernel specific build targets in
371786aa69aSBen Smithurst.Pa /usr/src
3727b710ab2SJoseph Koshyare:
373e8423d00SNathan Whitehorn.Bl -tag -width ".Cm distributekernel"
3741caae057SRuslan Ermilov.It Cm buildkernel
3751caae057SRuslan ErmilovRebuild the kernel and the kernel modules.
376d90f12e3SWarren BlockThe object directory can be changed from the default
377d90f12e3SWarren Block.Pa /usr/obj
378d90f12e3SWarren Blockby setting the
379d90f12e3SWarren Block.Pa MAKEOBJDIRPREFIX
380d90f12e3SWarren Block.Xr make 1
381d90f12e3SWarren Blockvariable.
3821caae057SRuslan Ermilov.It Cm installkernel
3837b710ab2SJoseph KoshyInstall the kernel and the kernel modules to directory
3847b710ab2SJoseph Koshy.Pa ${DESTDIR}/boot/kernel ,
3857b710ab2SJoseph Koshyrenaming any pre-existing directory with this name to
3867b710ab2SJoseph Koshy.Pa kernel.old
3877b710ab2SJoseph Koshyif it contained the currently running kernel.
3887b710ab2SJoseph KoshyThe target directory under
3897b710ab2SJoseph Koshy.Pa ${DESTDIR}
3907b710ab2SJoseph Koshymay be modified using the
3917b710ab2SJoseph Koshy.Va INSTKERNNAME
3927b710ab2SJoseph Koshyand
3937b710ab2SJoseph Koshy.Va KODIR
3947b710ab2SJoseph Koshy.Xr make 1
3957b710ab2SJoseph Koshyvariables.
396e8423d00SNathan Whitehorn.It Cm distributekernel
397e8423d00SNathan WhitehornInstall the kernel to the directory
398e8423d00SNathan Whitehorn.Pa ${DISTDIR}/kernel/boot/kernel .
399e8423d00SNathan WhitehornThis target is used while building a release; see
400e8423d00SNathan Whitehorn.Xr release 7 .
401e8423d00SNathan Whitehorn.It Cm packagekernel
402e8423d00SNathan WhitehornArchive the results of
403e8423d00SNathan Whitehorn.Cm distributekernel ,
404e8423d00SNathan Whitehornplacing the results in
405e8423d00SNathan Whitehorn.Va DISTDIR .
406e8423d00SNathan WhitehornThis target is used while building a release; see
407e8423d00SNathan Whitehorn.Xr release 7 .
408389e98a7STom Rhodes.It Cm kernel
409389e98a7STom RhodesEquivalent to
410389e98a7STom Rhodes.Cm buildkernel
411389e98a7STom Rhodesfollowed by
412389e98a7STom Rhodes.Cm installkernel
4137b710ab2SJoseph Koshy.It Cm kernel-toolchain
4147b710ab2SJoseph KoshyRebuild the tools needed for kernel compilation.
4157b710ab2SJoseph KoshyUse this if you did not do a
4167b710ab2SJoseph Koshy.Cm buildworld
4177b710ab2SJoseph Koshyfirst.
4187b710ab2SJoseph Koshy.It Cm reinstallkernel
4197b710ab2SJoseph KoshyReinstall the kernel and the kernel modules, overwriting the contents
4207b710ab2SJoseph Koshyof the target directory.
4217b710ab2SJoseph KoshyAs with the
4227b710ab2SJoseph Koshy.Cm installkernel
4237b710ab2SJoseph Koshytarget, the target directory can be specified using the
4247b710ab2SJoseph Koshy.Xr make 1
4257b710ab2SJoseph Koshyvariable
4267b710ab2SJoseph Koshy.Va INSTKERNNAME .
4277b710ab2SJoseph Koshy.El
4287b710ab2SJoseph Koshy.Pp
4297b710ab2SJoseph KoshyConvenience targets for cleaning up the install destination directory
4307b710ab2SJoseph Koshydenoted by variable
4317b710ab2SJoseph Koshy.Va DESTDIR
4327b710ab2SJoseph Koshyinclude:
4337b710ab2SJoseph Koshy.Bl -tag -width ".Cm delete-old-libs"
4347b710ab2SJoseph Koshy.It Cm check-old
435abfabbeaSMike PritchardPrint a list of old files and directories in the system.
436e2a36081SAlexander Leidinger.It Cm delete-old
437e2a36081SAlexander LeidingerDelete obsolete base system files and directories interactively.
43878ad5421SRuslan ErmilovWhen
43978ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES
4407b710ab2SJoseph Koshyis specified at the command line, the delete operation will be
4417b710ab2SJoseph Koshynon-interactive.
442c8ef0ed5SRuslan ErmilovThe variables
4437b710ab2SJoseph Koshy.Va DESTDIR ,
4447b710ab2SJoseph Koshy.Va TARGET_ARCH
445c8ef0ed5SRuslan Ermilovand
446c8ef0ed5SRuslan Ermilov.Va TARGET
447c8ef0ed5SRuslan Ermilovshould be set as with
448c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" .
449e2a36081SAlexander Leidinger.It Cm delete-old-libs
450e2a36081SAlexander LeidingerDelete obsolete base system libraries interactively.
451d90f12e3SWarren BlockThis target should only be used if no third party software uses these
4527b710ab2SJoseph Koshylibraries.
45378ad5421SRuslan ErmilovWhen
45478ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES
4557b710ab2SJoseph Koshyis specified at the command line, the delete operation will be
4567b710ab2SJoseph Koshynon-interactive.
457c8ef0ed5SRuslan ErmilovThe variables
4587b710ab2SJoseph Koshy.Va DESTDIR ,
4597b710ab2SJoseph Koshy.Va TARGET_ARCH
460c8ef0ed5SRuslan Ermilovand
461c8ef0ed5SRuslan Ermilov.Va TARGET
462c8ef0ed5SRuslan Ermilovshould be set as with
463c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" .
464786aa69aSBen Smithurst.El
465b82e53e2SMurray Stokely.Sh ENVIRONMENT
4667b710ab2SJoseph KoshyVariables that influence all builds include:
4677b710ab2SJoseph Koshy.Bl -tag -width ".Va MAKEOBJDIRPREFIX"
468fea87c03SGiorgos Keramidas.It Va DEBUG_FLAGS
469fea87c03SGiorgos KeramidasDefines a set of debugging flags that will be used to build all userland
470fea87c03SGiorgos Keramidasbinaries under
471fea87c03SGiorgos Keramidas.Pa /usr/src .
472fea87c03SGiorgos KeramidasWhen
473fea87c03SGiorgos Keramidas.Va DEBUG_FLAGS
474fea87c03SGiorgos Keramidasis defined, the
475fea87c03SGiorgos Keramidas.Cm install
476fea87c03SGiorgos Keramidasand
477fea87c03SGiorgos Keramidas.Cm installworld
478fea87c03SGiorgos Keramidastargets install binaries from the current
479fea87c03SGiorgos Keramidas.Va MAKEOBJDIRPREFIX
480fea87c03SGiorgos Keramidaswithout stripping,
481fea87c03SGiorgos Keramidasso that debugging information is retained in the installed binaries.
4827b710ab2SJoseph Koshy.It Va DESTDIR
4837b710ab2SJoseph KoshyThe directory hierarchy prefix where built objects will be installed.
4847b710ab2SJoseph KoshyIf not set,
4857b710ab2SJoseph Koshy.Va DESTDIR
4867b710ab2SJoseph Koshydefaults to the empty string.
4877b710ab2SJoseph Koshy.It Va MAKEOBJDIRPREFIX
4887b710ab2SJoseph KoshyDefines the prefix for directory names in the tree of built objects.
4897b710ab2SJoseph KoshyDefaults to
4907b710ab2SJoseph Koshy.Pa /usr/obj
4917b710ab2SJoseph Koshyif not defined.
492dfa09989SBryan DreweryThis variable should only be set in the environment or
493dfa09989SBryan Drewery.Pa /etc/src-env.conf
494dfa09989SBryan Dreweryand not via
4957b710ab2SJoseph Koshy.Pa /etc/make.conf
496dfa09989SBryan Dreweryor
497dfa09989SBryan Drewery.Pa /etc/src.conf
4987b710ab2SJoseph Koshyor the command line.
4997fa2f2a6SAlex Richardson.It Va WITHOUT_WERROR
5007b710ab2SJoseph KoshyIf defined, compiler warnings will not cause the build to halt,
5017b710ab2SJoseph Koshyeven if the makefile says otherwise.
50221edb039SAlexander Leidinger.It Va WITH_CTF
50321edb039SAlexander LeidingerIf defined, the build process will run the DTrace CTF conversion
50421edb039SAlexander Leidingertools on built objects.
5057b710ab2SJoseph Koshy.El
5067b710ab2SJoseph Koshy.Pp
5077b710ab2SJoseph KoshyAdditionally, builds in
5087b710ab2SJoseph Koshy.Pa /usr/src
5097b710ab2SJoseph Koshyare influenced by the following
5107b710ab2SJoseph Koshy.Xr make 1
5117b710ab2SJoseph Koshyvariables:
512*21ef3591SJohn Baldwin.Bl -tag -width ".Va LOCAL_MODULES_DIR"
513*21ef3591SJohn Baldwin.It Va CROSS_TOOLCHAIN
514*21ef3591SJohn BaldwinRequests use of an external toolchain to build either the world or kernel.
515*21ef3591SJohn BaldwinThis value of this variable can either be the full path to a file,
516*21ef3591SJohn Baldwinor the base name of a file in
517*21ef3591SJohn Baldwin.Pa ${LOCALBASE}/share/toolchains .
518*21ef3591SJohn BaldwinThe file should be a make file which sets variables to request an external
519*21ef3591SJohn Baldwintoolchain such as
520*21ef3591SJohn Baldwin.Va XCC .
521*21ef3591SJohn Baldwin.Pp
522*21ef3591SJohn BaldwinExternal toolchains are available in ports for both LLVM and GCC/binutils.
523*21ef3591SJohn BaldwinFor external toolchains available in ports,
524*21ef3591SJohn Baldwin.Va CROSS_TOOLCHAIN
525*21ef3591SJohn Baldwinshould be set to the name of the package.
526*21ef3591SJohn BaldwinLLVM toolchain packages use the name llvm<major version>.
527*21ef3591SJohn BaldwinGCC toolchains provide separate packages for each architecture and use the
528*21ef3591SJohn Baldwinname ${MACHINE_ARCH}-gcc<major version>.
529e6cdeeddSWarner Losh.It Va KERNCONF
530e6cdeeddSWarner LoshOverrides which kernel to build and install for the various kernel
531e6cdeeddSWarner Loshmake targets.
532e6cdeeddSWarner LoshIt defaults to
533e6cdeeddSWarner Losh.Cm GENERIC .
5344b2cc4d1SKyle Evans.It Va KERNCONFDIR
5354b2cc4d1SKyle EvansOverrides the directory in which
5364b2cc4d1SKyle Evans.Va KERNCONF
5374b2cc4d1SKyle Evansand any files included by
5384b2cc4d1SKyle Evans.Va KERNCONF
5394b2cc4d1SKyle Evansshould be found.
5404b2cc4d1SKyle EvansDefaults to
5414b2cc4d1SKyle Evans.Pa sys/${ARCH}/conf .
542e6cdeeddSWarner Losh.It Va KERNFAST
543e6cdeeddSWarner LoshIf set, the build target
544e6cdeeddSWarner Losh.Cm buildkernel
545e6cdeeddSWarner Loshdefaults to setting
546e6cdeeddSWarner Losh.Va NO_KERNELCLEAN ,
5476d50d5e4SWarner Losh.Va NO_KERNELCONFIG ,
548e6cdeeddSWarner Loshand
5496d50d5e4SWarner Losh.Va NO_KERNELOBJ .
550e6cdeeddSWarner LoshWhen set to a value other than
551e6cdeeddSWarner Losh.Cm 1
552e6cdeeddSWarner Loshthen
553e6cdeeddSWarner Losh.Va KERNCONF
554e6cdeeddSWarner Loshis set to the value of
555e6cdeeddSWarner Losh.Va KERNFAST .
5567b710ab2SJoseph Koshy.It Va LOCAL_DIRS
557ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
558ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
559ca6a54ceSBryan Drewery.Cm everything
560ca6a54ceSBryan Drewerytarget.
561e93e5bb0SIan LeporeThe directories are built in parallel with each other,
562e93e5bb0SIan Leporeand with the base system directories.
563e93e5bb0SIan LeporeInsert a
564e93e5bb0SIan Lepore.Va .WAIT
565e93e5bb0SIan Leporedirective at the beginning of the
566e93e5bb0SIan Lepore.Va LOCAL_DIRS
567e93e5bb0SIan Leporelist to ensure all base system directories are built first.
568e93e5bb0SIan Lepore.Va .WAIT
569e93e5bb0SIan Leporemay also be used as needed elsewhere within the list.
570a0e6a013SBryan Drewery.It Va LOCAL_ITOOLS
571a0e6a013SBryan DreweryIf set, this variable supplies a list of additional tools that are used by the
572a0e6a013SBryan Drewery.Cm installworld
573a0e6a013SBryan Dreweryand
574a0e6a013SBryan Drewery.Cm distributeworld
575a0e6a013SBryan Drewerytargets.
576ca6a54ceSBryan Drewery.It Va LOCAL_LIB_DIRS
577ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
578ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
579ca6a54ceSBryan Drewery.Cm libraries
580ca6a54ceSBryan Drewerytarget.
581e93e5bb0SIan LeporeThe directories are built in parallel with each other,
582e93e5bb0SIan Leporeand with the base system libraries.
583e93e5bb0SIan LeporeInsert a
584e93e5bb0SIan Lepore.Va .WAIT
585e93e5bb0SIan Leporedirective at the beginning of the
586e93e5bb0SIan Lepore.Va LOCAL_DIRS
587e93e5bb0SIan Leporelist to ensure all base system libraries are built first.
588e93e5bb0SIan Lepore.Va .WAIT
589e93e5bb0SIan Leporemay also be used as needed elsewhere within the list.
590ca6a54ceSBryan Drewery.It Va LOCAL_MTREE
591ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional mtrees relative to the
592ca6a54ceSBryan Dreweryroot of the source tree to use as part of the
593ca6a54ceSBryan Drewery.Cm hierarchy
594ca6a54ceSBryan Drewerytarget.
59580cedb80SBryan Drewery.It Va LOCAL_LEGACY_DIRS
59680cedb80SBryan DreweryIf set, this variable supplies a list of additional directories relative to
59780cedb80SBryan Drewerythe root of the source tree to build as part of the
59880cedb80SBryan Drewery.Cm legacy
59980cedb80SBryan Drewerytarget.
60080cedb80SBryan Drewery.It Va LOCAL_BSTOOL_DIRS
60180cedb80SBryan DreweryIf set, this variable supplies a list of additional directories relative to
60280cedb80SBryan Drewerythe root of the source tree to build as part of the
60380cedb80SBryan Drewery.Cm bootstrap-tools
60480cedb80SBryan Drewerytarget.
605ca6a54ceSBryan Drewery.It Va LOCAL_TOOL_DIRS
606ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
607ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
608ca6a54ceSBryan Drewery.Cm build-tools
609ca6a54ceSBryan Drewerytarget.
6104143850bSBryan Drewery.It Va LOCAL_XTOOL_DIRS
6114143850bSBryan DreweryIf set, this variable supplies a list of additional directories relative to
6124143850bSBryan Drewerythe root of the source tree to build as part of the
6134143850bSBryan Drewery.Cm cross-tools
6144143850bSBryan Drewerytarget.
615170c2788SGlen Barber.It Va PORTS_MODULES
616170c2788SGlen BarberA list of ports with kernel modules that should be built and installed
617170c2788SGlen Barberas part of the
618170c2788SGlen Barber.Cm buildkernel
619170c2788SGlen Barberand
620170c2788SGlen Barber.Cm installkernel
621170c2788SGlen Barberprocess.
622170c2788SGlen Barber.Bd -literal -offset indent
6237fbc0c98SMitchell Hornemake PORTS_MODULES=emulators/virtualbox-ose-kmod kernel
624170c2788SGlen Barber.Ed
625e7a13643SMark Johnston.It Va LOCAL_MODULES
626e7a13643SMark JohnstonA list of external kernel modules that should be built and installed
627e7a13643SMark Johnstonas part of the
628e7a13643SMark Johnston.Cm buildkernel
629e7a13643SMark Johnstonand
630e7a13643SMark Johnston.Cm installkernel
631e7a13643SMark Johnstonprocess.
632805c3af8SMark JohnstonDefaults to the list of sub-directories of
633805c3af8SMark Johnston.Va LOCAL_MODULES_DIR .
634e7a13643SMark Johnston.It Va LOCAL_MODULES_DIR
635e7a13643SMark JohnstonThe directory in which to search for the kernel modules specified by
636e7a13643SMark Johnston.Va LOCAL_MODULES .
637e7a13643SMark JohnstonEach kernel module should consist of a directory containing a makefile.
638e7a13643SMark JohnstonDefaults to
639e7a13643SMark Johnston.Pa ${LOCALBASE}/sys/modules .
640e6ca6901SGordon Bergling.It Va SRCCONF
641e6ca6901SGordon BerglingSpecify a file to override the default
642e6ca6901SGordon Bergling.Pa /etc/src.conf .
643e6ca6901SGordon BerglingThe src.conf file controls the components to build.
644e6ca6901SGordon BerglingSee
645e6ca6901SGordon Bergling.Xr src.conf 5
64642e7be20SEnji Cooper.It Va STRIPBIN
6473547290fSEnji CooperCommand to use at install time when stripping binaries.
6483547290fSEnji CooperBe sure to add any additional tools required to run
64942e7be20SEnji Cooper.Va STRIPBIN
6503547290fSEnji Cooperto the
6513547290fSEnji Cooper.Va LOCAL_ITOOLS
6523547290fSEnji Cooper.Xr make 1
6533547290fSEnji Coopervariable before running the
6543547290fSEnji Cooper.Cm distributeworld
6553547290fSEnji Cooperor
6563547290fSEnji Cooper.Cm installworld
6573547290fSEnji Coopertargets.
6583547290fSEnji CooperSee
6593547290fSEnji Cooper.Xr install 1
6603547290fSEnji Cooperfor more details.
6617b710ab2SJoseph Koshy.It Va SUBDIR_OVERRIDE
6627b710ab2SJoseph KoshyOverride the default list of sub-directories and only build the
6637b710ab2SJoseph Koshysub-directory named in this variable.
6647f1636b7SBryan DreweryIf combined with
6657f1636b7SBryan Drewery.Cm buildworld
6667f1636b7SBryan Drewerythen all libraries and includes, and some of the build tools will still build
6677f1636b7SBryan Dreweryas well.
668c889d480SBryan DrewerySpecifying
669c889d480SBryan Drewery.Cm -DNO_LIBS ,
670c889d480SBryan Dreweryand
671c889d480SBryan Drewery.Cm -DWORLDFAST
672c889d480SBryan Drewerywill only build the specified directory as was done historically.
6737f1636b7SBryan DreweryWhen combined with
6747f1636b7SBryan Drewery.Cm buildworld
6757f1636b7SBryan Dreweryit is necesarry to override
6767f1636b7SBryan Drewery.Va LOCAL_LIB_DIRS
6777f1636b7SBryan Drewerywith any custom directories containing libraries.
6787f1636b7SBryan DreweryThis allows building a subset of the system in the same way as
6797f1636b7SBryan Drewery.Cm buildworld
6807f1636b7SBryan Drewerydoes using its sysroot handling.
6817f1636b7SBryan DreweryThis variable can also be useful when debugging failed builds.
6827b710ab2SJoseph Koshy.Bd -literal -offset indent
6837b710ab2SJoseph Koshymake some-target SUBDIR_OVERRIDE=foo/bar
6847b710ab2SJoseph Koshy.Ed
685def657b8SWarner Losh.It Va SYSDIR
686def657b8SWarner LoshSpecify the location of the kernel source to override the default
687def657b8SWarner Losh.Pa /usr/src/sys .
688def657b8SWarner LoshThe kernel source is located in the
689def657b8SWarner Losh.Pa sys
690def657b8SWarner Loshsubdirectory of the source tree checked out from the
691def657b8SWarner Losh.Pa src.git
692def657b8SWarner Loshrepository.
6936f9ac6feSMurray Stokely.It Va TARGET
694b3a43ea3SMurray StokelyThe target hardware platform.
695365a17c0SMurray StokelyThis is analogous to the
6961caae057SRuslan Ermilov.Dq Nm uname Fl m
697b3a43ea3SMurray Stokelyoutput.
698b3a43ea3SMurray StokelyThis is necessary to cross-build some target architectures.
6992f6a7e42SEnji CooperFor example, cross-building for ARM64 machines requires
7002f6a7e42SEnji Cooper.Va TARGET_ARCH Ns = Ns Li aarch64
701b3a43ea3SMurray Stokelyand
7022f6a7e42SEnji Cooper.Va TARGET Ns = Ns Li arm64 .
7037b710ab2SJoseph KoshyIf not set,
7047b710ab2SJoseph Koshy.Va TARGET
705f4721165SEdward Tomasz Napieraladefaults to the current hardware platform, unless
706f4721165SEdward Tomasz Napierala.Va TARGET_ARCH
707f4721165SEdward Tomasz Napieralais also set, in which case it defaults to the appropriate
708f4721165SEdward Tomasz Napieralavalue for that architecture.
7097b710ab2SJoseph Koshy.It Va TARGET_ARCH
7107b710ab2SJoseph KoshyThe target machine processor architecture.
7117b710ab2SJoseph KoshyThis is analogous to the
7127b710ab2SJoseph Koshy.Dq Nm uname Fl p
7137b710ab2SJoseph Koshyoutput.
7147b710ab2SJoseph KoshySet this to cross-build for a different architecture.
7157b710ab2SJoseph KoshyIf not set,
7167b710ab2SJoseph Koshy.Va TARGET_ARCH
717531b260aSWarner Loshdefaults to the current machine architecture, unless
718531b260aSWarner Losh.Va TARGET
719531b260aSWarner Loshis also set, in which case it defaults to the appropriate
720531b260aSWarner Loshvalue for that platform.
721c22c7f86SWarner LoshTypically, one only needs to set
722c22c7f86SWarner Losh.Va TARGET .
7237b710ab2SJoseph Koshy.El
7247b710ab2SJoseph Koshy.Pp
7257b710ab2SJoseph KoshyBuilds under directory
726fd23b461SGiorgos Keramidas.Pa /usr/src
7277d6af40dSGlen Barberare also influenced by defining one or more of the following symbols,
728fd23b461SGiorgos Keramidasusing the
729fd23b461SGiorgos Keramidas.Fl D
730fd23b461SGiorgos Keramidasoption of
731fd23b461SGiorgos Keramidas.Xr make 1 :
732*21ef3591SJohn Baldwin.Bl -tag -width ".Va LOADER_DEFAULT_INTERP"
73301012c64SWarner Losh.It Va LOADER_DEFAULT_INTERP
73401012c64SWarner LoshDefines what interpreter the default loader program will have.
73501012c64SWarner LoshValid values include
73601012c64SWarner Losh.Dq 4th ,
73701012c64SWarner Losh.Dq lua ,
73801012c64SWarner Loshand
73901012c64SWarner Losh.Dq simp .
74001012c64SWarner LoshThis creates the default link for
74101012c64SWarner Losh.Pa /boot/loader
74201012c64SWarner Loshto the loader with that interpreter.
74301012c64SWarner LoshIt also determines what interpreter is compiled into
74401012c64SWarner Losh.Pa userboot .
745fd23b461SGiorgos Keramidas.It Va NO_CLEANDIR
746fd23b461SGiorgos KeramidasIf set, the build targets that clean parts of the object tree use the
747fd23b461SGiorgos Keramidasequivalent of
748fd23b461SGiorgos Keramidas.Dq make clean
749fd23b461SGiorgos Keramidasinstead of
750fd23b461SGiorgos Keramidas.Dq make cleandir .
751fd23b461SGiorgos Keramidas.It Va NO_CLEAN
752fd23b461SGiorgos KeramidasIf set, no object tree files are cleaned at all.
753473fda75SBryan DreweryThis is the default when
754473fda75SBryan Drewery.Va WITH_META_MODE
755473fda75SBryan Dreweryis used with
756473fda75SBryan Drewery.Xr filemon 4
757473fda75SBryan Dreweryloaded.
758473fda75SBryan DrewerySee
759473fda75SBryan Drewery.Xr src.conf 5
760473fda75SBryan Dreweryfor more details.
761fd23b461SGiorgos KeramidasSetting
762fd23b461SGiorgos Keramidas.Va NO_CLEAN
763fd23b461SGiorgos Keramidasimplies
764fd23b461SGiorgos Keramidas.Va NO_KERNELCLEAN ,
765fd23b461SGiorgos Keramidasso when
766fd23b461SGiorgos Keramidas.Va NO_CLEAN
767fd23b461SGiorgos Keramidasis set no kernel objects are cleaned either.
768fd23b461SGiorgos Keramidas.It Va NO_CTF
769fd23b461SGiorgos KeramidasIf set, the build process does not run the DTrace CTF conversion tools
770fd23b461SGiorgos Keramidason built objects.
771fd23b461SGiorgos Keramidas.It Va NO_SHARE
772fd23b461SGiorgos KeramidasIf set, the build does not descend into the
773fd23b461SGiorgos Keramidas.Pa /usr/src/share
774d90f12e3SWarren Blocksubdirectory (i.e., manual pages, locale data files, timezone data files and
775fd23b461SGiorgos Keramidasother
776fd23b461SGiorgos Keramidas.Pa /usr/src/share
777fd23b461SGiorgos Keramidasfiles will not be rebuild from their sources).
778fd23b461SGiorgos Keramidas.It Va NO_KERNELCLEAN
779fd23b461SGiorgos KeramidasIf set, the build process does not run
780fd23b461SGiorgos Keramidas.Dq make clean
781fd23b461SGiorgos Keramidasas part of the
782fd23b461SGiorgos Keramidas.Cm buildkernel
783fd23b461SGiorgos Keramidastarget.
784fd23b461SGiorgos Keramidas.It Va NO_KERNELCONFIG
785fd23b461SGiorgos KeramidasIf set, the build process does not run
786fd23b461SGiorgos Keramidas.Xr config 8
787fd23b461SGiorgos Keramidasas part of the
788fd23b461SGiorgos Keramidas.Cm buildkernel
789fd23b461SGiorgos Keramidastarget.
7906d50d5e4SWarner Losh.It Va NO_KERNELOBJ
7916d50d5e4SWarner LoshIf set, the build process does not run
7926d50d5e4SWarner Losh.Dq make obj
7936d50d5e4SWarner Loshas part of the
7946d50d5e4SWarner Losh.Cm buildkernel
7956d50d5e4SWarner Loshtarget.
796c596c287SBryan Drewery.It Va NO_LIBS
797c596c287SBryan DreweryIf set, the libraries phase will be skipped.
7982abeba9dSBryan Drewery.It Va NO_OBJWALK
7996d75a7a8SBryan DreweryIf set, no object directories will be created.
8006d75a7a8SBryan DreweryThis should only be used if object directories were created in a
8016d75a7a8SBryan Dreweryprevious build and no new directories are connected.
802*21ef3591SJohn Baldwin.It Va UNIVERSE_TOOLCHAIN
803*21ef3591SJohn BaldwinRequests use of the toolchain built as part of the
804*21ef3591SJohn Baldwin.Cm universe
805*21ef3591SJohn Baldwintarget as an external toolchain.
80616892c77SBryan Drewery.It Va WORLDFAST
80716892c77SBryan DreweryIf set, the build target
80816892c77SBryan Drewery.Cm buildworld
80916892c77SBryan Drewerydefaults to setting
81016892c77SBryan Drewery.Va NO_CLEAN ,
8112abeba9dSBryan Drewery.Va NO_OBJWALK ,
81216892c77SBryan Dreweryand will skip most bootstrap phases.
81316892c77SBryan DreweryIt will only bootstrap libraries and build all of userland.
81416892c77SBryan DreweryThis option should be used only when it is known that none of the bootstrap
81516892c77SBryan Dreweryneeds changed and that no new directories have been connected to the build.
816fd23b461SGiorgos Keramidas.El
817fd23b461SGiorgos Keramidas.Pp
818fd23b461SGiorgos KeramidasBuilds under directory
8197b710ab2SJoseph Koshy.Pa /usr/doc
8207b710ab2SJoseph Koshyare influenced by the following
8217b710ab2SJoseph Koshy.Xr make 1
8227b710ab2SJoseph Koshyvariables:
8237b710ab2SJoseph Koshy.Bl -tag -width ".Va DOC_LANG"
8247b710ab2SJoseph Koshy.It Va DOC_LANG
8257b710ab2SJoseph KoshyIf set, restricts the documentation build to the language subdirectories
8267b710ab2SJoseph Koshyspecified as its content.
8277b710ab2SJoseph KoshyThe default action is to build documentation for all languages.
828b82e53e2SMurray Stokely.El
8294e889921SJohn Baldwin.Pp
8304e889921SJohn BaldwinBuilds using the
8314e889921SJohn Baldwin.Cm universe
832e1b9162fSWarner Loshand related targets are influenced by the following
8334e889921SJohn Baldwin.Xr make 1
8344e889921SJohn Baldwinvariables:
835*21ef3591SJohn Baldwin.Bl -tag -width ".Va USE_GCC_TOOLCHAINS"
8364e889921SJohn Baldwin.It Va JFLAG
8374e889921SJohn BaldwinPass the value of this variable to each
8384e889921SJohn Baldwin.Xr make 1
8394e889921SJohn Baldwininvocation used to build worlds and kernels.
8404e889921SJohn BaldwinThis can be used to enable multiple jobs within a single architecture's build
8414e889921SJohn Baldwinwhile still building each architecture serially.
8424e889921SJohn Baldwin.It Va MAKE_JUST_KERNELS
8434e889921SJohn BaldwinOnly build kernels for each supported architecture.
8444e889921SJohn Baldwin.It Va MAKE_JUST_WORLDS
8454e889921SJohn BaldwinOnly build worlds for each supported architecture.
846a7783b5aSWarner Losh.It Va WITHOUT_WORLDS
847a7783b5aSWarner LoshOnly build kernels for each supported architecture.
848a7783b5aSWarner Losh.It Va WITHOUT_KERNELS
849a7783b5aSWarner LoshOnly build worlds for each supported architecture.
8504e889921SJohn Baldwin.It Va UNIVERSE_TARGET
8514e889921SJohn BaldwinExecute the specified
8524e889921SJohn Baldwin.Xr make 1
8534e889921SJohn Baldwintarget for each supported architecture instead of the default action of
8544e889921SJohn Baldwinbuilding a world and one or more kernels.
855a7783b5aSWarner LoshThis variable implies
856a7783b5aSWarner Losh.Va WITHOUT_KERNELS .
857*21ef3591SJohn Baldwin.It Va USE_GCC_TOOLCHAINS
858*21ef3591SJohn BaldwinUse external GCC toolchains to build the requested targets.
859*21ef3591SJohn BaldwinIf the required toolchain package for a supported architecture is not installed,
860*21ef3591SJohn Baldwinthe build for that architecture is skipped.
861e1b9162fSWarner Losh.It Va TARGETS
862e1b9162fSWarner LoshOnly build the listed targets instead of each supported architecture.
863e1b9162fSWarner Losh.It Va EXTRA_TARGETS
864e1b9162fSWarner LoshIn addition to the supported architectures, build the semi-supported
865e1b9162fSWarner Losharchitectures.
866e1b9162fSWarner LoshA semi-supported architecture has build support in the
867e1b9162fSWarner Losh.Fx
868e1b9162fSWarner Loshtree, but receives significantly less testing and is generally for
869e1b9162fSWarner Loshfringe uses that do not have a wide appeal.
8704e889921SJohn Baldwin.El
871786aa69aSBen Smithurst.Sh FILES
8720c0eb9beSRuslan Ermilov.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
873786aa69aSBen Smithurst.It Pa /usr/doc/Makefile
874786aa69aSBen Smithurst.It Pa /usr/doc/share/mk/doc.project.mk
875786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.port.mk
876786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.sites.mk
8771caae057SRuslan Ermilov.It Pa /usr/share/examples/etc/make.conf
8780c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile
8790c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile.inc1
8803136363fSRuslan Ermilov.El
8813faf5fc9SBen Smithurst.Sh EXAMPLES
882be6a4760SRuslan ErmilovFor an
8833faf5fc9SBen Smithurst.Dq approved
8847b710ab2SJoseph Koshymethod of updating your system from the latest sources, please see the
885be6a4760SRuslan Ermilov.Sx COMMON ITEMS
886be6a4760SRuslan Ermilovsection in
887be6a4760SRuslan Ermilov.Pa src/UPDATING .
888b82e53e2SMurray Stokely.Pp
889b82e53e2SMurray StokelyThe following sequence of commands can be used to cross-build the
890f4721165SEdward Tomasz Napieralasystem for the armv6 architecture on an amd64 host:
891b82e53e2SMurray Stokely.Bd -literal -offset indent
892b82e53e2SMurray Stokelycd /usr/src
893f4721165SEdward Tomasz Napieralamake TARGET_ARCH=armv6 buildworld buildkernel
894ecc0f5f6SEdward Tomasz Napieralamake TARGET_ARCH=armv6 DESTDIR=/clients/arm installworld installkernel
895b82e53e2SMurray Stokely.Ed
89659e11f39SBenedict Reuschling.Sh HISTORY
89759e11f39SBenedict ReuschlingThe
89859e11f39SBenedict Reuschling.Nm
89959e11f39SBenedict Reuschlingmanpage first appeared in
90059e11f39SBenedict Reuschling.Fx 4.3 .
901786aa69aSBen Smithurst.Sh SEE ALSO
9027c20a493SBen Smithurst.Xr cc 1 ,
903786aa69aSBen Smithurst.Xr install 1 ,
904786aa69aSBen Smithurst.Xr make 1 ,
905786aa69aSBen Smithurst.Xr make.conf 5 ,
906157376baSJoseph Koshy.Xr src.conf 5 ,
907f4721165SEdward Tomasz Napierala.Xr arch 7 ,
908e444a4c6SFernando Apesteguía.Xr pkg 7 ,
909a81996b6SBen Smithurst.Xr ports 7 ,
910a54bda91SMurray Stokely.Xr release 7 ,
91153837b18SEnji Cooper.Xr tests 7 ,
91261001d75STom Rhodes.Xr config 8 ,
913664eefe2SMateusz Piotrowski.Xr etcupdate 8 ,
914a81996b6SBen Smithurst.Xr reboot 8 ,
91553837b18SEnji Cooper.Xr shutdown 8
916786aa69aSBen Smithurst.Sh AUTHORS
917a63d6c94SBaptiste Daroussin.An Mike W. Meyer Aq Mt mwm@mired.org
918