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*50a994c9SWarren Block.Dd June 27, 2012 28786aa69aSBen Smithurst.Dt BUILD 7 293d45e180SRuslan Ermilov.Os 30786aa69aSBen Smithurst.Sh NAME 31786aa69aSBen Smithurst.Nm build 32eb083802SRuslan Ermilov.Nd information 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 . 42*50a994c9SWarren BlockThese directories may be initially empty or non-existent until updated with 43*50a994c9SWarren Block.Xr csup 1 44*50a994c9SWarren Blockor 45*50a994c9SWarren Block.Xr svn 1 . 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 691caae057SRuslan Ermilovcommand in any directory or 70786aa69aSBen Smithurstsubdirectory of those directories has the same effect as issuing the 711caae057SRuslan Ermilovsame command in all subdirectories of that directory. 721caae057SRuslan ErmilovWith no target specified, the things in that directory are just built. 737b710ab2SJoseph Koshy.Pp 747b710ab2SJoseph KoshyA source tree is allowed to be read-only. 757b710ab2SJoseph KoshyAs described in 767b710ab2SJoseph Koshy.Xr make 1 , 777b710ab2SJoseph Koshyobjects are usually built in a separate object directory hierarchy 787b710ab2SJoseph Koshyspecified by the environment variable 797b710ab2SJoseph Koshy.Va MAKEOBJDIRPREFIX , 807b710ab2SJoseph Koshyor under 817b710ab2SJoseph Koshy.Pa /usr/obj 827b710ab2SJoseph Koshyif variable 837b710ab2SJoseph Koshy.Va MAKEOBJDIRPREFIX 847b710ab2SJoseph Koshyis not set. 857b710ab2SJoseph KoshyFor a given source directory, its canonical object directory 867b710ab2SJoseph Koshywould be 877b710ab2SJoseph Koshy.Pa ${MAKEOBJDIRPREFIX}${.CURDIR} 887b710ab2SJoseph Koshyif 897b710ab2SJoseph Koshy.Xr make 1 907b710ab2SJoseph Koshyvariable 917b710ab2SJoseph Koshy.Va MAKEOBJDIRPREFIX 927b710ab2SJoseph Koshyis set, or 937b710ab2SJoseph Koshy.Pa /usr/obj${.CURDIR} 947b710ab2SJoseph Koshyif this variable is not set. 957b710ab2SJoseph KoshyCross-builds set the object directory as described in the 967b710ab2SJoseph Koshydocumentation for the 977b710ab2SJoseph Koshy.Cm buildworld 987b710ab2SJoseph Koshytarget below. 997b710ab2SJoseph Koshy.Pp 1007b710ab2SJoseph KoshyThe build may be controlled by defining 1017b710ab2SJoseph Koshy.Xr make 1 1027b710ab2SJoseph Koshyvariables described in the 1037b710ab2SJoseph Koshy.Sx ENVIRONMENT 1047b710ab2SJoseph Koshysection below, and by the variables documented in 1057b710ab2SJoseph Koshy.Xr make.conf 5 . 1067b710ab2SJoseph Koshy.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" 1101caae057SRuslan Ermilov.It Cm clean 1117b710ab2SJoseph KoshyRemove any files created during the build process. 1127b710ab2SJoseph Koshy.It Cm cleandepend 1137b710ab2SJoseph KoshyRemove the file 1147b710ab2SJoseph Koshy.Pa ${.OBJDIR}/${DEPENDFILE} 1157b710ab2SJoseph Koshygenerated by a prior 1167b710ab2SJoseph Koshy.Dq Li "make depend" 1177b710ab2SJoseph Koshystep. 1187b710ab2SJoseph Koshy.It Cm cleandir 1197b710ab2SJoseph KoshyRemove the canonical object directory if it exists, or perform 1207b710ab2SJoseph Koshyactions equivalent to 1217b710ab2SJoseph Koshy.Dq Li "make clean cleandepend" 1227b710ab2SJoseph Koshyif it does not. 1237b710ab2SJoseph KoshyThis target will also remove an 1247b710ab2SJoseph Koshy.Pa obj 1257b710ab2SJoseph Koshylink in 1267b710ab2SJoseph Koshy.Pa ${.CURDIR} 1277b710ab2SJoseph Koshyif that exists. 1287b710ab2SJoseph Koshy.Pp 1297b710ab2SJoseph KoshyIt is advisable to run 1307b710ab2SJoseph Koshy.Dq Li "make cleandir" 1317b710ab2SJoseph Koshytwice: the first invocation will remove the canonical object directory 1327b710ab2SJoseph Koshyand the second one will clean up 1337b710ab2SJoseph Koshy.Pa ${.CURDIR} . 1347b710ab2SJoseph Koshy.It Cm depend 1357b710ab2SJoseph KoshyGenerate a list of build dependencies in file 1367b710ab2SJoseph Koshy.Pa ${.OBJDIR}/${DEPENDFILE} . 1371caae057SRuslan Ermilov.It Cm install 1387b710ab2SJoseph KoshyInstall the results of the build to the appropriate location in the 1397b710ab2SJoseph Koshyinstallation directory hierarchy specified in variable 1407b710ab2SJoseph Koshy.Va DESTDIR . 1417b710ab2SJoseph Koshy.It Cm obj 1427b710ab2SJoseph KoshyCreate the canonical object directory associated with the current 1437b710ab2SJoseph Koshydirectory. 1447b710ab2SJoseph Koshy.It Cm objlink 1457b710ab2SJoseph KoshyCreate a symbolic link to the canonical object directory in 1467b710ab2SJoseph Koshy.Pa ${.CURDIR} . 1477b710ab2SJoseph Koshy.It Cm tags 1487b710ab2SJoseph KoshyGenerate a tags file using the program specified in the 1497b710ab2SJoseph Koshy.Xr make 1 1507b710ab2SJoseph Koshyvariable 1517b710ab2SJoseph Koshy.Va CTAGS . 1527b710ab2SJoseph KoshyThe build system supports 1537b710ab2SJoseph Koshy.Xr ctags 1 1547b710ab2SJoseph Koshyand 1557b710ab2SJoseph Koshy.Nm "GNU Global" . 1567b710ab2SJoseph Koshy.El 1577b710ab2SJoseph Koshy.Pp 1587b710ab2SJoseph KoshyThe other supported targets under directory 1597b710ab2SJoseph Koshy.Pa /usr/src 1607b710ab2SJoseph Koshyare: 1617b710ab2SJoseph Koshy.Bl -tag -width ".Cm distributeworld" 1627b710ab2SJoseph Koshy.It Cm buildenv 1637b710ab2SJoseph KoshySpawn an interactive shell with environment variables set up for 1647b710ab2SJoseph Koshycross-building the system. 1657b710ab2SJoseph KoshyThe target architecture needs to be specified with 1667b710ab2SJoseph Koshy.Xr make 1 1677b710ab2SJoseph Koshyvariables 1687b710ab2SJoseph Koshy.Va TARGET_ARCH 1697b710ab2SJoseph Koshyand 1707b710ab2SJoseph Koshy.Va TARGET . 1717b710ab2SJoseph Koshy.Pp 1727b710ab2SJoseph KoshyThis target is only useful after a complete cross-toolchain including 1737b710ab2SJoseph Koshythe compiler, linker, assembler, headers and libraries has been 1747b710ab2SJoseph Koshybuilt; see the 1757b710ab2SJoseph Koshy.Cm toolchain 1767b710ab2SJoseph Koshytarget below. 1777b710ab2SJoseph Koshy.It Cm buildworld 1787b710ab2SJoseph KoshyBuild everything but the kernel, configure files in 1797b710ab2SJoseph Koshy.Pa etc , 1807b710ab2SJoseph Koshyand 1817b710ab2SJoseph Koshy.Pa release . 1827b710ab2SJoseph KoshyThe actual build location prefix used is 1837b710ab2SJoseph Koshy.Pa ${MAKEOBJDIRPREFIX}${.CURDIR} 1847b710ab2SJoseph Koshyfor native builds, and 1857b710ab2SJoseph Koshy.Pa ${MAKEOBJDIRPREFIX}/${TARGET}${.CURDIR} 1867b710ab2SJoseph Koshyfor cross builds and native builds with variable 1877b710ab2SJoseph Koshy.Va CROSS_BUILD_TESTING 1887b710ab2SJoseph Koshyset. 1897b710ab2SJoseph Koshy.It Cm cleanworld 1907b710ab2SJoseph KoshyAttempt to clean up targets built by a preceding 1917b710ab2SJoseph Koshy.Cm buildworld 1927b710ab2SJoseph Koshystep. 1937b710ab2SJoseph Koshy.It Cm distributeworld 1947b710ab2SJoseph KoshyDistribute everything compiled by a preceding 1957b710ab2SJoseph Koshy.Cm buildworld 1967b710ab2SJoseph Koshystep. 1977b710ab2SJoseph KoshyFiles are placed in the directory hierarchy specified by 1987b710ab2SJoseph Koshy.Xr make 1 1997b710ab2SJoseph Koshyvariable 2007b710ab2SJoseph Koshy.Va DISTDIR . 2017b710ab2SJoseph KoshyThis target is used while building a release; see 2027b710ab2SJoseph Koshy.Xr release 7 . 203e8423d00SNathan Whitehorn.It Cm packageworld 204e8423d00SNathan WhitehornArchive the results of 205e8423d00SNathan Whitehorn.Cm distributeworld , 206e8423d00SNathan Whitehornplacing the results in 207e8423d00SNathan Whitehorn.Va DISTDIR . 208e8423d00SNathan WhitehornThis target is used while building a release; see 209e8423d00SNathan Whitehorn.Xr release 7 . 2107b710ab2SJoseph Koshy.It Cm installworld 2117b710ab2SJoseph KoshyInstall everything built by a preceding 2127b710ab2SJoseph Koshy.Cm buildworld 2137b710ab2SJoseph Koshystep into the directory hierarchy pointed to by 2147b710ab2SJoseph Koshy.Xr make 1 2157b710ab2SJoseph Koshyvariable 2167b710ab2SJoseph Koshy.Va DESTDIR . 217a3aed80dSRuslan Ermilov.Pp 21804876cf3SRuslan ErmilovIf installing onto an NFS file system and running 2198ed6451eSRuslan Ermilov.Xr make 1 2208ed6451eSRuslan Ermilovwith the 22104876cf3SRuslan Ermilov.Fl j 22204876cf3SRuslan Ermilovoption, make sure that 223a3aed80dSRuslan Ermilov.Xr rpc.lockd 8 224a3aed80dSRuslan Ermilovis running on both client and server. 225a3aed80dSRuslan ErmilovSee 226a3aed80dSRuslan Ermilov.Xr rc.conf 5 227a3aed80dSRuslan Ermilovon how to make it start at boot time. 2287b710ab2SJoseph Koshy.It Cm toolchain 2297b710ab2SJoseph KoshyCreate the build toolchain needed to build the rest of the system. 2307b710ab2SJoseph KoshyFor cross-architecture builds, this step creates a cross-toolchain. 2317b710ab2SJoseph Koshy.It Cm universe 2324e889921SJohn BaldwinFor each architecture, 2334e889921SJohn Baldwinexecute a 2347b710ab2SJoseph Koshy.Cm buildworld 2354e889921SJohn Baldwinfollowed by a 2367b710ab2SJoseph Koshy.Cm buildkernel 2374e889921SJohn Baldwinfor all kernels for that architecture, 2384e889921SJohn Baldwinincluding 2394e889921SJohn Baldwin.Pa LINT . 2407b710ab2SJoseph KoshyThis command takes a long time. 2411caae057SRuslan Ermilov.It Cm update 2427b710ab2SJoseph KoshyGet updated sources as configured in 24308b91343SYaroslav Tykhiy.Xr make.conf 5 . 244f1d16bd8SBjoern A. Zeeb.It Cm targets 245f1d16bd8SBjoern A. ZeebPrint a list of supported 246f1d16bd8SBjoern A. Zeeb.Va TARGET 247f1d16bd8SBjoern A. Zeeb/ 248f1d16bd8SBjoern A. Zeeb.Va TARGET_ARCH 249f1d16bd8SBjoern A. Zeebpairs for world and kernel targets. 250eee8163bSBjoern A. Zeeb.It Cm tinderbox 251eee8163bSBjoern A. ZeebExecute the same targets as 252eee8163bSBjoern A. Zeeb.Cm universe . 253eee8163bSBjoern A. ZeebIn addition print a summary of all failed targets at the end and 254eee8163bSBjoern A. Zeebexit with an error if there were any. 2554e889921SJohn Baldwin.It Cm toolchains 2564e889921SJohn BaldwinCreate a build toolchain for each architecture supported by the build system. 257786aa69aSBen Smithurst.El 258786aa69aSBen Smithurst.Pp 2597b710ab2SJoseph KoshyKernel specific build targets in 260786aa69aSBen Smithurst.Pa /usr/src 2617b710ab2SJoseph Koshyare: 262e8423d00SNathan Whitehorn.Bl -tag -width ".Cm distributekernel" 2631caae057SRuslan Ermilov.It Cm buildkernel 2641caae057SRuslan ErmilovRebuild the kernel and the kernel modules. 2651caae057SRuslan Ermilov.It Cm installkernel 2667b710ab2SJoseph KoshyInstall the kernel and the kernel modules to directory 2677b710ab2SJoseph Koshy.Pa ${DESTDIR}/boot/kernel , 2687b710ab2SJoseph Koshyrenaming any pre-existing directory with this name to 2697b710ab2SJoseph Koshy.Pa kernel.old 2707b710ab2SJoseph Koshyif it contained the currently running kernel. 2717b710ab2SJoseph KoshyThe target directory under 2727b710ab2SJoseph Koshy.Pa ${DESTDIR} 2737b710ab2SJoseph Koshymay be modified using the 2747b710ab2SJoseph Koshy.Va INSTKERNNAME 2757b710ab2SJoseph Koshyand 2767b710ab2SJoseph Koshy.Va KODIR 2777b710ab2SJoseph Koshy.Xr make 1 2787b710ab2SJoseph Koshyvariables. 279e8423d00SNathan Whitehorn.It Cm distributekernel 280e8423d00SNathan WhitehornInstall the kernel to the directory 281e8423d00SNathan Whitehorn.Pa ${DISTDIR}/kernel/boot/kernel . 282e8423d00SNathan WhitehornThis target is used while building a release; see 283e8423d00SNathan Whitehorn.Xr release 7 . 284e8423d00SNathan Whitehorn.It Cm packagekernel 285e8423d00SNathan WhitehornArchive the results of 286e8423d00SNathan Whitehorn.Cm distributekernel , 287e8423d00SNathan Whitehornplacing the results in 288e8423d00SNathan Whitehorn.Va DISTDIR . 289e8423d00SNathan WhitehornThis target is used while building a release; see 290e8423d00SNathan Whitehorn.Xr release 7 . 291389e98a7STom Rhodes.It Cm kernel 292389e98a7STom RhodesEquivalent to 293389e98a7STom Rhodes.Cm buildkernel 294389e98a7STom Rhodesfollowed by 295389e98a7STom Rhodes.Cm installkernel 2967b710ab2SJoseph Koshy.It Cm kernel-toolchain 2977b710ab2SJoseph KoshyRebuild the tools needed for kernel compilation. 2987b710ab2SJoseph KoshyUse this if you did not do a 2997b710ab2SJoseph Koshy.Cm buildworld 3007b710ab2SJoseph Koshyfirst. 3017b710ab2SJoseph Koshy.It Cm reinstallkernel 3027b710ab2SJoseph KoshyReinstall the kernel and the kernel modules, overwriting the contents 3037b710ab2SJoseph Koshyof the target directory. 3047b710ab2SJoseph KoshyAs with the 3057b710ab2SJoseph Koshy.Cm installkernel 3067b710ab2SJoseph Koshytarget, the target directory can be specified using the 3077b710ab2SJoseph Koshy.Xr make 1 3087b710ab2SJoseph Koshyvariable 3097b710ab2SJoseph Koshy.Va INSTKERNNAME . 3107b710ab2SJoseph Koshy.El 3117b710ab2SJoseph Koshy.Pp 3127b710ab2SJoseph KoshyConvenience targets for cleaning up the install destination directory 3137b710ab2SJoseph Koshydenoted by variable 3147b710ab2SJoseph Koshy.Va DESTDIR 3157b710ab2SJoseph Koshyinclude: 3167b710ab2SJoseph Koshy.Bl -tag -width ".Cm delete-old-libs" 3177b710ab2SJoseph Koshy.It Cm check-old 318abfabbeaSMike PritchardPrint a list of old files and directories in the system. 319e2a36081SAlexander Leidinger.It Cm delete-old 320e2a36081SAlexander LeidingerDelete obsolete base system files and directories interactively. 32178ad5421SRuslan ErmilovWhen 32278ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES 3237b710ab2SJoseph Koshyis specified at the command line, the delete operation will be 3247b710ab2SJoseph Koshynon-interactive. 325c8ef0ed5SRuslan ErmilovThe variables 3267b710ab2SJoseph Koshy.Va DESTDIR , 3277b710ab2SJoseph Koshy.Va TARGET_ARCH 328c8ef0ed5SRuslan Ermilovand 329c8ef0ed5SRuslan Ermilov.Va TARGET 330c8ef0ed5SRuslan Ermilovshould be set as with 331c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" . 332e2a36081SAlexander Leidinger.It Cm delete-old-libs 333e2a36081SAlexander LeidingerDelete obsolete base system libraries interactively. 3347b710ab2SJoseph KoshyThis target should only be used if no 3rd party software uses these 3357b710ab2SJoseph Koshylibraries. 33678ad5421SRuslan ErmilovWhen 33778ad5421SRuslan Ermilov.Li -DBATCH_DELETE_OLD_FILES 3387b710ab2SJoseph Koshyis specified at the command line, the delete operation will be 3397b710ab2SJoseph Koshynon-interactive. 340c8ef0ed5SRuslan ErmilovThe variables 3417b710ab2SJoseph Koshy.Va DESTDIR , 3427b710ab2SJoseph Koshy.Va TARGET_ARCH 343c8ef0ed5SRuslan Ermilovand 344c8ef0ed5SRuslan Ermilov.Va TARGET 345c8ef0ed5SRuslan Ermilovshould be set as with 346c8ef0ed5SRuslan Ermilov.Dq Li "make installworld" . 347786aa69aSBen Smithurst.El 348b82e53e2SMurray Stokely.Sh ENVIRONMENT 3497b710ab2SJoseph KoshyVariables that influence all builds include: 3507b710ab2SJoseph Koshy.Bl -tag -width ".Va MAKEOBJDIRPREFIX" 351fea87c03SGiorgos Keramidas.It Va DEBUG_FLAGS 352fea87c03SGiorgos KeramidasDefines a set of debugging flags that will be used to build all userland 353fea87c03SGiorgos Keramidasbinaries under 354fea87c03SGiorgos Keramidas.Pa /usr/src . 355fea87c03SGiorgos KeramidasWhen 356fea87c03SGiorgos Keramidas.Va DEBUG_FLAGS 357fea87c03SGiorgos Keramidasis defined, the 358fea87c03SGiorgos Keramidas.Cm install 359fea87c03SGiorgos Keramidasand 360fea87c03SGiorgos Keramidas.Cm installworld 361fea87c03SGiorgos Keramidastargets install binaries from the current 362fea87c03SGiorgos Keramidas.Va MAKEOBJDIRPREFIX 363fea87c03SGiorgos Keramidaswithout stripping, 364fea87c03SGiorgos Keramidasso that debugging information is retained in the installed binaries. 3657b710ab2SJoseph Koshy.It Va DESTDIR 3667b710ab2SJoseph KoshyThe directory hierarchy prefix where built objects will be installed. 3677b710ab2SJoseph KoshyIf not set, 3687b710ab2SJoseph Koshy.Va DESTDIR 3697b710ab2SJoseph Koshydefaults to the empty string. 3707b710ab2SJoseph Koshy.It Va MAKEOBJDIRPREFIX 3717b710ab2SJoseph KoshyDefines the prefix for directory names in the tree of built objects. 3727b710ab2SJoseph KoshyDefaults to 3737b710ab2SJoseph Koshy.Pa /usr/obj 3747b710ab2SJoseph Koshyif not defined. 3757b710ab2SJoseph KoshyThis variable should only be set in the environment and not via 3767b710ab2SJoseph Koshy.Pa /etc/make.conf 3777b710ab2SJoseph Koshyor the command line. 3787b710ab2SJoseph Koshy.It Va NO_WERROR 3797b710ab2SJoseph KoshyIf defined, compiler warnings will not cause the build to halt, 3807b710ab2SJoseph Koshyeven if the makefile says otherwise. 38121edb039SAlexander Leidinger.It Va WITH_CTF 38221edb039SAlexander LeidingerIf defined, the build process will run the DTrace CTF conversion 38321edb039SAlexander Leidingertools on built objects. 38421edb039SAlexander LeidingerPlease note that this WITH_ option is handled differently than all 38521edb039SAlexander Leidingerother WITH_ options (there is no 38621edb039SAlexander Leidinger.Va WITHOUT_CTF , 38721edb039SAlexander Leidingeror corresponding 38821edb039SAlexander Leidinger.Va MK_CTF 38921edb039SAlexander Leidingerin the build system). 3907b710ab2SJoseph Koshy.El 3917b710ab2SJoseph Koshy.Pp 3927b710ab2SJoseph KoshyAdditionally, builds in 3937b710ab2SJoseph Koshy.Pa /usr/src 3947b710ab2SJoseph Koshyare influenced by the following 3957b710ab2SJoseph Koshy.Xr make 1 3967b710ab2SJoseph Koshyvariables: 3977b710ab2SJoseph Koshy.Bl -tag -width ".Va SUBDIR_OVERRIDE" 398e6cdeeddSWarner Losh.It Va KERNCONF 399e6cdeeddSWarner LoshOverrides which kernel to build and install for the various kernel 400e6cdeeddSWarner Loshmake targets. 401e6cdeeddSWarner LoshIt defaults to 402e6cdeeddSWarner Losh.Cm GENERIC . 403e6cdeeddSWarner Losh.It Va KERNFAST 404e6cdeeddSWarner LoshIf set, the build target 405e6cdeeddSWarner Losh.Cm buildkernel 406e6cdeeddSWarner Loshdefaults to setting 407e6cdeeddSWarner Losh.Va NO_KERNELCLEAN , 4086d50d5e4SWarner Losh.Va NO_KERNELCONFIG , 4096d50d5e4SWarner Losh.Va NO_KERNELDEPEND 410e6cdeeddSWarner Loshand 4116d50d5e4SWarner Losh.Va NO_KERNELOBJ . 412e6cdeeddSWarner LoshWhen set to a value other than 413e6cdeeddSWarner Losh.Cm 1 414e6cdeeddSWarner Loshthen 415e6cdeeddSWarner Losh.Va KERNCONF 416e6cdeeddSWarner Loshis set to the value of 417e6cdeeddSWarner Losh.Va KERNFAST . 4187b710ab2SJoseph Koshy.It Va LOCAL_DIRS 4197b710ab2SJoseph KoshyIf set, this variable supplies a list of additional directories to 4207b710ab2SJoseph Koshybuild, relative to the root of the source tree. 421170c2788SGlen Barber.It Va PORTS_MODULES 422170c2788SGlen BarberA list of ports with kernel modules that should be built and installed 423170c2788SGlen Barberas part of the 424170c2788SGlen Barber.Cm buildkernel 425170c2788SGlen Barberand 426170c2788SGlen Barber.Cm installkernel 427170c2788SGlen Barberprocess. 428170c2788SGlen Barber.Bd -literal -offset indent 429170c2788SGlen Barbermake PORTS_MODULES=emulators/kqemu-kmod kernel 430170c2788SGlen Barber.Ed 4317b710ab2SJoseph Koshy.It Va SUBDIR_OVERRIDE 4327b710ab2SJoseph KoshyOverride the default list of sub-directories and only build the 4337b710ab2SJoseph Koshysub-directory named in this variable. 4347b710ab2SJoseph KoshyThis variable is useful when debugging failed builds. 4357b710ab2SJoseph Koshy.Bd -literal -offset indent 4367b710ab2SJoseph Koshymake some-target SUBDIR_OVERRIDE=foo/bar 4377b710ab2SJoseph Koshy.Ed 4386f9ac6feSMurray Stokely.It Va TARGET 439b3a43ea3SMurray StokelyThe target hardware platform. 440365a17c0SMurray StokelyThis is analogous to the 4411caae057SRuslan Ermilov.Dq Nm uname Fl m 442b3a43ea3SMurray Stokelyoutput. 443b3a43ea3SMurray StokelyThis is necessary to cross-build some target architectures. 444b3a43ea3SMurray StokelyFor example, cross-building for PC98 machines requires 4451caae057SRuslan Ermilov.Va TARGET_ARCH Ns = Ns Li i386 446b3a43ea3SMurray Stokelyand 4471caae057SRuslan Ermilov.Va TARGET Ns = Ns Li pc98 . 4487b710ab2SJoseph KoshyIf not set, 4497b710ab2SJoseph Koshy.Va TARGET 4507b710ab2SJoseph Koshydefaults to the current hardware platform. 4517b710ab2SJoseph Koshy.It Va TARGET_ARCH 4527b710ab2SJoseph KoshyThe target machine processor architecture. 4537b710ab2SJoseph KoshyThis is analogous to the 4547b710ab2SJoseph Koshy.Dq Nm uname Fl p 4557b710ab2SJoseph Koshyoutput. 4567b710ab2SJoseph KoshySet this to cross-build for a different architecture. 4577b710ab2SJoseph KoshyIf not set, 4587b710ab2SJoseph Koshy.Va TARGET_ARCH 459531b260aSWarner Loshdefaults to the current machine architecture, unless 460531b260aSWarner Losh.Va TARGET 461531b260aSWarner Loshis also set, in which case it defaults to the appropriate 462531b260aSWarner Loshvalue for that platform. 463c22c7f86SWarner LoshTypically, one only needs to set 464c22c7f86SWarner Losh.Va TARGET . 4657b710ab2SJoseph Koshy.El 4667b710ab2SJoseph Koshy.Pp 4677b710ab2SJoseph KoshyBuilds under directory 468fd23b461SGiorgos Keramidas.Pa /usr/src 4697d6af40dSGlen Barberare also influenced by defining one or more of the following symbols, 470fd23b461SGiorgos Keramidasusing the 471fd23b461SGiorgos Keramidas.Fl D 472fd23b461SGiorgos Keramidasoption of 473fd23b461SGiorgos Keramidas.Xr make 1 : 474fd23b461SGiorgos Keramidas.Bl -tag -width ".Va -DNO_KERNELDEPEND" 475fd23b461SGiorgos Keramidas.It Va NO_CLEANDIR 476fd23b461SGiorgos KeramidasIf set, the build targets that clean parts of the object tree use the 477fd23b461SGiorgos Keramidasequivalent of 478fd23b461SGiorgos Keramidas.Dq make clean 479fd23b461SGiorgos Keramidasinstead of 480fd23b461SGiorgos Keramidas.Dq make cleandir . 481fd23b461SGiorgos Keramidas.It Va NO_CLEAN 482fd23b461SGiorgos KeramidasIf set, no object tree files are cleaned at all. 483fd23b461SGiorgos KeramidasSetting 484fd23b461SGiorgos Keramidas.Va NO_CLEAN 485fd23b461SGiorgos Keramidasimplies 486fd23b461SGiorgos Keramidas.Va NO_KERNELCLEAN , 487fd23b461SGiorgos Keramidasso when 488fd23b461SGiorgos Keramidas.Va NO_CLEAN 489fd23b461SGiorgos Keramidasis set no kernel objects are cleaned either. 490fd23b461SGiorgos Keramidas.It Va NO_CTF 491fd23b461SGiorgos KeramidasIf set, the build process does not run the DTrace CTF conversion tools 492fd23b461SGiorgos Keramidason built objects. 493fd23b461SGiorgos Keramidas.It Va NO_SHARE 494fd23b461SGiorgos KeramidasIf set, the build does not descend into the 495fd23b461SGiorgos Keramidas.Pa /usr/src/share 496*50a994c9SWarren Blocksubdirectory (i.e., manpages, locale data files, timezone data files and 497fd23b461SGiorgos Keramidasother 498fd23b461SGiorgos Keramidas.Pa /usr/src/share 499fd23b461SGiorgos Keramidasfiles will not be rebuild from their sources). 500fd23b461SGiorgos Keramidas.It Va NO_KERNELCLEAN 501fd23b461SGiorgos KeramidasIf set, the build process does not run 502fd23b461SGiorgos Keramidas.Dq make clean 503fd23b461SGiorgos Keramidasas part of the 504fd23b461SGiorgos Keramidas.Cm buildkernel 505fd23b461SGiorgos Keramidastarget. 506fd23b461SGiorgos Keramidas.It Va NO_KERNELCONFIG 507fd23b461SGiorgos KeramidasIf set, the build process does not run 508fd23b461SGiorgos Keramidas.Xr config 8 509fd23b461SGiorgos Keramidasas part of the 510fd23b461SGiorgos Keramidas.Cm buildkernel 511fd23b461SGiorgos Keramidastarget. 512fd23b461SGiorgos Keramidas.It Va NO_KERNELDEPEND 513fd23b461SGiorgos KeramidasIf set, the build process does not run 514fd23b461SGiorgos Keramidas.Dq make depend 515fd23b461SGiorgos Keramidasas part of the 516fd23b461SGiorgos Keramidas.Cm buildkernel 517fd23b461SGiorgos Keramidastarget. 5186d50d5e4SWarner Losh.It Va NO_KERNELOBJ 5196d50d5e4SWarner LoshIf set, the build process does not run 5206d50d5e4SWarner Losh.Dq make obj 5216d50d5e4SWarner Loshas part of the 5226d50d5e4SWarner Losh.Cm buildkernel 5236d50d5e4SWarner Loshtarget. 524fd23b461SGiorgos Keramidas.It Va NO_DOCUPDATE 525fd23b461SGiorgos KeramidasIf set, the update process does not update the source of the 526fd23b461SGiorgos Keramidas.Fx 527fd23b461SGiorgos Keramidasdocumentation as part of the 528fd23b461SGiorgos Keramidas.Dq make update 529fd23b461SGiorgos Keramidastarget. 530fd23b461SGiorgos Keramidas.It Va NO_PORTSUPDATE 531fd23b461SGiorgos KeramidasIf set, the update process does not update the Ports tree as part of the 532fd23b461SGiorgos Keramidas.Dq make update 533fd23b461SGiorgos Keramidastarget. 53469c488cdSRuslan Ermilov.It Va NO_WWWUPDATE 53569c488cdSRuslan ErmilovIf set, the update process does not update the www tree as part of the 53669c488cdSRuslan Ermilov.Dq make update 53769c488cdSRuslan Ermilovtarget. 538fd23b461SGiorgos Keramidas.El 539fd23b461SGiorgos Keramidas.Pp 540fd23b461SGiorgos KeramidasBuilds under directory 5417b710ab2SJoseph Koshy.Pa /usr/doc 5427b710ab2SJoseph Koshyare influenced by the following 5437b710ab2SJoseph Koshy.Xr make 1 5447b710ab2SJoseph Koshyvariables: 5457b710ab2SJoseph Koshy.Bl -tag -width ".Va DOC_LANG" 5467b710ab2SJoseph Koshy.It Va DOC_LANG 5477b710ab2SJoseph KoshyIf set, restricts the documentation build to the language subdirectories 5487b710ab2SJoseph Koshyspecified as its content. 5497b710ab2SJoseph KoshyThe default action is to build documentation for all languages. 550b82e53e2SMurray Stokely.El 5514e889921SJohn Baldwin.Pp 5524e889921SJohn BaldwinBuilds using the 5534e889921SJohn Baldwin.Cm universe 5544e889921SJohn Baldwintarget are influenced by the following 5554e889921SJohn Baldwin.Xr make 1 5564e889921SJohn Baldwinvariables: 5574e889921SJohn Baldwin.Bl -tag -width ".Va MAKE_JUST_KERNELS" 5584e889921SJohn Baldwin.It Va JFLAG 5594e889921SJohn BaldwinPass the value of this variable to each 5604e889921SJohn Baldwin.Xr make 1 5614e889921SJohn Baldwininvocation used to build worlds and kernels. 5624e889921SJohn BaldwinThis can be used to enable multiple jobs within a single architecture's build 5634e889921SJohn Baldwinwhile still building each architecture serially. 5644e889921SJohn Baldwin.It Va MAKE_JUST_KERNELS 5654e889921SJohn BaldwinOnly build kernels for each supported architecture. 5664e889921SJohn Baldwin.It Va MAKE_JUST_WORLDS 5674e889921SJohn BaldwinOnly build worlds for each supported architecture. 5684e889921SJohn Baldwin.It Va UNIVERSE_TARGET 5694e889921SJohn BaldwinExecute the specified 5704e889921SJohn Baldwin.Xr make 1 5714e889921SJohn Baldwintarget for each supported architecture instead of the default action of 5724e889921SJohn Baldwinbuilding a world and one or more kernels. 5734e889921SJohn Baldwin.El 574786aa69aSBen Smithurst.Sh FILES 5750c0eb9beSRuslan Ermilov.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact 576786aa69aSBen Smithurst.It Pa /usr/doc/Makefile 577786aa69aSBen Smithurst.It Pa /usr/doc/share/mk/doc.project.mk 578786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.port.mk 579786aa69aSBen Smithurst.It Pa /usr/ports/Mk/bsd.sites.mk 5801caae057SRuslan Ermilov.It Pa /usr/share/examples/etc/make.conf 5810c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile 5820c0eb9beSRuslan Ermilov.It Pa /usr/src/Makefile.inc1 5833136363fSRuslan Ermilov.El 5843faf5fc9SBen Smithurst.Sh EXAMPLES 585be6a4760SRuslan ErmilovFor an 5863faf5fc9SBen Smithurst.Dq approved 5877b710ab2SJoseph Koshymethod of updating your system from the latest sources, please see the 588be6a4760SRuslan Ermilov.Sx COMMON ITEMS 589be6a4760SRuslan Ermilovsection in 590be6a4760SRuslan Ermilov.Pa src/UPDATING . 591b82e53e2SMurray Stokely.Pp 592b82e53e2SMurray StokelyThe following sequence of commands can be used to cross-build the 59362d06538SMaxim Konovalovsystem for the sparc64 architecture on an i386 host: 594b82e53e2SMurray Stokely.Bd -literal -offset indent 595b82e53e2SMurray Stokelycd /usr/src 596531b260aSWarner Loshmake TARGET=sparc64 buildworld 597531b260aSWarner Loshmake TARGET=sparc64 DESTDIR=/clients/sparc64 installworld 598b82e53e2SMurray Stokely.Ed 599786aa69aSBen Smithurst.Sh SEE ALSO 6007c20a493SBen Smithurst.Xr cc 1 , 601*50a994c9SWarren Block.Xr csup 1 , 602786aa69aSBen Smithurst.Xr install 1 , 603786aa69aSBen Smithurst.Xr make 1 , 604*50a994c9SWarren Block.Xr svn 1 , 605786aa69aSBen Smithurst.Xr make.conf 5 , 606157376baSJoseph Koshy.Xr src.conf 5 , 607a81996b6SBen Smithurst.Xr ports 7 , 608a54bda91SMurray Stokely.Xr release 7 , 60961001d75STom Rhodes.Xr config 8 , 61047f77d8cSBen Smithurst.Xr mergemaster 8 , 611a81996b6SBen Smithurst.Xr reboot 8 , 612a81996b6SBen Smithurst.Xr shutdown 8 613786aa69aSBen Smithurst.Sh AUTHORS 614786aa69aSBen Smithurst.An Mike W. Meyer Aq mwm@mired.org . 615