gitweb.dragonflybsd.org Git - dragonfly.git/blame_incremental

... / ...

Commit	Line	Data
	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 February 23, 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 pkgsrc's
	106	.Pa lang/clang )
	107	and
	108	.Nm clangsvn
	109	(installed from SVN trunk as described in
	110	.Pa http://clang.llvm.org/get_started.html ) .
	111	.Sh IMPLEMENTATION NOTES
	112	In
	113	.Dx ,
	114	compilers are selected by setting the
	115	.Ev CCVER
	116	variable.
	117	The
	118	.Xr objformat 1
	119	deflector program is responsible for executing the correct programs (located in
	120	.Pa /usr/libexec/$CCVER )
	121	based on the setting of that variable.
	122	Traditionally,
	123	.Dx
	124	has 2 compilers in base, one of which is the default compiler and the other
	125	is either a newer or older version.
	126	.Pp
	127	In order to allow additional non-base compilers into
	128	.Dx Ap s
	129	build process,
	130	.Xr objformat 1
	131	deflects to
	132	.Pa /usr/libexec/custom
	133	when
	134	.Ev CCVER Ap s
	135	setting is not one of the compilers in base.
	136	This directory contains a
	137	.Pa cc
	138	wrapper script (and some links to it).
	139	The wrapper script then takes care of making the compiler look and behave
	140	like a compiler in base.
	141	.Pp
	142	The settings in
	143	.Nm
	144	specify paths and flags for the
	145	.Pa /usr/libexec/custom/cc
	146	script.
	147	.Sh FILES
	148	.Bl -tag -width ".Pa /etc/compilers.conf" -compact
	149	.It Pa /etc/compilers.conf
	150	external compiler configuration file
	151	.El
	152	.Sh SEE ALSO
	153	.Xr objformat 1 ,
	154	.Xr build 7
	155	.Sh HISTORY
	156	The
	157	.Nm
	158	file first appeared in
	159	.Dx 2.3 .