-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathPkgconfig-module.html
402 lines (365 loc) · 16.6 KB
/
Pkgconfig-module.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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
<!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>Pkgconfig module</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="Pkgconfig-module.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="pkgconfig-module">Pkgconfig module</h1>
<p>This module is a simple generator for
<a href="https://pkg-config.freedesktop.org/">pkg-config</a> files.</p>
<h2 id="usage">Usage</h2>
<pre><code class="language-meson">pkg = import('pkgconfig')
bar_dep = dependency('bar')
lib = library('foo', dependencies : [bar])
pkg.generate(lib)
</code></pre>
<h3 id="pkggenerate">pkg.generate()</h3>
<p>The generated file's properties are specified with the following
keyword arguments.</p>
<ul>
<li>
<code>description</code> a string describing the library, used to set the <code>Description:</code> field</li>
<li>
<code>extra_cflags</code> a list of extra compiler flags to be added to the
<code>Cflags</code> field after the header search path</li>
<li>
<code>filebase</code> the base name to use for the pkg-config file; as an
example, the value of <code>libfoo</code> would produce a pkg-config file called
<code>libfoo.pc</code>
</li>
<li>
<code>install_dir</code> the directory to install to, defaults to the value of
option <code>libdir</code> followed by <code>/pkgconfig</code>
</li>
<li>
<code>libraries</code> a list of built libraries (usually results of
shared_library) that the user needs to link against. Arbitrary strings can
also be provided and they will be added into the <code>Libs</code> field. Since 0.45.0
dependencies of built libraries will be automatically added, see the
<a href="Pkgconfig-module.html#implicit-dependencies">Implicit dependencies</a> section below for the exact
rules. Since 0.58.0 custom_target() objects are supported as long as they are
linkable (has known extension such as <code>.a</code>, <code>.so</code>, etc).</li>
<li>
<code>libraries_private</code> list of built libraries or strings to put in the
<code>Libs.private</code> field. Since 0.45.0 dependencies of built libraries will be
automatically added, see the <a href="Pkgconfig-module.html#implicit-dependencies">Implicit dependencies</a>
section below for the exact rules. Since 0.58.0 custom_target() objects are
supported as long as they are linkable (has known extension such as <code>.a</code>,
<code>.so</code>, etc).</li>
<li>
<code>name</code> the name of this library, used to set the <code>Name:</code> field</li>
<li>
<code>subdirs</code> which subdirs of <code>include</code> should be added to the header
search path, for example if you install headers into
<code>${PREFIX}/include/foobar-1</code>, the correct value for this argument
would be <code>foobar-1</code>
</li>
<li>
<code>requires</code> list of strings, pkgconfig-dependencies or libraries that
<code>pkgconfig.generate()</code> was used on to put in the <code>Requires</code> field</li>
<li>
<code>requires_private</code> the same as <code>requires</code> but for the <code>Requires.private</code> field</li>
<li>
<code>url</code> a string with a url for the library</li>
<li>
<code>variables</code> a list of strings with custom variables to add to the
generated file. The strings must be in the form <code>name=value</code> and may
reference other pkgconfig variables,
e.g. <code>datadir=${prefix}/share</code>. The names <code>prefix</code>, <code>libdir</code> and
<code>includedir</code> are reserved and may not be used. <em>Since 0.56.0</em> it can also be a
dictionary but ordering of Meson dictionaries are not guaranteed, which could
cause issues when some variables reference other variables.
Spaces in values are escaped with <code>\</code>, this is required in the case the value is
a path that and is used in <code>cflags</code> or <code>libs</code> arguments. <em>Since 0.59.0</em> if
escaping is not desired (e.g. space separate list of values) <code>unescaped_variables</code>
keyword argument should be used instead. <em>Since 0.62.0</em> builtin directory variables
that are referenced are automatically created by default.</li>
<li>
<code>uninstalled_variables</code> used instead of the <code>variables</code> keyword argument, when
generating the uninstalled pkg-config file. Since <em>0.54.0</em>
Spaces in values are escaped with <code>\</code>, this is required in the case the value is
a path that and is used in <code>cflags</code> or <code>libs</code> arguments. <em>Since 0.59.0</em> if
escaping is not desired (e.g. space separate list of values)
<code>unescaped_uninstalled_variables</code> keyword argument should be used instead.</li>
<li>
<code>version</code> a string describing the version of this library, used to set the
<code>Version:</code> field. (<em>since 0.46.0</em>) Defaults to the project version if unspecified.</li>
<li>
<code>d_module_versions</code> a list of module version flags used when compiling
D sources referred to by this pkg-config file</li>
<li>
<code>dataonly</code> field. (<em>since 0.54.0</em>) this is used for architecture-independent
pkg-config files in projects which also have architecture-dependent outputs.</li>
<li>
<code>conflicts</code> (<em>since 0.36.0, incorrectly issued a warning prior to 0.54.0</em>) list of strings to be put in the <code>Conflicts</code> field.</li>
</ul>
<p>Since 0.46 a <code>StaticLibrary</code> or <code>SharedLibrary</code> object can optionally
be passed as first positional argument. If one is provided a default
value will be provided for all required fields of the pc file:</p>
<ul>
<li>
<code>install_dir</code> is set to <code>pkgconfig</code> folder in the same location than the provided library.</li>
<li>
<code>description</code> is set to the project's name followed by the library's name.</li>
<li>
<code>name</code> is set to the library's name.</li>
</ul>
<p>Since 0.54.0 uninstalled pkg-config files are generated as well. They
are located in <code><build dir>/meson-uninstalled/</code>. It is sometimes
useful to build projects against libraries built by Meson without
having to install them into a prefix. In order to do so, just set
<code>PKG_CONFIG_PATH=<builddir>/meson-uninstalled</code> before building your
application. That will cause pkg-config to prefer those
<code>-uninstalled.pc</code> files and find libraries and headers from the Meson
builddir. This is an experimental feature provided on a best-effort
basis, it might not work in all use-cases.</p>
<h3 id="implicit-dependencies">Implicit dependencies</h3>
<p>The exact rules followed to find dependencies that are implicitly
added into the pkg-config file have evolved over time. Here are the
rules as of Meson <em>0.49.0</em>, previous versions might have slightly
different behaviour.</p>
<ul>
<li>Not found libraries or dependencies are ignored.</li>
<li>Libraries and dependencies are private by default (i.e. added into
<code>Requires.private:</code> or <code>Libs.private:</code>) unless they are explicitly added in
<code>libraries</code> or <code>requires</code> keyword arguments, or is the main library (first
positional argument).</li>
<li>Libraries and dependencies will be de-duplicated, if they are added in both
public and private (e.g <code>Requires:</code> and <code>Requires.private:</code>) it will be removed
from the private list.</li>
<li>Shared libraries (i.e. <code>shared_library()</code> and <strong>NOT</strong> <code>library()</code>) add only
<code>-lfoo</code> into <code>Libs:</code> or <code>Libs.private:</code> but their dependencies are not pulled.
This is because dependencies are only needed for static link.</li>
<li>Other libraries (i.e. <code>static_library()</code> or <code>library()</code>) add <code>-lfoo</code> into <code>Libs:</code>
or <code>Libs.private:</code> and recursively add their dependencies into <code>Libs.private:</code> or
<code>Requires.private:</code>.</li>
<li>Dependencies provided by pkg-config are added into <code>Requires:</code> or
<code>Requires.private:</code>. If a version was specified when declaring that dependency
it will be written into the generated file too.</li>
<li>The threads dependency (i.e. <code>dependency('threads')</code>) adds <code>-pthread</code> into
<code>Libs:</code> or <code>Libs.private:</code>.</li>
<li>Internal dependencies (i.e.
<code>declare_dependency(compiler_args : '-DFOO', link_args : '-Wl,something', link_with : foo)</code>)
add <code>compiler_args</code> into <code>Cflags:</code> if public, <code>link_args</code> and <code>link_with</code> into
<code>Libs:</code> if public or <code>Libs.private:</code> if private.</li>
<li>Other dependency types add their compiler arguments into <code>Cflags:</code> if public,
and linker arguments into <code>Libs:</code> if public or <code>Libs.private:</code> if private.</li>
<li>Once a pkg-config file is generated for a library using <code>pkg.generate(mylib)</code>,
any subsequent call to <code>pkg.generate()</code> where mylib appears, will generate a
<code>Requires:</code> or <code>Requires.private</code> instead of a <code>Libs:</code> or <code>Libs.private:</code>.</li>
</ul>
<h3 id="relocatable-pkgconfig-files">Relocatable pkg-config files</h3>
<p>By default, the files generated by <code>pkg.generate</code> contain a hardcoded prefix path.
In order to make them relocatable, a <code>pkgconfig.relocatable</code> builtin option is provided.
See <a href="Builtin-options.html#pkgconfig-module">Pkgconfig module options</a>.</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/Pkgconfig-module.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>