-
Notifications
You must be signed in to change notification settings - Fork 4
/
Quick-guide.html
364 lines (327 loc) · 13.8 KB
/
Quick-guide.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Quickstart Guide</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/prism-keep-markup.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="icon" type="image/png" href="assets/images/favicon.png">
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/meson_logo.png" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Modules <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="modules-menu">
<li>
<a href="CMake-module.html">CMake</a>
</li>
<li>
<a href="Cuda-module.html">CUDA</a>
</li>
<li>
<a href="Dlang-module.html">Dlang</a>
</li>
<li>
<a href="External-Project-module.html">External Project</a>
</li>
<li>
<a href="Fs-module.html">Filesystem</a>
</li>
<li>
<a href="Gnome-module.html">GNOME</a>
</li>
<li>
<a href="Hotdoc-module.html">Hotdoc</a>
</li>
<li>
<a href="i18n-module.html">i18n</a>
</li>
<li>
<a href="Icestorm-module.html">Icestorm</a>
</li>
<li>
<a href="Java-module.html">Java</a>
</li>
<li>
<a href="Keyval-module.html">Keyval</a>
</li>
<li>
<a href="Pkgconfig-module.html">Pkgconfig</a>
</li>
<li>
<a href="Python-3-module.html">Python 3</a>
</li>
<li>
<a href="Python-module.html">Python</a>
</li>
<li>
<a href="Qt4-module.html">Qt4</a>
</li>
<li>
<a href="Qt5-module.html">Qt5</a>
</li>
<li>
<a href="Qt6-module.html">Qt6</a>
</li>
<li>
<a href="Rust-module.html">Rust</a>
</li>
<li>
<a href="Simd-module.html">Simd</a>
</li>
<li>
<a href="SourceSet-module.html">SourceSet</a>
</li>
<li>
<a href="Wayland-module.html">Wayland</a>
</li>
<li>
<a href="Windows-module.html">Windows</a>
</li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Quick References <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="quick-refs-menu">
<li>
<a href="Reference-manual.html">Functions</a>
</li>
<li>
<a href="Build-options.html">Options</a>
</li>
<li>
<a href="Configuration.html">Configuration</a>
</li>
<li>
<a href="Dependencies.html">Dependencies</a>
</li>
<li>
<a href="Unit-tests.html">Tests</a>
</li>
<li>
<a href="Syntax.html">Syntax</a>
</li>
</ul>
</li>
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Meson Build System</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Meson-documentation" data-hotdoc-ref="Quick-guide.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="using-meson">Using Meson</h1>
<p>Meson has been designed to be as simple to use as possible. This page
outlines the initial steps needed for installation, troubleshooting,
and standard use.</p>
<p>For more advanced configuration please refer to the command line help
<code>meson --help</code> or the Meson documentation located at the
<a href="https://mesonbuild.com">Mesonbuild</a> website.</p>
<p>Table of Contents:</p>
<ul>
<li><a href="Quick-guide.html#requirements">Requirements</a></li>
<li><a href="Quick-guide.html#installation-using-package-manager">Installation using package manager</a></li>
<li><a href="Quick-guide.html#installation-using-python">Installation using Python</a></li>
<li><a href="Quick-guide.html#installation-from-source">Installation from source</a></li>
<li><a href="Quick-guide.html#troubleshooting">Troubleshooting</a></li>
<li><a href="Quick-guide.html#compiling-a-meson-project">Compiling a Meson project</a></li>
<li><a href="Quick-guide.html#using-meson-as-a-distro-packager">Using Meson as a distro packager</a></li>
</ul>
<h2 id="requirements">Requirements</h2>
<ul>
<li><a href="https://python.org">Python 3</a></li>
<li><a href="https://github.com/ninja-build/ninja/">Ninja</a></li>
</ul>
<p><em>Ninja is only needed if you use the Ninja backend. Meson can also
generate native VS and Xcode project files.</em></p>
<h2 id="installation-using-package-manager">Installation using package manager</h2>
<p>Ubuntu:</p>
<pre><code class="language-console">$ sudo apt-get install python3 python3-pip python3-setuptools \
python3-wheel ninja-build
</code></pre>
<p><em>Due to our frequent release cycle and development speed, distro packaged software may quickly become outdated.</em></p>
<h2 id="installation-using-python">Installation using Python</h2>
<p>Requirements: <strong>pip3</strong></p>
<p>The best way to receive the most up-to-date version of Mesonbuild.</p>
<p>Install as a local user (recommended):</p>
<pre><code class="language-console">$ pip3 install --user meson
</code></pre>
<p>Install as root:</p>
<pre><code class="language-console"># pip3 install meson
</code></pre>
<p><em>If you are unsure whether to install as root or a local user, install
as a local user.</em></p>
<h2 id="installation-from-source">Installation from source</h2>
<p>Requirements: <strong>git</strong></p>
<p>Meson can be run directly from the cloned git repository.</p>
<pre><code class="language-console">$ git clone https://github.com/mesonbuild/meson.git /path/to/sourcedir
</code></pre>
<h2 id="troubleshooting">Troubleshooting:</h2>
<p>Common Issues:</p>
<pre><code class="language-console">$ meson setup builddir
$ bash: /usr/bin/meson: No such file or directory
</code></pre>
<p><strong>Description</strong>: The default installation prefix for the python pip module
installation might not be included in your shell environment <code>PATH</code>.
The default install location varies depending on your OS, distro and
Python version.</p>
<p><strong>Resolution</strong>: This issue can be resolved by altering the default shell
environment <code>PATH</code> to include the path where Pip installed the
binaries. This can be, e.g. <code>/usr/local/bin</code> or
<code>/home/<username>/.local/bin</code>.</p>
<p><strong>Note</strong>: There are other ways of fixing this issue such as using
symlinks or copying the binaries to a default path and these methods
are not recommended or supported as they may break package management
interoperability.</p>
<h2 id="compiling-a-meson-project">Compiling a Meson project</h2>
<p>The most common use case of Meson is compiling code on a code base you
are working on. The steps to take are very simple.</p>
<pre><code class="language-console">$ cd /path/to/source/root
$ meson setup builddir && cd builddir
$ meson compile
$ meson test
</code></pre>
<p>The only thing to note is that you need to create a separate build
directory. Meson will not allow you to build source code inside your
source tree. All build artifacts are stored in the build directory.
This allows you to have multiple build trees with different
configurations at the same time. This way generated files are not
added into revision control by accident.</p>
<p>To recompile after code changes, just type <code>meson compile</code>. The build
command is always the same. You can do arbitrary changes to source
code and build system files and Meson will detect those and will do
the right thing. If you want to build optimized binaries, just use the
argument <code>--buildtype=debugoptimized</code> when running Meson. It is
recommended that you keep one build directory for unoptimized builds
and one for optimized ones. To compile any given configuration, just
go into the corresponding build directory and run <code>meson compile</code>.</p>
<p>Meson will automatically add compiler flags to enable debug
information and compiler warnings (i.e. <code>-g</code> and <code>-Wall</code>). This means
the user does not have to deal with them and can instead focus on
coding.</p>
<h2 id="using-meson-as-a-distro-packager">Using Meson as a distro packager</h2>
<p>Distro packagers usually want total control on the build flags
used. Meson supports this use case natively. The commands needed to
build and install Meson projects are the following.</p>
<pre><code class="language-console">$ cd /path/to/source/root
$ meson --prefix /usr --buildtype=plain builddir -Dc_args=... -Dcpp_args=... -Dc_link_args=... -Dcpp_link_args=...
$ meson compile -C builddir
$ meson test -C builddir
$ DESTDIR=/path/to/staging/root meson install -C builddir
</code></pre>
<p>The command line switch <code>--buildtype=plain</code> tells Meson not to add its
own flags to the command line. This gives the packager total control
on used flags.</p>
<p>This is very similar to other build systems. The only difference is
that the <code>DESTDIR</code> variable is passed as an environment variable
rather than as an argument to <code>meson install</code>.</p>
<p>As distro builds happen always from scratch, you might consider
enabling <a href="Unity-builds.html">unity builds</a> on your packages because they
are faster and produce better code. However there are many projects
that do not build with unity builds enabled so the decision to use
unity builds must be done by the packager on a case by case basis.</p>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
<hr>
<div class="license-description">
Website licensing information are available on the <a href="legal.html">Legal</a> page.
</div>
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://github.com/mesonbuild/meson/edit/master/docs/markdown/Quick-guide.md" data-hotdoc-role="edit-button">Edit on GitHub</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>