d724dac0945f77caede2db4081b4921b2c7d73a1
[dragonfly.git] / share / man / man5 / compilers.conf.5
1 .\"
2 .\" Copyright (c) 2009
3 .\"     The DragonFly Project.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\"    contributors may be used to endorse or promote products derived
17 .\"    from this software without specific, prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd March 4, 2010
33 .Os
34 .Dt COMPILERS.CONF 5
35 .Sh NAME
36 .Nm compilers.conf
37 .Nd configuration file for external compilers
38 .Sh SYNOPSIS
39 .Pa /etc/compilers.conf
40 .Sh DESCRIPTION
41 The
42 .Nm
43 file allows to configure
44 .Dq external
45 compilers for usage with the
46 .Dx
47 .Xr build 7
48 system.
49 .Pp
50 The
51 .Pa /etc/defaults/compilers.conf
52 file specifies the default settings for all variables, the
53 .Pa /etc/compilers.conf
54 file specifies override settings.
55 .Pp
56 The following variables are available:
57 .Bl -tag -width ".Va <version>_CPPFLAGS"
58 .It Va <version>_CC
59 The pathname of the
60 .Nm cc
61 program of the compiler.
62 .It Va <version>_CFLAGS
63 Any additional flags to pass to
64 .Va <version>_CC .
65 .It Va <version>_CPP
66 The pathname of the
67 .Nm cpp
68 program of the compiler.
69 .It Va <version>_CPPFLAGS
70 Any additional flags to pass to
71 .Va <version>_CPP .
72 .It Va <version>_CXX
73 The pathname of the
74 .Nm c++
75 program of the compiler.
76 .It Va <version>_CXXFLAGS
77 Any additional flags to pass to
78 .Va <version>_CXX .
79 .It Va <version>_VERSION
80 What to output when the
81 .Fl dumpversion
82 option is used.
83 This helps
84 .Nm clang
85 with
86 .Xr pkgsrc 7 .
87 .El
88 .Pp
89 Once configured the compiler can then be used like this:
90 .Bd -literal -offset indent
91 env CCVER=clang make
92 .Ed
93 .Pp
94 To build world and kernel, use the following instructions:
95 .Bd -literal -offset indent
96 cd /usr/src
97 fetch http://leaf.dragonflybsd.org/~swildner/world_clang.diff
98 patch -p1 <world_clang.diff
99 env WORLD_CCVER=clang make -DNO_GCC44 buildworld
100 env WORLD_CCVER=clang make buildkernel KERNCONF=MYCONF
101 .Ed
102 .Pp
103 Currently, defaults are provided for
104 .Nm clang
105 (installed from
106 .Xr pkgsrc 7 Ap s
107 .Pa lang/clang )
108 and
109 .Nm clangsvn
110 (installed from SVN trunk as described in
111 .Pa http://clang.llvm.org/get_started.html ) .
112 .Sh IMPLEMENTATION NOTES
113 In
114 .Dx ,
115 compilers are selected by setting the
116 .Ev CCVER
117 variable.
118 The
119 .Pa cpp ,
120 .Pa cc
121 etc\&. programs in
122 .Pa /usr/bin
123 are actually links to the
124 .Xr objformat 1
125 deflector program which is responsible for executing the
126 correct programs (located in
127 .Pa /usr/libexec/$CCVER ) .
128 .Pp
129 Traditionally,
130 .Dx
131 has 2 compilers in base, one of which is the default compiler and the other
132 is either a newer or older version.
133 In order to allow additional non-base compilers into
134 .Dx Ap s
135 build process,
136 .Xr objformat 1
137 deflects to
138 .Pa /usr/libexec/custom
139 when
140 .Ev CCVER Ap s
141 setting is not one of the compilers in base.
142 This directory contains a
143 .Pa cc
144 wrapper script (and some links to it).
145 The wrapper script then takes care of making the compiler look and behave
146 like a compiler in base.
147 .Pp
148 The settings in
149 .Nm
150 specify paths and flags for the
151 .Pa /usr/libexec/custom/cc
152 script.
153 .Sh FILES
154 .Bl -tag -width ".Pa /etc/compilers.conf" -compact
155 .It Pa /etc/compilers.conf
156 external compiler configuration file
157 .El
158 .Sh SEE ALSO
159 .Xr objformat 1 ,
160 .Xr build 7
161 .Sh HISTORY
162 The
163 .Nm
164 file first appeared in
165 .Dx 2.3 .