blob: f394a22fc2a7d058828ebfe363d1c81e09189c4b [file] [log] [blame]
Dylan Bakerbc17ac52017-10-17 12:19:49 -07001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html lang="en">
3<head>
4 <meta http-equiv="content-type" content="text/html; charset=utf-8">
5 <title>Compilation and Installation using Meson</title>
6 <link rel="stylesheet" type="text/css" href="mesa.css">
7</head>
8<body>
9
10<div class="header">
11 <h1>The Mesa 3D Graphics Library</h1>
12</div>
13
14<iframe src="contents.html"></iframe>
15<div class="content">
16
17<h1>Compilation and Installation using Meson</h1>
18
19<h2 id="basic">1. Basic Usage</h2>
20
Dylan Baker2aad12b2018-03-01 11:32:56 -080021<p><strong>The Meson build system is generally considered stable and ready
22for production</strong></p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -070023
Dylan Baker2aad12b2018-03-01 11:32:56 -080024<p>The meson build is tested on on Linux, macOS, Cygwin and Haiku, it should
25work on FreeBSD, DragonflyBSD, NetBSD, and OpenBSD.</p>
26
Dylan Baker5a670d082018-04-13 15:05:55 -070027<p><strong>Mesa requires Meson >= 0.44.1 to build.</strong>
Dylan Baker2aad12b2018-03-01 11:32:56 -080028
29Some older versions of meson do not check that they are too old and will error
30out in odd ways.
31</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -070032
33<p>
34The meson program is used to configure the source directory and generates
35either a ninja build file or Visual Studio® build files. The latter must
Eric Engestrom37d44e22018-05-14 16:47:57 +010036be enabled via the <code>--backend</code> switch, as ninja is the default backend on all
Dylan Bakerbc17ac52017-10-17 12:19:49 -070037operating systems. Meson only supports out-of-tree builds, and must be passed a
38directory to put built and generated sources into. We'll call that directory
39"build" for examples.
40</p>
41
42<pre>
43 meson build/
44</pre>
45
46<p>
47To see a description of your options you can run <code>meson configure</code>
48along with a build directory to view the selected options for. This will show
49your meson global arguments and project arguments, along with their defaults
50and your local settings.
51
Eric Engestromdc2dc1f2018-05-14 16:44:08 +010052Meson does not currently support listing options before configure a build
Dylan Bakerbc17ac52017-10-17 12:19:49 -070053directory, but this feature is being discussed upstream.
54</p>
55
56<pre>
57 meson configure build/
58</pre>
59
60<p>
61With additional arguments <code>meson configure</code> is used to change
62options on already configured build directory. All options passed to this
Eric Engestrom37d44e22018-05-14 16:47:57 +010063command are in the form <code>-D "command"="value"</code>.
Dylan Bakerbc17ac52017-10-17 12:19:49 -070064</p>
65
66<pre>
67 meson configure build/ -Dprefix=/tmp/install -Dglx=true
68</pre>
69
70<p>
71Once you've run the initial <code>meson</code> command successfully you can use
72your configured backend to build the project. With ninja, the -C option can be
73be used to point at a directory to build.
74</p>
75
76<pre>
77 ninja -C build/
78</pre>
79
80<p>
81Without arguments, it will produce libGL.so and/or several other libraries
82depending on the options you have chosen. Later, if you want to rebuild for a
83different configuration, you should run <code>ninja clean</code> before
84changing the configuration, or create a new out of tree build directory for
Eric Engestrom5829f612018-05-14 16:47:18 +010085each configuration you want to build
86<a href="http://mesonbuild.com/Using-multiple-build-directories.html">as
87recommended in the documentation</a>
Dylan Bakerbc17ac52017-10-17 12:19:49 -070088</p>
89
Eric Engestrom67c55072018-05-14 16:45:31 +010090<dl>
Dylan Bakerbc17ac52017-10-17 12:19:49 -070091<dt><code>Environment Variables</code></dt>
Eric Engestromdc2dc1f2018-05-14 16:44:08 +010092<dd><p>Meson supports the standard CC and CXX environment variables for
Dylan Bakerbc17ac52017-10-17 12:19:49 -070093changing the default compiler, and CFLAGS, CXXFLAGS, and LDFLAGS for setting
94options to the compiler and linker.
95
96The default compilers depends on your operating system. Meson supports most of
97the popular compilers, a complete list is available
98<a href="http://mesonbuild.com/Reference-tables.html#compiler-ids">here</a>.
99
100These arguments are consumed and stored by meson when it is initialized or
101re-initialized. Therefore passing them to meson configure will not do anything,
102and passing them to ninja will only do something if ninja decides to
Eric Engestromdc2dc1f2018-05-14 16:44:08 +0100103re-initialize meson, for example, if a meson.build file has been changed.
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700104Changing these variables will not cause all targets to be rebuilt, so running
Eric Engestromdc2dc1f2018-05-14 16:44:08 +0100105ninja clean is recommended when changing CFLAGS or CXXFLAGS. Meson will never
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700106change compiler in a configured build directory.
107</p>
108
109<pre>
110 CC=clang CXX=clang++ meson build-clang
111 ninja -C build-clang
112 ninja -C build-clang clean
113 touch meson.build
114 CFLAGS=-Wno-typedef-redefinition ninja -C build-clang
115</pre>
116
Eric Engestrom37d44e22018-05-14 16:47:57 +0100117<p>Meson also honors <code>DESTDIR</code> for installs</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700118</dd>
119
120
121<dt><code>LLVM</code></dt>
122<dd><p>Meson includes upstream logic to wrap llvm-config using it's standard
Eric Engestrom37d44e22018-05-14 16:47:57 +0100123dependency interface. It will search <code>$PATH</code> (or <code>%PATH%</code> on windows) for
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700124llvm-config, so using an LLVM from a non-standard path is as easy as
125<code>PATH=/path/with/llvm-config:$PATH meson build</code>.
126</p></dd>
127</dl>
128
Dylan Baker2aad12b2018-03-01 11:32:56 -0800129<dl>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700130<dt><code>PKG_CONFIG_PATH</code></dt>
131<dd><p>The
132<code>pkg-config</code> utility is a hard requirement for configuring and
Dylan Baker2aad12b2018-03-01 11:32:56 -0800133building Mesa on Unix-like systems. It is used to search for external libraries
134on the system. This environment variable is used to control the search path for
135<code>pkg-config</code>. For instance, setting
136<code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for package
137metadata in <code>/usr/X11R6</code> before the standard directories.</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700138</dd>
139</dl>
140
141<p>
142One of the oddities of meson is that some options are different when passed to
143the <code>meson</code> than to <code>meson configure</code>. These options are
144passed as --option=foo to <code>meson</code>, but -Doption=foo to <code>meson
145configure</code>. Mesa defined options are always passed as -Doption=foo.
Eric Engestrom67c55072018-05-14 16:45:31 +0100146</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700147
148<p>For those coming from autotools be aware of the following:</p>
149
150<dl>
151<dt><code>--buildtype/-Dbuildtype</code></dt>
152<dd><p>This option will set the compiler debug/optimisation levels to aid
153debugging the Mesa libraries.</p>
154
Eric Engestrom37d44e22018-05-14 16:47:57 +0100155<p>Note that in meson this defaults to <code>debugoptimized</code>, and
156not setting it to <code>release</code> will yield non-optimal
157performance and binary size. Not using <code>debug</code> may interfere
158with debugging as some code and validation will be optimized away.
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700159</p>
160
Eric Engestrom37d44e22018-05-14 16:47:57 +0100161<p> For those wishing to pass their own optimization flags, use the <code>plain</code>
Dylan Baker2aad12b2018-03-01 11:32:56 -0800162buildtype, which causes meson to inject no additional compiler arguments, only
163those in the C/CXXFLAGS and those that mesa itself defines.</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700164</dd>
165</dl>
166
167<dl>
168<dt><code>-Db_ndebug</code></dt>
Eric Engestrom37d44e22018-05-14 16:47:57 +0100169<dd><p>This option controls assertions in meson projects. When set to <code>false</code>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700170(the default) assertions are enabled, when set to true they are disabled. This
171is unrelated to the <code>buildtype</code>; setting the latter to
172<code>release</code> will not turn off assertions.
173</p>
174</dd>
175</dl>
Eric Engestrom67c55072018-05-14 16:45:31 +0100176
177</div>
178</body>
179</html>