xref: /freebsd/share/man/man7/build.7 (revision ffc4f93e960d38b6f70d59409127f7562e40f916)
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.\"
2521ef3591SJohn Baldwin.Dd August 1, 2023
26786aa69aSBen Smithurst.Dt BUILD 7
273d45e180SRuslan Ermilov.Os
28786aa69aSBen Smithurst.Sh NAME
29786aa69aSBen Smithurst.Nm build
30e6ca6901SGordon Bergling.Nd General instructions on how to build the system
31786aa69aSBen Smithurst.Sh DESCRIPTION
327b710ab2SJoseph KoshyThe sources for the
33d003b779SRuslan Ermilov.Fx
347b710ab2SJoseph Koshysystem and its applications are contained in three different directories,
35786aa69aSBen Smithurstnormally
36786aa69aSBen Smithurst.Pa /usr/src ,
37786aa69aSBen Smithurst.Pa /usr/doc ,
38786aa69aSBen Smithurstand
39786aa69aSBen Smithurst.Pa /usr/ports .
4050a994c9SWarren BlockThese directories may be initially empty or non-existent until updated with
41e444a4c6SFernando ApesteguíaGit
42e444a4c6SFernando Apesteguía.Po installed from packages with
43e444a4c6SFernando Apesteguía.Xr pkg 7
44e444a4c6SFernando Apesteguíaor from
45e444a4c6SFernando Apesteguía.Xr ports 7 Pc .
467b710ab2SJoseph KoshyDirectory
47786aa69aSBen Smithurst.Pa /usr/src
48786aa69aSBen Smithurstcontains the
49786aa69aSBen Smithurst.Dq "base system"
50786aa69aSBen Smithurstsources, which is loosely defined as the things required to rebuild
51786aa69aSBen Smithurstthe system to a useful state.
527b710ab2SJoseph KoshyDirectory
53786aa69aSBen Smithurst.Pa /usr/doc
54786aa69aSBen Smithurstcontains the source for the system documentation, excluding the manual
55786aa69aSBen Smithurstpages.
567b710ab2SJoseph KoshyDirectory
57786aa69aSBen Smithurst.Pa /usr/ports
587b710ab2SJoseph Koshycontains a tree that provides a consistent interface for building and
59786aa69aSBen Smithurstinstalling third party applications.
607b710ab2SJoseph KoshyFor more information about the ports build process, see
617b710ab2SJoseph Koshy.Xr ports 7 .
62786aa69aSBen Smithurst.Pp
63786aa69aSBen SmithurstThe
64786aa69aSBen Smithurst.Xr make 1
65786aa69aSBen Smithurstcommand is used in each of these directories to build and install the
661caae057SRuslan Ermilovthings in that directory.
671caae057SRuslan ErmilovIssuing the
681caae057SRuslan Ermilov.Xr make 1
69e6ca6901SGordon Berglingcommand in any directory issues the
70e6ca6901SGordon Bergling.Xr make 1
71e6ca6901SGordon Berglingcommand recursively in all subdirectories.
72e6ca6901SGordon BerglingWith no target specified, the items in the directories are built
73e6ca6901SGordon Berglingand no further action is taken.
747b710ab2SJoseph Koshy.Pp
757b710ab2SJoseph KoshyA source tree is allowed to be read-only.
767b710ab2SJoseph KoshyAs described in
777b710ab2SJoseph Koshy.Xr make 1 ,
787b710ab2SJoseph Koshyobjects are usually built in a separate object directory hierarchy
797b710ab2SJoseph Koshyspecified by the environment variable
807b710ab2SJoseph Koshy.Va MAKEOBJDIRPREFIX ,
817b710ab2SJoseph Koshyor under
827b710ab2SJoseph Koshy.Pa /usr/obj
837b710ab2SJoseph Koshyif variable
847b710ab2SJoseph Koshy.Va MAKEOBJDIRPREFIX
857b710ab2SJoseph Koshyis not set.
86dfa09989SBryan DreweryThe canonical object directory is described in the documentation for the
877b710ab2SJoseph Koshy.Cm buildworld
887b710ab2SJoseph Koshytarget below.
897b710ab2SJoseph Koshy.Pp
907b710ab2SJoseph KoshyThe build may be controlled by defining
917b710ab2SJoseph Koshy.Xr make 1
927b710ab2SJoseph Koshyvariables described in the
937b710ab2SJoseph Koshy.Sx ENVIRONMENT
947b710ab2SJoseph Koshysection below, and by the variables documented in
957b710ab2SJoseph Koshy.Xr make.conf 5 .
967b710ab2SJoseph Koshy.Pp
97e6ca6901SGordon BerglingThe default components included in the build are specified in the file
98e6ca6901SGordon Bergling.Pa /etc/src.conf
99e6ca6901SGordon Berglingin the source tree.
100e6ca6901SGordon BerglingTo override the default file, include the SRCCONF option in the make steps,
101e6ca6901SGordon Berglingpointing to a custom src.conf file.
102e6ca6901SGordon BerglingFor more information see
103e6ca6901SGordon Bergling.Xr src.conf 5 .
104e6ca6901SGordon Bergling.Pp
1057b710ab2SJoseph KoshyThe following list provides the names and actions for the targets
1067b710ab2SJoseph Koshysupported by the build system:
1077b710ab2SJoseph Koshy.Bl -tag -width ".Cm cleandepend"
108aae63957SBryan Drewery.It Cm analyze
109aae63957SBryan DreweryRun Clang static analyzer against all objects and present output on stdout.
11071b7fa12SEnji Cooper.It Cm check
11171b7fa12SEnji CooperRun tests for a given subdirectory.
11271b7fa12SEnji CooperThe default directory used is
11371b7fa12SEnji Cooper.Pa ${.OBJDIR} ,
11471b7fa12SEnji Cooperbut the check directory can be changed with
11571b7fa12SEnji Cooper.Pa ${CHECKDIR} .
11671b7fa12SEnji Cooper.It Cm checkworld
11771b7fa12SEnji CooperRun the
11871b7fa12SEnji Cooper.Fx
11971b7fa12SEnji Coopertest suite on installed world.
1201caae057SRuslan Ermilov.It Cm clean
1217b710ab2SJoseph KoshyRemove any files created during the build process.
1227b710ab2SJoseph Koshy.It Cm cleandepend
123497e8091SBryan DreweryRemove the
124497e8091SBryan Drewery.Pa ${.OBJDIR}/${DEPENDFILE}*
125497e8091SBryan Dreweryfiles generated by prior
126497e8091SBryan Drewery.Dq Li "make"
127497e8091SBryan Dreweryand
1287b710ab2SJoseph Koshy.Dq Li "make depend"
129497e8091SBryan Drewerysteps.
1307b710ab2SJoseph Koshy.It Cm cleandir
1317b710ab2SJoseph KoshyRemove the canonical object directory if it exists, or perform
1327b710ab2SJoseph Koshyactions equivalent to
1337b710ab2SJoseph Koshy.Dq Li "make clean cleandepend"
1347b710ab2SJoseph Koshyif it does not.
1357b710ab2SJoseph KoshyThis target will also remove an
1367b710ab2SJoseph Koshy.Pa obj
1377b710ab2SJoseph Koshylink in
1387b710ab2SJoseph Koshy.Pa ${.CURDIR}
1397b710ab2SJoseph Koshyif that exists.
1407b710ab2SJoseph Koshy.Pp
1417b710ab2SJoseph KoshyIt is advisable to run
1427b710ab2SJoseph Koshy.Dq Li "make cleandir"
1437b710ab2SJoseph Koshytwice: the first invocation will remove the canonical object directory
1447b710ab2SJoseph Koshyand the second one will clean up
1457b710ab2SJoseph Koshy.Pa ${.CURDIR} .
1467b710ab2SJoseph Koshy.It Cm depend
1477b710ab2SJoseph KoshyGenerate a list of build dependencies in file
1487b710ab2SJoseph Koshy.Pa ${.OBJDIR}/${DEPENDFILE} .
149497e8091SBryan DreweryPer-object dependencies are generated at build time and stored in
150497e8091SBryan Drewery.Pa ${.OBJDIR}/${DEPENDFILE}.${OBJ} .
1511caae057SRuslan Ermilov.It Cm install
1527b710ab2SJoseph KoshyInstall the results of the build to the appropriate location in the
1537b710ab2SJoseph Koshyinstallation directory hierarchy specified in variable
1547b710ab2SJoseph Koshy.Va DESTDIR .
1557b710ab2SJoseph Koshy.It Cm obj
1567b710ab2SJoseph KoshyCreate the canonical object directory associated with the current
1577b710ab2SJoseph Koshydirectory.
1587b710ab2SJoseph Koshy.It Cm objlink
1597b710ab2SJoseph KoshyCreate a symbolic link to the canonical object directory in
1607b710ab2SJoseph Koshy.Pa ${.CURDIR} .
1617b710ab2SJoseph Koshy.It Cm tags
1627b710ab2SJoseph KoshyGenerate a tags file using the program specified in the
1637b710ab2SJoseph Koshy.Xr make 1
1647b710ab2SJoseph Koshyvariable
1657b710ab2SJoseph Koshy.Va CTAGS .
1667b710ab2SJoseph KoshyThe build system supports
1677b710ab2SJoseph Koshy.Xr ctags 1
1687b710ab2SJoseph Koshyand
1697b710ab2SJoseph Koshy.Nm "GNU Global" .
1707b710ab2SJoseph Koshy.El
1717b710ab2SJoseph Koshy.Pp
1727b710ab2SJoseph KoshyThe other supported targets under directory
1737b710ab2SJoseph Koshy.Pa /usr/src
1747b710ab2SJoseph Koshyare:
1757b710ab2SJoseph Koshy.Bl -tag -width ".Cm distributeworld"
1767b710ab2SJoseph Koshy.It Cm buildenv
1777b710ab2SJoseph KoshySpawn an interactive shell with environment variables set up for
1784a238795SEd Mastebuilding the system or individual components.
1794a238795SEd MasteFor cross-building the target architecture needs to be specified with
1807b710ab2SJoseph Koshy.Xr make 1
1817b710ab2SJoseph Koshyvariables
1827b710ab2SJoseph Koshy.Va TARGET_ARCH
1837b710ab2SJoseph Koshyand
1847b710ab2SJoseph Koshy.Va TARGET .
1857b710ab2SJoseph Koshy.Pp
1864a238795SEd MasteThis target is only useful after a complete toolchain (including
1874a238795SEd Mastethe compiler, linker, assembler, headers and libraries) has been
1887b710ab2SJoseph Koshybuilt; see the
1897b710ab2SJoseph Koshy.Cm toolchain
1907b710ab2SJoseph Koshytarget below.
1917b710ab2SJoseph Koshy.It Cm buildworld
1927b710ab2SJoseph KoshyBuild everything but the kernel, configure files in
1937b710ab2SJoseph Koshy.Pa etc ,
1947b710ab2SJoseph Koshyand
1957b710ab2SJoseph Koshy.Pa release .
196d90f12e3SWarren BlockThe object directory can be changed from the default
197d90f12e3SWarren Block.Pa /usr/obj
198d90f12e3SWarren Blockby setting the
199d90f12e3SWarren Block.Pa MAKEOBJDIRPREFIX
200d90f12e3SWarren Block.Xr make 1
201d90f12e3SWarren Blockvariable.
202dfa09989SBryan DreweryThe actual build location prefix used
203dfa09989SBryan Drewerydepends on the
204dfa09989SBryan Drewery.Va WITH_UNIFIED_OBJDIR
205dfa09989SBryan Dreweryoption from
206dfa09989SBryan Drewery.Xr src.conf 5 .
207dfa09989SBryan DreweryIf enabled it is
208dfa09989SBryan Drewery.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}/${TARGET}.${TARGET_ARCH}
209dfa09989SBryan Dreweryfor all builds.
210dfa09989SBryan DreweryIf disabled it is
2117b710ab2SJoseph Koshy.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
2127b710ab2SJoseph Koshyfor native builds, and
213dfa09989SBryan Drewery.Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}${.CURDIR}
2147b710ab2SJoseph Koshyfor cross builds and native builds with variable
2157b710ab2SJoseph Koshy.Va CROSS_BUILD_TESTING
2167b710ab2SJoseph Koshyset.
2173e65b7d9SWarner Losh.It Cm cleankernel
2183e65b7d9SWarner LoshAttempts to clean up targets built by a preceding
2193e65b7d9SWarner Losh.Cm buildkernel ,
2203e65b7d9SWarner Loshor similar step, built from the same source directory and
2213e65b7d9SWarner Losh.Va KERNCONF .
2227b710ab2SJoseph Koshy.It Cm cleanworld
2237b710ab2SJoseph KoshyAttempt to clean up targets built by a preceding
224c10062b9SBryan Drewery.Cm buildworld ,
2253e65b7d9SWarner Loshor similar step, built from this source directory.
226c10062b9SBryan Drewery.It Cm cleanuniverse
227c10062b9SBryan DreweryWhen
228c10062b9SBryan Drewery.Va WITH_UNIFIED_OBJDIR
229c10062b9SBryan Dreweryis enabled, attempt to clean up targets built by a preceding
230c10062b9SBryan Drewery.Cm buildworld ,
231c10062b9SBryan Drewery.Cm universe ,
232c10062b9SBryan Dreweryor similar step, for any architecture built from this source directory.
2337b710ab2SJoseph Koshy.It Cm distributeworld
2347b710ab2SJoseph KoshyDistribute everything compiled by a preceding
2357b710ab2SJoseph Koshy.Cm buildworld
2367b710ab2SJoseph Koshystep.
2377b710ab2SJoseph KoshyFiles are placed in the directory hierarchy specified by
2387b710ab2SJoseph Koshy.Xr make 1
2397b710ab2SJoseph Koshyvariable
2407b710ab2SJoseph Koshy.Va DISTDIR .
2417b710ab2SJoseph KoshyThis target is used while building a release; see
2427b710ab2SJoseph Koshy.Xr release 7 .
2437441e255SBryan Drewery.It Cm native-xtools
2447441e255SBryan DreweryThis target builds a cross-toolchain for the given
2457441e255SBryan Drewery.Sy TARGET
2467441e255SBryan Dreweryand
2477441e255SBryan Drewery.Sy TARGET_ARCH ,
2487441e255SBryan Dreweryas well as a select list of static userland tools for the host system.
2497441e255SBryan DreweryThis is intended to be used in a jail where QEMU is used to improve
2507441e255SBryan Dreweryperformance by avoiding emulating binaries that do not need to be emulated.
2517441e255SBryan Drewery.Sy TARGET
2527441e255SBryan Dreweryand
2537441e255SBryan Drewery.Sy TARGET_ARCH
2547441e255SBryan Dreweryshould be defined.
2555bd47cc5SBryan Drewery.It Cm native-xtools-install
2565bd47cc5SBryan DreweryInstalls the results to
2575bd47cc5SBryan Drewery.Pa ${DESTDIR}/${NXTP}
2585bd47cc5SBryan Drewerywhere
2595bd47cc5SBryan Drewery.Va NXTP
2605bd47cc5SBryan Drewerydefaults to
2615bd47cc5SBryan Drewery.Pa nxb-bin .
2625bd47cc5SBryan Drewery.Sy TARGET
2635bd47cc5SBryan Dreweryand
2645bd47cc5SBryan Drewery.Sy TARGET_ARCH
2655bd47cc5SBryan Drewerymust be defined.
266e8423d00SNathan Whitehorn.It Cm packageworld
267e8423d00SNathan WhitehornArchive the results of
268e8423d00SNathan Whitehorn.Cm distributeworld ,
269e8423d00SNathan Whitehornplacing the results in
270e8423d00SNathan Whitehorn.Va DISTDIR .
271e8423d00SNathan WhitehornThis target is used while building a release; see
272e8423d00SNathan Whitehorn.Xr release 7 .
2737b710ab2SJoseph Koshy.It Cm installworld
2747b710ab2SJoseph KoshyInstall everything built by a preceding
2757b710ab2SJoseph Koshy.Cm buildworld
2767b710ab2SJoseph Koshystep into the directory hierarchy pointed to by
2777b710ab2SJoseph Koshy.Xr make 1
2787b710ab2SJoseph Koshyvariable
2797b710ab2SJoseph Koshy.Va DESTDIR .
280a3aed80dSRuslan Ermilov.Pp
28104876cf3SRuslan ErmilovIf installing onto an NFS file system and running
2828ed6451eSRuslan Ermilov.Xr make 1
2838ed6451eSRuslan Ermilovwith the
28404876cf3SRuslan Ermilov.Fl j
28504876cf3SRuslan Ermilovoption, make sure that
286a3aed80dSRuslan Ermilov.Xr rpc.lockd 8
287a3aed80dSRuslan Ermilovis running on both client and server.
288a3aed80dSRuslan ErmilovSee
289a3aed80dSRuslan Ermilov.Xr rc.conf 5
290a3aed80dSRuslan Ermilovon how to make it start at boot time.
2917b710ab2SJoseph Koshy.It Cm toolchain
2927b710ab2SJoseph KoshyCreate the build toolchain needed to build the rest of the system.
2937b710ab2SJoseph KoshyFor cross-architecture builds, this step creates a cross-toolchain.
2947b710ab2SJoseph Koshy.It Cm universe
2954e889921SJohn BaldwinFor each architecture,
2964e889921SJohn Baldwinexecute a
2977b710ab2SJoseph Koshy.Cm buildworld
2984e889921SJohn Baldwinfollowed by a
2997b710ab2SJoseph Koshy.Cm buildkernel
3004e889921SJohn Baldwinfor all kernels for that architecture,
3014e889921SJohn Baldwinincluding
3024e889921SJohn Baldwin.Pa LINT .
3037b710ab2SJoseph KoshyThis command takes a long time.
304e1b9162fSWarner Losh.It Cm kernels
305e1b9162fSWarner LoshLike
306e1b9162fSWarner Losh.Cm universe
307e1b9162fSWarner Loshwith
308e1b9162fSWarner Losh.Va WITHOUT_WORLDS
309e1b9162fSWarner Loshdefined so only the kernels for each architecture are built.
310e1b9162fSWarner Losh.It Cm worlds
311e1b9162fSWarner LoshLike
312e1b9162fSWarner Losh.Cm universe
313e1b9162fSWarner Loshwith
314e1b9162fSWarner Losh.Va WITHOUT_KERNELS
315e1b9162fSWarner Loshdefined so only the worlds for each architecture are built.
316f1d16bd8SBjoern A. Zeeb.It Cm targets
317f1d16bd8SBjoern A. ZeebPrint a list of supported
318f1d16bd8SBjoern A. Zeeb.Va TARGET
319f1d16bd8SBjoern A. Zeeb/
320f1d16bd8SBjoern A. Zeeb.Va TARGET_ARCH
321f1d16bd8SBjoern A. Zeebpairs for world and kernel targets.
322eee8163bSBjoern A. Zeeb.It Cm tinderbox
323eee8163bSBjoern A. ZeebExecute the same targets as
324eee8163bSBjoern A. Zeeb.Cm universe .
325eee8163bSBjoern A. ZeebIn addition print a summary of all failed targets at the end and
326eee8163bSBjoern A. Zeebexit with an error if there were any.
3274e889921SJohn Baldwin.It Cm toolchains
3284e889921SJohn BaldwinCreate a build toolchain for each architecture supported by the build system.
329b135fb6eSBryan Drewery.It Cm xdev
330b135fb6eSBryan DreweryBuilds and installs a cross-toolchain and sysroot for the given
331b135fb6eSBryan Drewery.Sy TARGET
332b135fb6eSBryan Dreweryand
333b135fb6eSBryan Drewery.Sy TARGET_ARCH .
334b135fb6eSBryan DreweryThe sysroot contains target library and headers.
335b135fb6eSBryan DreweryThe target is an alias for
336b135fb6eSBryan Drewery.Cm xdev-build
337b135fb6eSBryan Dreweryand
338b135fb6eSBryan Drewery.Cm xdev-install .
339b135fb6eSBryan DreweryThe location of the files installed can be controlled with
340b135fb6eSBryan Drewery.Va DESTDIR .
341b135fb6eSBryan DreweryThe target location in
342b135fb6eSBryan Drewery.Va DESTDIR
343b135fb6eSBryan Dreweryis
344b135fb6eSBryan Drewery.Pa ${DESTDIR}/${XDTP}
345b135fb6eSBryan Drewerywhere
346b135fb6eSBryan Drewery.Va XDTP
347b135fb6eSBryan Drewerydefaults to
348b135fb6eSBryan Drewery.Pa /usr/${XDDIR}
349b135fb6eSBryan Dreweryand
350b135fb6eSBryan Drewery.Va XDDIR
351b135fb6eSBryan Drewerydefaults to
352b135fb6eSBryan Drewery.Pa ${TARGET_ARCH}-freebsd .
353b135fb6eSBryan Drewery.It Cm xdev-build
354b135fb6eSBryan DreweryBuilds for the
355b135fb6eSBryan Drewery.Cm xdev
356b135fb6eSBryan Drewerytarget.
357b135fb6eSBryan Drewery.It Cm xdev-install
358b135fb6eSBryan DreweryInstalls the files for the
359b135fb6eSBryan Drewery.Cm xdev
360b135fb6eSBryan Drewerytarget.
361b135fb6eSBryan Drewery.It Cm xdev-links
362b135fb6eSBryan DreweryInstalls autoconf-style symlinks to
363b135fb6eSBryan Drewery.Pa ${DESTDIR}/usr/bin
364b135fb6eSBryan Drewerypointing into the xdev toolchain in
365b135fb6eSBryan Drewery.Pa ${DESTDIR}/${XDTP} .
366786aa69aSBen Smithurst.El
367786aa69aSBen Smithurst.Pp
3687b710ab2SJoseph KoshyKernel specific build targets in
369786aa69aSBen Smithurst.Pa /usr/src
3707b710ab2SJoseph Koshyare:
371e8423d00SNathan Whitehorn.Bl -tag -width ".Cm distributekernel"
3721caae057SRuslan Ermilov.It Cm buildkernel
3731caae057SRuslan ErmilovRebuild the kernel and the kernel modules.
374d90f12e3SWarren BlockThe object directory can be changed from the default
375d90f12e3SWarren Block.Pa /usr/obj
376d90f12e3SWarren Blockby setting the
377d90f12e3SWarren Block.Pa MAKEOBJDIRPREFIX
378d90f12e3SWarren Block.Xr make 1
379d90f12e3SWarren Blockvariable.
3801caae057SRuslan Ermilov.It Cm installkernel
3817b710ab2SJoseph KoshyInstall the kernel and the kernel modules to directory
3827b710ab2SJoseph Koshy.Pa ${DESTDIR}/boot/kernel ,
3837b710ab2SJoseph Koshyrenaming any pre-existing directory with this name to
3847b710ab2SJoseph Koshy.Pa kernel.old
3857b710ab2SJoseph Koshyif it contained the currently running kernel.
3867b710ab2SJoseph KoshyThe target directory under
3877b710ab2SJoseph Koshy.Pa ${DESTDIR}
3887b710ab2SJoseph Koshymay be modified using the
3897b710ab2SJoseph Koshy.Va INSTKERNNAME
3907b710ab2SJoseph Koshyand
3917b710ab2SJoseph Koshy.Va KODIR
3927b710ab2SJoseph Koshy.Xr make 1
3937b710ab2SJoseph Koshyvariables.
394e8423d00SNathan Whitehorn.It Cm distributekernel
395e8423d00SNathan WhitehornInstall the kernel to the directory
396e8423d00SNathan Whitehorn.Pa ${DISTDIR}/kernel/boot/kernel .
397e8423d00SNathan WhitehornThis target is used while building a release; see
398e8423d00SNathan Whitehorn.Xr release 7 .
399e8423d00SNathan Whitehorn.It Cm packagekernel
400e8423d00SNathan WhitehornArchive the results of
401e8423d00SNathan Whitehorn.Cm distributekernel ,
402e8423d00SNathan Whitehornplacing the results in
403e8423d00SNathan Whitehorn.Va DISTDIR .
404e8423d00SNathan WhitehornThis target is used while building a release; see
405e8423d00SNathan Whitehorn.Xr release 7 .
406389e98a7STom Rhodes.It Cm kernel
407389e98a7STom RhodesEquivalent to
408389e98a7STom Rhodes.Cm buildkernel
409389e98a7STom Rhodesfollowed by
410389e98a7STom Rhodes.Cm installkernel
4117b710ab2SJoseph Koshy.It Cm kernel-toolchain
4127b710ab2SJoseph KoshyRebuild the tools needed for kernel compilation.
4137b710ab2SJoseph KoshyUse this if you did not do a
4147b710ab2SJoseph Koshy.Cm buildworld
4157b710ab2SJoseph Koshyfirst.
4167b710ab2SJoseph Koshy.It Cm reinstallkernel
4177b710ab2SJoseph KoshyReinstall the kernel and the kernel modules, overwriting the contents
4187b710ab2SJoseph Koshyof the target directory.
4197b710ab2SJoseph KoshyAs with the
4207b710ab2SJoseph Koshy.Cm installkernel
4217b710ab2SJoseph Koshytarget, the target directory can be specified using the
4227b710ab2SJoseph Koshy.Xr make 1
4237b710ab2SJoseph Koshyvariable
4247b710ab2SJoseph Koshy.Va INSTKERNNAME .
4257b710ab2SJoseph Koshy.El
4267b710ab2SJoseph Koshy.Pp
4277b710ab2SJoseph KoshyConvenience targets for cleaning up the install destination directory
4287b710ab2SJoseph Koshydenoted by variable
4297b710ab2SJoseph Koshy.Va DESTDIR
4307b710ab2SJoseph Koshyinclude:
4317b710ab2SJoseph Koshy.Bl -tag -width ".Cm delete-old-libs"
4327b710ab2SJoseph Koshy.It Cm check-old
433abfabbeaSMike PritchardPrint a list of old files and directories in the system.
434e2a36081SAlexander Leidinger.It Cm delete-old
435e2a36081SAlexander LeidingerDelete obsolete base system files and directories interactively.
43678ad5421SRuslan ErmilovWhen
43778ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES
4387b710ab2SJoseph Koshyis specified at the command line, the delete operation will be
4397b710ab2SJoseph Koshynon-interactive.
440c8ef0ed5SRuslan ErmilovThe variables
4417b710ab2SJoseph Koshy.Va DESTDIR ,
4427b710ab2SJoseph Koshy.Va TARGET_ARCH
443c8ef0ed5SRuslan Ermilovand
444c8ef0ed5SRuslan Ermilov.Va TARGET
445c8ef0ed5SRuslan Ermilovshould be set as with
446c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" .
447e2a36081SAlexander Leidinger.It Cm delete-old-libs
448e2a36081SAlexander LeidingerDelete obsolete base system libraries interactively.
449d90f12e3SWarren BlockThis target should only be used if no third party software uses these
4507b710ab2SJoseph Koshylibraries.
45178ad5421SRuslan ErmilovWhen
45278ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES
4537b710ab2SJoseph Koshyis specified at the command line, the delete operation will be
4547b710ab2SJoseph Koshynon-interactive.
455c8ef0ed5SRuslan ErmilovThe variables
4567b710ab2SJoseph Koshy.Va DESTDIR ,
4577b710ab2SJoseph Koshy.Va TARGET_ARCH
458c8ef0ed5SRuslan Ermilovand
459c8ef0ed5SRuslan Ermilov.Va TARGET
460c8ef0ed5SRuslan Ermilovshould be set as with
461c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" .
462786aa69aSBen Smithurst.El
463b82e53e2SMurray Stokely.Sh ENVIRONMENT
4647b710ab2SJoseph KoshyVariables that influence all builds include:
4657b710ab2SJoseph Koshy.Bl -tag -width ".Va MAKEOBJDIRPREFIX"
466fea87c03SGiorgos Keramidas.It Va DEBUG_FLAGS
467fea87c03SGiorgos KeramidasDefines a set of debugging flags that will be used to build all userland
468fea87c03SGiorgos Keramidasbinaries under
469fea87c03SGiorgos Keramidas.Pa /usr/src .
470fea87c03SGiorgos KeramidasWhen
471fea87c03SGiorgos Keramidas.Va DEBUG_FLAGS
472fea87c03SGiorgos Keramidasis defined, the
473fea87c03SGiorgos Keramidas.Cm install
474fea87c03SGiorgos Keramidasand
475fea87c03SGiorgos Keramidas.Cm installworld
476fea87c03SGiorgos Keramidastargets install binaries from the current
477fea87c03SGiorgos Keramidas.Va MAKEOBJDIRPREFIX
478fea87c03SGiorgos Keramidaswithout stripping,
479fea87c03SGiorgos Keramidasso that debugging information is retained in the installed binaries.
4807b710ab2SJoseph Koshy.It Va DESTDIR
4817b710ab2SJoseph KoshyThe directory hierarchy prefix where built objects will be installed.
4827b710ab2SJoseph KoshyIf not set,
4837b710ab2SJoseph Koshy.Va DESTDIR
4847b710ab2SJoseph Koshydefaults to the empty string.
4857b710ab2SJoseph Koshy.It Va MAKEOBJDIRPREFIX
4867b710ab2SJoseph KoshyDefines the prefix for directory names in the tree of built objects.
4877b710ab2SJoseph KoshyDefaults to
4887b710ab2SJoseph Koshy.Pa /usr/obj
4897b710ab2SJoseph Koshyif not defined.
490dfa09989SBryan DreweryThis variable should only be set in the environment or
491dfa09989SBryan Drewery.Pa /etc/src-env.conf
492dfa09989SBryan Dreweryand not via
4937b710ab2SJoseph Koshy.Pa /etc/make.conf
494dfa09989SBryan Dreweryor
495dfa09989SBryan Drewery.Pa /etc/src.conf
4967b710ab2SJoseph Koshyor the command line.
4977fa2f2a6SAlex Richardson.It Va WITHOUT_WERROR
4987b710ab2SJoseph KoshyIf defined, compiler warnings will not cause the build to halt,
4997b710ab2SJoseph Koshyeven if the makefile says otherwise.
50021edb039SAlexander Leidinger.It Va WITH_CTF
50121edb039SAlexander LeidingerIf defined, the build process will run the DTrace CTF conversion
50221edb039SAlexander Leidingertools on built objects.
5037b710ab2SJoseph Koshy.El
5047b710ab2SJoseph Koshy.Pp
5057b710ab2SJoseph KoshyAdditionally, builds in
5067b710ab2SJoseph Koshy.Pa /usr/src
5077b710ab2SJoseph Koshyare influenced by the following
5087b710ab2SJoseph Koshy.Xr make 1
5097b710ab2SJoseph Koshyvariables:
51021ef3591SJohn Baldwin.Bl -tag -width ".Va LOCAL_MODULES_DIR"
51121ef3591SJohn Baldwin.It Va CROSS_TOOLCHAIN
51221ef3591SJohn BaldwinRequests use of an external toolchain to build either the world or kernel.
51321ef3591SJohn BaldwinThis value of this variable can either be the full path to a file,
51421ef3591SJohn Baldwinor the base name of a file in
51521ef3591SJohn Baldwin.Pa ${LOCALBASE}/share/toolchains .
51621ef3591SJohn BaldwinThe file should be a make file which sets variables to request an external
51721ef3591SJohn Baldwintoolchain such as
51821ef3591SJohn Baldwin.Va XCC .
51921ef3591SJohn Baldwin.Pp
52021ef3591SJohn BaldwinExternal toolchains are available in ports for both LLVM and GCC/binutils.
52121ef3591SJohn BaldwinFor external toolchains available in ports,
52221ef3591SJohn Baldwin.Va CROSS_TOOLCHAIN
52321ef3591SJohn Baldwinshould be set to the name of the package.
52421ef3591SJohn BaldwinLLVM toolchain packages use the name llvm<major version>.
52521ef3591SJohn BaldwinGCC toolchains provide separate packages for each architecture and use the
52621ef3591SJohn Baldwinname ${MACHINE_ARCH}-gcc<major version>.
527e6cdeeddSWarner Losh.It Va KERNCONF
528e6cdeeddSWarner LoshOverrides which kernel to build and install for the various kernel
529e6cdeeddSWarner Loshmake targets.
530e6cdeeddSWarner LoshIt defaults to
531e6cdeeddSWarner Losh.Cm GENERIC .
5324b2cc4d1SKyle Evans.It Va KERNCONFDIR
5334b2cc4d1SKyle EvansOverrides the directory in which
5344b2cc4d1SKyle Evans.Va KERNCONF
5354b2cc4d1SKyle Evansand any files included by
5364b2cc4d1SKyle Evans.Va KERNCONF
5374b2cc4d1SKyle Evansshould be found.
5384b2cc4d1SKyle EvansDefaults to
5394b2cc4d1SKyle Evans.Pa sys/${ARCH}/conf .
540e6cdeeddSWarner Losh.It Va KERNFAST
541e6cdeeddSWarner LoshIf set, the build target
542e6cdeeddSWarner Losh.Cm buildkernel
543e6cdeeddSWarner Loshdefaults to setting
544e6cdeeddSWarner Losh.Va NO_KERNELCLEAN ,
5456d50d5e4SWarner Losh.Va NO_KERNELCONFIG ,
546e6cdeeddSWarner Loshand
5476d50d5e4SWarner Losh.Va NO_KERNELOBJ .
548e6cdeeddSWarner LoshWhen set to a value other than
549e6cdeeddSWarner Losh.Cm 1
550e6cdeeddSWarner Loshthen
551e6cdeeddSWarner Losh.Va KERNCONF
552e6cdeeddSWarner Loshis set to the value of
553e6cdeeddSWarner Losh.Va KERNFAST .
5547b710ab2SJoseph Koshy.It Va LOCAL_DIRS
555ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
556ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
557ca6a54ceSBryan Drewery.Cm everything
558ca6a54ceSBryan Drewerytarget.
559e93e5bb0SIan LeporeThe directories are built in parallel with each other,
560e93e5bb0SIan Leporeand with the base system directories.
561e93e5bb0SIan LeporeInsert a
562e93e5bb0SIan Lepore.Va .WAIT
563e93e5bb0SIan Leporedirective at the beginning of the
564e93e5bb0SIan Lepore.Va LOCAL_DIRS
565e93e5bb0SIan Leporelist to ensure all base system directories are built first.
566e93e5bb0SIan Lepore.Va .WAIT
567e93e5bb0SIan Leporemay also be used as needed elsewhere within the list.
568a0e6a013SBryan Drewery.It Va LOCAL_ITOOLS
569a0e6a013SBryan DreweryIf set, this variable supplies a list of additional tools that are used by the
570a0e6a013SBryan Drewery.Cm installworld
571a0e6a013SBryan Dreweryand
572a0e6a013SBryan Drewery.Cm distributeworld
573a0e6a013SBryan Drewerytargets.
574ca6a54ceSBryan Drewery.It Va LOCAL_LIB_DIRS
575ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
576ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
577ca6a54ceSBryan Drewery.Cm libraries
578ca6a54ceSBryan Drewerytarget.
579e93e5bb0SIan LeporeThe directories are built in parallel with each other,
580e93e5bb0SIan Leporeand with the base system libraries.
581e93e5bb0SIan LeporeInsert a
582e93e5bb0SIan Lepore.Va .WAIT
583e93e5bb0SIan Leporedirective at the beginning of the
584e93e5bb0SIan Lepore.Va LOCAL_DIRS
585e93e5bb0SIan Leporelist to ensure all base system libraries are built first.
586e93e5bb0SIan Lepore.Va .WAIT
587e93e5bb0SIan Leporemay also be used as needed elsewhere within the list.
588ca6a54ceSBryan Drewery.It Va LOCAL_MTREE
589ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional mtrees relative to the
590ca6a54ceSBryan Dreweryroot of the source tree to use as part of the
591ca6a54ceSBryan Drewery.Cm hierarchy
592ca6a54ceSBryan Drewerytarget.
59380cedb80SBryan Drewery.It Va LOCAL_LEGACY_DIRS
59480cedb80SBryan DreweryIf set, this variable supplies a list of additional directories relative to
59580cedb80SBryan Drewerythe root of the source tree to build as part of the
59680cedb80SBryan Drewery.Cm legacy
59780cedb80SBryan Drewerytarget.
59880cedb80SBryan Drewery.It Va LOCAL_BSTOOL_DIRS
59980cedb80SBryan DreweryIf set, this variable supplies a list of additional directories relative to
60080cedb80SBryan Drewerythe root of the source tree to build as part of the
60180cedb80SBryan Drewery.Cm bootstrap-tools
60280cedb80SBryan Drewerytarget.
603ca6a54ceSBryan Drewery.It Va LOCAL_TOOL_DIRS
604ca6a54ceSBryan DreweryIf set, this variable supplies a list of additional directories relative to
605ca6a54ceSBryan Drewerythe root of the source tree to build as part of the
606ca6a54ceSBryan Drewery.Cm build-tools
607ca6a54ceSBryan Drewerytarget.
6084143850bSBryan Drewery.It Va LOCAL_XTOOL_DIRS
6094143850bSBryan DreweryIf set, this variable supplies a list of additional directories relative to
6104143850bSBryan Drewerythe root of the source tree to build as part of the
6114143850bSBryan Drewery.Cm cross-tools
6124143850bSBryan Drewerytarget.
613170c2788SGlen Barber.It Va PORTS_MODULES
614170c2788SGlen BarberA list of ports with kernel modules that should be built and installed
615170c2788SGlen Barberas part of the
616170c2788SGlen Barber.Cm buildkernel
617170c2788SGlen Barberand
618170c2788SGlen Barber.Cm installkernel
619170c2788SGlen Barberprocess.
620170c2788SGlen Barber.Bd -literal -offset indent
6217fbc0c98SMitchell Hornemake PORTS_MODULES=emulators/virtualbox-ose-kmod kernel
622170c2788SGlen Barber.Ed
623e7a13643SMark Johnston.It Va LOCAL_MODULES
624e7a13643SMark JohnstonA list of external kernel modules that should be built and installed
625e7a13643SMark Johnstonas part of the
626e7a13643SMark Johnston.Cm buildkernel
627e7a13643SMark Johnstonand
628e7a13643SMark Johnston.Cm installkernel
629e7a13643SMark Johnstonprocess.
630805c3af8SMark JohnstonDefaults to the list of sub-directories of
631805c3af8SMark Johnston.Va LOCAL_MODULES_DIR .
632e7a13643SMark Johnston.It Va LOCAL_MODULES_DIR
633e7a13643SMark JohnstonThe directory in which to search for the kernel modules specified by
634e7a13643SMark Johnston.Va LOCAL_MODULES .
635e7a13643SMark JohnstonEach kernel module should consist of a directory containing a makefile.
636e7a13643SMark JohnstonDefaults to
637e7a13643SMark Johnston.Pa ${LOCALBASE}/sys/modules .
638e6ca6901SGordon Bergling.It Va SRCCONF
639e6ca6901SGordon BerglingSpecify a file to override the default
640e6ca6901SGordon Bergling.Pa /etc/src.conf .
641e6ca6901SGordon BerglingThe src.conf file controls the components to build.
642e6ca6901SGordon BerglingSee
643e6ca6901SGordon Bergling.Xr src.conf 5
64442e7be20SEnji Cooper.It Va STRIPBIN
6453547290fSEnji CooperCommand to use at install time when stripping binaries.
6463547290fSEnji CooperBe sure to add any additional tools required to run
64742e7be20SEnji Cooper.Va STRIPBIN
6483547290fSEnji Cooperto the
6493547290fSEnji Cooper.Va LOCAL_ITOOLS
6503547290fSEnji Cooper.Xr make 1
6513547290fSEnji Coopervariable before running the
6523547290fSEnji Cooper.Cm distributeworld
6533547290fSEnji Cooperor
6543547290fSEnji Cooper.Cm installworld
6553547290fSEnji Coopertargets.
6563547290fSEnji CooperSee
6573547290fSEnji Cooper.Xr install 1
6583547290fSEnji Cooperfor more details.
6597b710ab2SJoseph Koshy.It Va SUBDIR_OVERRIDE
6607b710ab2SJoseph KoshyOverride the default list of sub-directories and only build the
6617b710ab2SJoseph Koshysub-directory named in this variable.
6627f1636b7SBryan DreweryIf combined with
6637f1636b7SBryan Drewery.Cm buildworld
6647f1636b7SBryan Drewerythen all libraries and includes, and some of the build tools will still build
6657f1636b7SBryan Dreweryas well.
666c889d480SBryan DrewerySpecifying
667c889d480SBryan Drewery.Cm -DNO_LIBS ,
668c889d480SBryan Dreweryand
669c889d480SBryan Drewery.Cm -DWORLDFAST
670c889d480SBryan Drewerywill only build the specified directory as was done historically.
6717f1636b7SBryan DreweryWhen combined with
6727f1636b7SBryan Drewery.Cm buildworld
673*ffc4f93eSBenedict Reuschlingit is necessary to override
6747f1636b7SBryan Drewery.Va LOCAL_LIB_DIRS
6757f1636b7SBryan Drewerywith any custom directories containing libraries.
6767f1636b7SBryan DreweryThis allows building a subset of the system in the same way as
6777f1636b7SBryan Drewery.Cm buildworld
6787f1636b7SBryan Drewerydoes using its sysroot handling.
6797f1636b7SBryan DreweryThis variable can also be useful when debugging failed builds.
6807b710ab2SJoseph Koshy.Bd -literal -offset indent
6817b710ab2SJoseph Koshymake some-target SUBDIR_OVERRIDE=foo/bar
6827b710ab2SJoseph Koshy.Ed
683def657b8SWarner Losh.It Va SYSDIR
684def657b8SWarner LoshSpecify the location of the kernel source to override the default
685def657b8SWarner Losh.Pa /usr/src/sys .
686def657b8SWarner LoshThe kernel source is located in the
687def657b8SWarner Losh.Pa sys
688def657b8SWarner Loshsubdirectory of the source tree checked out from the
689def657b8SWarner Losh.Pa src.git
690def657b8SWarner Loshrepository.
6916f9ac6feSMurray Stokely.It Va TARGET
692b3a43ea3SMurray StokelyThe target hardware platform.
693365a17c0SMurray StokelyThis is analogous to the
6941caae057SRuslan Ermilov.Dq Nm uname Fl m
695b3a43ea3SMurray Stokelyoutput.
696b3a43ea3SMurray StokelyThis is necessary to cross-build some target architectures.
6972f6a7e42SEnji CooperFor example, cross-building for ARM64 machines requires
6982f6a7e42SEnji Cooper.Va TARGET_ARCH Ns = Ns Li aarch64
699b3a43ea3SMurray Stokelyand
7002f6a7e42SEnji Cooper.Va TARGET Ns = Ns Li arm64 .
7017b710ab2SJoseph KoshyIf not set,
7027b710ab2SJoseph Koshy.Va TARGET
703f4721165SEdward Tomasz Napieraladefaults to the current hardware platform, unless
704f4721165SEdward Tomasz Napierala.Va TARGET_ARCH
705f4721165SEdward Tomasz Napieralais also set, in which case it defaults to the appropriate
706f4721165SEdward Tomasz Napieralavalue for that architecture.
7077b710ab2SJoseph Koshy.It Va TARGET_ARCH
7087b710ab2SJoseph KoshyThe target machine processor architecture.
7097b710ab2SJoseph KoshyThis is analogous to the
7107b710ab2SJoseph Koshy.Dq Nm uname Fl p
7117b710ab2SJoseph Koshyoutput.
7127b710ab2SJoseph KoshySet this to cross-build for a different architecture.
7137b710ab2SJoseph KoshyIf not set,
7147b710ab2SJoseph Koshy.Va TARGET_ARCH
715531b260aSWarner Loshdefaults to the current machine architecture, unless
716531b260aSWarner Losh.Va TARGET
717531b260aSWarner Loshis also set, in which case it defaults to the appropriate
718531b260aSWarner Loshvalue for that platform.
719c22c7f86SWarner LoshTypically, one only needs to set
720c22c7f86SWarner Losh.Va TARGET .
7217b710ab2SJoseph Koshy.El
7227b710ab2SJoseph Koshy.Pp
7237b710ab2SJoseph KoshyBuilds under directory
724fd23b461SGiorgos Keramidas.Pa /usr/src
7257d6af40dSGlen Barberare also influenced by defining one or more of the following symbols,
726fd23b461SGiorgos Keramidasusing the
727fd23b461SGiorgos Keramidas.Fl D
728fd23b461SGiorgos Keramidasoption of
729fd23b461SGiorgos Keramidas.Xr make 1 :
73021ef3591SJohn Baldwin.Bl -tag -width ".Va LOADER_DEFAULT_INTERP"
73101012c64SWarner Losh.It Va LOADER_DEFAULT_INTERP
73201012c64SWarner LoshDefines what interpreter the default loader program will have.
73301012c64SWarner LoshValid values include
73401012c64SWarner Losh.Dq 4th ,
73501012c64SWarner Losh.Dq lua ,
73601012c64SWarner Loshand
73701012c64SWarner Losh.Dq simp .
73801012c64SWarner LoshThis creates the default link for
73901012c64SWarner Losh.Pa /boot/loader
74001012c64SWarner Loshto the loader with that interpreter.
74101012c64SWarner LoshIt also determines what interpreter is compiled into
74201012c64SWarner Losh.Pa userboot .
743fd23b461SGiorgos Keramidas.It Va NO_CLEANDIR
744fd23b461SGiorgos KeramidasIf set, the build targets that clean parts of the object tree use the
745fd23b461SGiorgos Keramidasequivalent of
746fd23b461SGiorgos Keramidas.Dq make clean
747fd23b461SGiorgos Keramidasinstead of
748fd23b461SGiorgos Keramidas.Dq make cleandir .
749fd23b461SGiorgos Keramidas.It Va NO_CLEAN
750fd23b461SGiorgos KeramidasIf set, no object tree files are cleaned at all.
751473fda75SBryan DreweryThis is the default when
752473fda75SBryan Drewery.Va WITH_META_MODE
753473fda75SBryan Dreweryis used with
754473fda75SBryan Drewery.Xr filemon 4
755473fda75SBryan Dreweryloaded.
756473fda75SBryan DrewerySee
757473fda75SBryan Drewery.Xr src.conf 5
758473fda75SBryan Dreweryfor more details.
759fd23b461SGiorgos KeramidasSetting
760fd23b461SGiorgos Keramidas.Va NO_CLEAN
761fd23b461SGiorgos Keramidasimplies
762fd23b461SGiorgos Keramidas.Va NO_KERNELCLEAN ,
763fd23b461SGiorgos Keramidasso when
764fd23b461SGiorgos Keramidas.Va NO_CLEAN
765fd23b461SGiorgos Keramidasis set no kernel objects are cleaned either.
766fd23b461SGiorgos Keramidas.It Va NO_CTF
767fd23b461SGiorgos KeramidasIf set, the build process does not run the DTrace CTF conversion tools
768fd23b461SGiorgos Keramidason built objects.
769fd23b461SGiorgos Keramidas.It Va NO_SHARE
770fd23b461SGiorgos KeramidasIf set, the build does not descend into the
771fd23b461SGiorgos Keramidas.Pa /usr/src/share
772d90f12e3SWarren Blocksubdirectory (i.e., manual pages, locale data files, timezone data files and
773fd23b461SGiorgos Keramidasother
774fd23b461SGiorgos Keramidas.Pa /usr/src/share
775fd23b461SGiorgos Keramidasfiles will not be rebuild from their sources).
776fd23b461SGiorgos Keramidas.It Va NO_KERNELCLEAN
777fd23b461SGiorgos KeramidasIf set, the build process does not run
778fd23b461SGiorgos Keramidas.Dq make clean
779fd23b461SGiorgos Keramidasas part of the
780fd23b461SGiorgos Keramidas.Cm buildkernel
781fd23b461SGiorgos Keramidastarget.
782fd23b461SGiorgos Keramidas.It Va NO_KERNELCONFIG
783fd23b461SGiorgos KeramidasIf set, the build process does not run
784fd23b461SGiorgos Keramidas.Xr config 8
785fd23b461SGiorgos Keramidasas part of the
786fd23b461SGiorgos Keramidas.Cm buildkernel
787fd23b461SGiorgos Keramidastarget.
7886d50d5e4SWarner Losh.It Va NO_KERNELOBJ
7896d50d5e4SWarner LoshIf set, the build process does not run
7906d50d5e4SWarner Losh.Dq make obj
7916d50d5e4SWarner Loshas part of the
7926d50d5e4SWarner Losh.Cm buildkernel
7936d50d5e4SWarner Loshtarget.
794c596c287SBryan Drewery.It Va NO_LIBS
795c596c287SBryan DreweryIf set, the libraries phase will be skipped.
7962abeba9dSBryan Drewery.It Va NO_OBJWALK
7976d75a7a8SBryan DreweryIf set, no object directories will be created.
7986d75a7a8SBryan DreweryThis should only be used if object directories were created in a
7996d75a7a8SBryan Dreweryprevious build and no new directories are connected.
80021ef3591SJohn Baldwin.It Va UNIVERSE_TOOLCHAIN
80121ef3591SJohn BaldwinRequests use of the toolchain built as part of the
80221ef3591SJohn Baldwin.Cm universe
80321ef3591SJohn Baldwintarget as an external toolchain.
80416892c77SBryan Drewery.It Va WORLDFAST
80516892c77SBryan DreweryIf set, the build target
80616892c77SBryan Drewery.Cm buildworld
80716892c77SBryan Drewerydefaults to setting
80816892c77SBryan Drewery.Va NO_CLEAN ,
8092abeba9dSBryan Drewery.Va NO_OBJWALK ,
81016892c77SBryan Dreweryand will skip most bootstrap phases.
81116892c77SBryan DreweryIt will only bootstrap libraries and build all of userland.
81216892c77SBryan DreweryThis option should be used only when it is known that none of the bootstrap
81316892c77SBryan Dreweryneeds changed and that no new directories have been connected to the build.
814fd23b461SGiorgos Keramidas.El
815fd23b461SGiorgos Keramidas.Pp
816fd23b461SGiorgos KeramidasBuilds under directory
8177b710ab2SJoseph Koshy.Pa /usr/doc
8187b710ab2SJoseph Koshyare influenced by the following
8197b710ab2SJoseph Koshy.Xr make 1
8207b710ab2SJoseph Koshyvariables:
8217b710ab2SJoseph Koshy.Bl -tag -width ".Va DOC_LANG"
8227b710ab2SJoseph Koshy.It Va DOC_LANG
8237b710ab2SJoseph KoshyIf set, restricts the documentation build to the language subdirectories
8247b710ab2SJoseph Koshyspecified as its content.
8257b710ab2SJoseph KoshyThe default action is to build documentation for all languages.
826b82e53e2SMurray Stokely.El
8274e889921SJohn Baldwin.Pp
8284e889921SJohn BaldwinBuilds using the
8294e889921SJohn Baldwin.Cm universe
830e1b9162fSWarner Loshand related targets are influenced by the following
8314e889921SJohn Baldwin.Xr make 1
8324e889921SJohn Baldwinvariables:
83321ef3591SJohn Baldwin.Bl -tag -width ".Va USE_GCC_TOOLCHAINS"
8344e889921SJohn Baldwin.It Va JFLAG
8354e889921SJohn BaldwinPass the value of this variable to each
8364e889921SJohn Baldwin.Xr make 1
8374e889921SJohn Baldwininvocation used to build worlds and kernels.
8384e889921SJohn BaldwinThis can be used to enable multiple jobs within a single architecture's build
8394e889921SJohn Baldwinwhile still building each architecture serially.
8404e889921SJohn Baldwin.It Va MAKE_JUST_KERNELS
8414e889921SJohn BaldwinOnly build kernels for each supported architecture.
8424e889921SJohn Baldwin.It Va MAKE_JUST_WORLDS
8434e889921SJohn BaldwinOnly build worlds for each supported architecture.
844a7783b5aSWarner Losh.It Va WITHOUT_WORLDS
845a7783b5aSWarner LoshOnly build kernels for each supported architecture.
846a7783b5aSWarner Losh.It Va WITHOUT_KERNELS
847a7783b5aSWarner LoshOnly build worlds for each supported architecture.
8484e889921SJohn Baldwin.It Va UNIVERSE_TARGET
8494e889921SJohn BaldwinExecute the specified
8504e889921SJohn Baldwin.Xr make 1
8514e889921SJohn Baldwintarget for each supported architecture instead of the default action of
8524e889921SJohn Baldwinbuilding a world and one or more kernels.
853a7783b5aSWarner LoshThis variable implies
854a7783b5aSWarner Losh.Va WITHOUT_KERNELS .
85521ef3591SJohn Baldwin.It Va USE_GCC_TOOLCHAINS
85621ef3591SJohn BaldwinUse external GCC toolchains to build the requested targets.
85721ef3591SJohn BaldwinIf the required toolchain package for a supported architecture is not installed,
85821ef3591SJohn Baldwinthe build for that architecture is skipped.
859e1b9162fSWarner Losh.It Va TARGETS
860e1b9162fSWarner LoshOnly build the listed targets instead of each supported architecture.
861e1b9162fSWarner Losh.It Va EXTRA_TARGETS
862e1b9162fSWarner LoshIn addition to the supported architectures, build the semi-supported
863e1b9162fSWarner Losharchitectures.
864e1b9162fSWarner LoshA semi-supported architecture has build support in the
865e1b9162fSWarner Losh.Fx
866e1b9162fSWarner Loshtree, but receives significantly less testing and is generally for
867e1b9162fSWarner Loshfringe uses that do not have a wide appeal.
8684e889921SJohn Baldwin.El
869786aa69aSBen Smithurst.Sh FILES
8700c0eb9beSRuslan Ermilov.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
871786aa69aSBen Smithurst.It Pa /usr/doc/Makefile
872786aa69aSBen Smithurst.It Pa /usr/doc/share/mk/doc.project.mk
873786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.port.mk
874786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.sites.mk
8751caae057SRuslan Ermilov.It Pa /usr/share/examples/etc/make.conf
8760c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile
8770c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile.inc1
8783136363fSRuslan Ermilov.El
8793faf5fc9SBen Smithurst.Sh EXAMPLES
880be6a4760SRuslan ErmilovFor an
8813faf5fc9SBen Smithurst.Dq approved
8827b710ab2SJoseph Koshymethod of updating your system from the latest sources, please see the
883be6a4760SRuslan Ermilov.Sx COMMON ITEMS
884be6a4760SRuslan Ermilovsection in
885be6a4760SRuslan Ermilov.Pa src/UPDATING .
886b82e53e2SMurray Stokely.Pp
887b82e53e2SMurray StokelyThe following sequence of commands can be used to cross-build the
888f4721165SEdward Tomasz Napieralasystem for the armv6 architecture on an amd64 host:
889b82e53e2SMurray Stokely.Bd -literal -offset indent
890b82e53e2SMurray Stokelycd /usr/src
891f4721165SEdward Tomasz Napieralamake TARGET_ARCH=armv6 buildworld buildkernel
892ecc0f5f6SEdward Tomasz Napieralamake TARGET_ARCH=armv6 DESTDIR=/clients/arm installworld installkernel
893b82e53e2SMurray Stokely.Ed
89459e11f39SBenedict Reuschling.Sh HISTORY
89559e11f39SBenedict ReuschlingThe
89659e11f39SBenedict Reuschling.Nm
89759e11f39SBenedict Reuschlingmanpage first appeared in
89859e11f39SBenedict Reuschling.Fx 4.3 .
899786aa69aSBen Smithurst.Sh SEE ALSO
9007c20a493SBen Smithurst.Xr cc 1 ,
901786aa69aSBen Smithurst.Xr install 1 ,
902786aa69aSBen Smithurst.Xr make 1 ,
903786aa69aSBen Smithurst.Xr make.conf 5 ,
904157376baSJoseph Koshy.Xr src.conf 5 ,
905f4721165SEdward Tomasz Napierala.Xr arch 7 ,
906e444a4c6SFernando Apesteguía.Xr pkg 7 ,
907a81996b6SBen Smithurst.Xr ports 7 ,
908a54bda91SMurray Stokely.Xr release 7 ,
90953837b18SEnji Cooper.Xr tests 7 ,
91061001d75STom Rhodes.Xr config 8 ,
911664eefe2SMateusz Piotrowski.Xr etcupdate 8 ,
912a81996b6SBen Smithurst.Xr reboot 8 ,
91353837b18SEnji Cooper.Xr shutdown 8
914786aa69aSBen Smithurst.Sh AUTHORS
915a63d6c94SBaptiste Daroussin.An Mike W. Meyer Aq Mt mwm@mired.org
916