kernel: Use the system's offsetof() macro instead of cooking our own.
[dragonfly.git] / share / man / man5 / compilers.conf.5
CommitLineData
c97b9141
SW
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.\"
127a3eb4 32.Dd February 25, 2011
c97b9141
SW
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
41The
42.Nm
43file allows to configure
44.Dq external
45compilers for usage with the
46.Dx
47.Xr build 7
48system.
49.Pp
50The
51.Pa /etc/defaults/compilers.conf
52file specifies the default settings for all variables, the
53.Pa /etc/compilers.conf
54file specifies override settings.
55.Pp
56The following variables are available:
57.Bl -tag -width ".Va <version>_CPPFLAGS"
58.It Va <version>_CC
59The pathname of the
60.Nm cc
61program of the compiler.
62.It Va <version>_CFLAGS
63Any additional flags to pass to
64.Va <version>_CC .
65.It Va <version>_CPP
66The pathname of the
67.Nm cpp
68program of the compiler.
69.It Va <version>_CPPFLAGS
70Any additional flags to pass to
71.Va <version>_CPP .
72.It Va <version>_CXX
73The pathname of the
74.Nm c++
75program of the compiler.
76.It Va <version>_CXXFLAGS
77Any additional flags to pass to
78.Va <version>_CXX .
79.It Va <version>_VERSION
80What to output when the
81.Fl dumpversion
82option is used.
83This helps
84.Nm clang
85with
86.Xr pkgsrc 7 .
87.El
88.Pp
89Once configured the compiler can then be used like this:
90.Bd -literal -offset indent
1c4f2fa4
SW
91env CCVER=clang make
92.Ed
93.Pp
94To build world and kernel, use the following instructions:
95.Bd -literal -offset indent
c97b9141 96cd /usr/src
1c4f2fa4
SW
97fetch http://leaf.dragonflybsd.org/~swildner/world_clang.diff
98patch -p1 <world_clang.diff
99env WORLD_CCVER=clang make -DNO_GCC44 buildworld
100env WORLD_CCVER=clang make buildkernel KERNCONF=MYCONF
c97b9141
SW
101.Ed
102.Pp
cfe16058 103Currently, defaults are provided for
c97b9141 104.Nm clang
cc9ebe4d
SW
105(installed from
106.Xr pkgsrc 7 Ap s
127a3eb4 107.Pa lang/clang ),
1c4f2fa4
SW
108.Nm clangsvn
109(installed from SVN trunk as described in
127a3eb4
SW
110.Pa http://clang.llvm.org/get_started.html )
111and
112.Nm gcc46
113(installed from
114.Xr pkgsrc 7 Ap s
115.Pa lang/gnat-aux ) .
1237441a
SW
116.Sh IMPLEMENTATION NOTES
117In
118.Dx ,
119compilers are selected by setting the
120.Ev CCVER
121variable.
122The
cc9ebe4d
SW
123.Pa cpp ,
124.Pa cc
125etc\&. programs in
126.Pa /usr/bin
127are actually links to the
1237441a 128.Xr objformat 1
cc9ebe4d
SW
129deflector program which is responsible for executing the
130correct programs (located in
131.Pa /usr/libexec/$CCVER ) .
132.Pp
1237441a
SW
133Traditionally,
134.Dx
135has 2 compilers in base, one of which is the default compiler and the other
136is either a newer or older version.
1237441a
SW
137In order to allow additional non-base compilers into
138.Dx Ap s
139build process,
140.Xr objformat 1
141deflects to
142.Pa /usr/libexec/custom
143when
144.Ev CCVER Ap s
145setting is not one of the compilers in base.
146This directory contains a
147.Pa cc
148wrapper script (and some links to it).
149The wrapper script then takes care of making the compiler look and behave
150like a compiler in base.
151.Pp
152The settings in
153.Nm
154specify paths and flags for the
155.Pa /usr/libexec/custom/cc
156script.
c97b9141
SW
157.Sh FILES
158.Bl -tag -width ".Pa /etc/compilers.conf" -compact
159.It Pa /etc/compilers.conf
160external compiler configuration file
161.El
162.Sh SEE ALSO
163.Xr objformat 1 ,
164.Xr build 7
165.Sh HISTORY
166The
167.Nm
168file first appeared in
169.Dx 2.3 .