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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Ebuild file format — Gentoo Policy Guide documentation</title>
<link rel="stylesheet" href="_static/tyrian-sphinx-theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="icon" href="https://www.gentoo.org/favicon.ico" type="image/x-icon">
<link href="https://assets.gentoo.org/tyrian/bootstrap.min.css" rel="stylesheet" media="screen">
<link href="https://assets.gentoo.org/tyrian/tyrian.min.css" rel="stylesheet" media="screen">
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/tyrian-sphinx-theme.css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="File system layout" href="filesystem.html" />
<link rel="prev" title="Deprecations" href="deprecation.html" />
</head><body>
<header>
<div class="site-title">
<div class="container">
<div class="row">
<div class="site-title-buttons">
<div class="btn-group btn-group-sm">
<a href="https://get.gentoo.org/" role="button" class="btn get-gentoo"><span class="fa fa-fw fa-download"></span> <strong>Get Gentoo!</strong></a>
<div class="btn-group btn-group-sm">
<a class="btn gentoo-org-sites dropdown-toggle" data-toggle="dropdown" data-target="#" href="#">
<span class="fa fa-fw fa-map-o"></span> <span class="hidden-xs">gentoo.org sites</span> <span class="caret"></span>
</a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="https://www.gentoo.org/" title="Main Gentoo website"><span class="fa fa-home fa-fw"></span> gentoo.org</a></li>
<li><a href="https://wiki.gentoo.org/" title="Find and contribute documentation"><span class="fa fa-file-text-o fa-fw"></span> Wiki</a></li>
<li><a href="https://bugs.gentoo.org/" title="Report issues and find common issues"><span class="fa fa-bug fa-fw"></span> Bugs</a></li>
<li><a href="https://forums.gentoo.org/" title="Discuss with the community"><span class="fa fa-comments-o fa-fw"></span> Forums</a></li>
<li><a href="https://packages.gentoo.org/" title="Find software for your Gentoo"><span class="fa fa-hdd-o fa-fw"></span> Packages</a></li>
<li class="divider"></li>
<li><a href="https://planet.gentoo.org/" title="Find out what's going on in the developer community"><span class="fa fa-rss fa-fw"></span> Planet</a></li>
<li><a href="https://archives.gentoo.org/" title="Read up on past discussions"><span class="fa fa-archive fa-fw"></span> Archives</a></li>
<li><a href="https://sources.gentoo.org/" title="Browse our source code"><span class="fa fa-code fa-fw"></span> Sources</a></li>
<li class="divider"></li>
<li><a href="https://infra-status.gentoo.org/" title="Get updates on the services provided by Gentoo"><span class="fa fa-server fa-fw"></span> Infra Status</a></li>
</ul>
</div>
</div>
</div>
<div class="logo">
<a href="index.html" title="Back to the homepage" class="site-logo"></a>
<span class="site-label"> Policy Guide </span>
</div>
</div>
</div>
</div>
<nav class="tyrian-navbar" role="navigation">
<div class="container">
<div class="row">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-main-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="collapse navbar-collapse navbar-main-collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">Home</a></li>
<li class=""><a href="_sources/ebuild-format.rst.txt">Source</a></li>
<li>
<a href="search.html">Search</a></li>
<li>
<a href="genindex.html">General Index</a>
</li>
<li>
<a href="std-policy-index.html">Policy Index</a>
</li>
</ul>
<form action="search.html" class="navbar-form navbar-right" method="get" onsubmit="if (this.quicksearch.value == '')
{ alert('Please enter one or more search terms first.');
return false; } return true;">
<div class="input-group" style="margin-top:2px;">
<span class="input-group-addon" style="background:#61597b;color:#FFF;border:0px;" id="basic-addon1"><i class="fa fa-search" aria-hidden="true"></i></span>
<input class="form-control" style="height:30px;border:0px;background:#61597b;color:#FFF;padding-left:0px;box-shadow: none;" type="text" id="quicksearch_top" name="q" title="Quick Search" placeholder="Quick Search" value="">
</div>
<button class="btn btn-default hidden" type="submit" value="Search" id="find_top">Search</button>
</form>
</div>
</div>
</div>
</nav>
</header>
<div class="container">
<div class="row">
<div class="col-md-9 col-sm-12 col-xs-12" role="main">
<section id="ebuild-file-format">
<h1>Ebuild file format<a class="headerlink" href="#ebuild-file-format" title="Permalink to this heading">¶</a></h1>
<section id="pg0101">
<span id="coding-style"></span><span id="index-0"></span><h2>Coding style<a class="headerlink" href="#pg0101" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG<span class="colon">:</span></dt>
<dd class="field-odd"><p>0101</p>
</dd>
<dt class="field-even">Source<span class="colon">:</span></dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported<span class="colon">:</span></dt>
<dd class="field-odd"><p>partially via repoman and pkgcheck</p>
</dd>
</dl>
<p>While Gentoo leaves most of the coding style choices to developers,
there are a few rules which we try to enforce. Those are:</p>
<ul class="simple">
<li><p>Always indent using a single tab for indentation level. Do not
attempt to align, as it will not work with different tab widths.</p></li>
<li><p>Whenever using named variables, use bracketed variable form, i.e.
<code class="docutils literal notranslate"><span class="pre">${foo}</span></code> rather than <code class="docutils literal notranslate"><span class="pre">$foo</span></code>.</p></li>
<li><p>Use bash conditions <code class="docutils literal notranslate"><span class="pre">[[</span> <span class="pre">...</span> <span class="pre">]]</span></code> rather than POSIX-ish <code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">...</span> <span class="pre">]</span></code>
or <code class="docutils literal notranslate"><span class="pre">test</span></code> builtin.</p></li>
</ul>
<p><em>Rationale</em>: the recommended constructs are less error-prone.
Consistency avoids unnecessary changes when other developers edit
the ebuild.</p>
</section>
<section id="pg0102">
<span id="code-must-be-contained-within-ebuild-and-eclasses"></span><span id="index-1"></span><h2>Code must be contained within ebuild and eclasses<a class="headerlink" href="#pg0102" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG<span class="colon">:</span></dt>
<dd class="field-odd"><p>0102</p>
</dd>
<dt class="field-even">Source<span class="colon">:</span></dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reference<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://bugs.gentoo.org/612630">https://bugs.gentoo.org/612630</a></p>
</dd>
<dt class="field-even">Reported<span class="colon">:</span></dt>
<dd class="field-even"><p>no</p>
</dd>
</dl>
<p>The ebuild code must be fully contained within .ebuild and .eclass
files. It is forbidden to load additional ebuild code from other files
via <code class="docutils literal notranslate"><span class="pre">source</span></code>, <code class="docutils literal notranslate"><span class="pre">eval</span></code> or any other possible method.</p>
<p>This affects historical use of ‘eblits’ to include phase functions from
external files. The eblits used by the few affected packages were
converted into eclasses.</p>
<p><em>Rationale</em>: moving ebuild code to non-standard locations is against
the principle of least surprise. It makes the maintenance harder,
confuses other developers and tools that do not explicitly account for
that possibility, including linting tools.</p>
</section>
<section id="pg0103">
<span id="homepage-must-not-contain-variables"></span><span id="index-2"></span><h2>HOMEPAGE must not contain variables<a class="headerlink" href="#pg0103" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG<span class="colon">:</span></dt>
<dd class="field-odd"><p>0103</p>
</dd>
<dt class="field-even">Source<span class="colon">:</span></dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported<span class="colon">:</span></dt>
<dd class="field-odd"><p>by pkgcheck, highlighted as error by gentoo-syntax</p>
</dd>
</dl>
<p>The <code class="docutils literal notranslate"><span class="pre">HOMEPAGE</span></code> variable in ebuild must specify all the URIs verbatim,
without referring to any variables. Variable references are allowed
when setting generic values in eclasses.</p>
<p><em>Rationale</em>: since homepage URIs do not contain dynamic parts (such
as package versions), there is little advantage to using variables
there. On the other hand, variables render the URIs unusable without
preprocessing, breaking URI support in terminals and editors, as well
as reducing the usefulness of plain tools such as grep.</p>
</section>
<section id="pg0104">
<span id="src-uri-must-not-refer-to-homepage"></span><span id="index-3"></span><h2>SRC_URI must not refer to HOMEPAGE<a class="headerlink" href="#pg0104" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG<span class="colon">:</span></dt>
<dd class="field-odd"><p>0104</p>
</dd>
<dt class="field-even">Source<span class="colon">:</span></dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported<span class="colon">:</span></dt>
<dd class="field-odd"><p>by pkgcheck</p>
</dd>
</dl>
<p>The <code class="docutils literal notranslate"><span class="pre">SRC_URI</span></code> variable in ebuild must not refer to <code class="docutils literal notranslate"><span class="pre">${HOMEPAGE}</span></code>.
If both overlap, the common part must be repeated verbatim.</p>
<p><em>Rationale</em>: <code class="docutils literal notranslate"><span class="pre">HOMEPAGE</span></code> permits multiple entries by design,
and developers are generally encouraged to add more helpful entries
(e.g. project pages on PyPI, GitHub…). Making individual URIs
incidentally depend on multi-valued variable having a single value
goes against the principle of least surprise. Furthermore, it makes
it hard to copy-paste part of the URI e.g. to investigate the directory
index.</p>
</section>
<section id="pg0105">
<span id="keywords-must-be-defined-on-a-single-line"></span><span id="index-4"></span><h2>KEYWORDS must be defined on a single line<a class="headerlink" href="#pg0105" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG<span class="colon">:</span></dt>
<dd class="field-odd"><p>0105</p>
</dd>
<dt class="field-even">Source<span class="colon">:</span></dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported<span class="colon">:</span></dt>
<dd class="field-odd"><p>no</p>
</dd>
</dl>
<p>The <code class="docutils literal notranslate"><span class="pre">KEYWORDS</span></code> variable must be defined at most once in an ebuild,
on a single line, with literal content (no variable references, line
wrapping, appending, etc.).</p>
<p><em>Rationale</em>: it is common for arch teams to use the <code class="docutils literal notranslate"><span class="pre">ekeyword</span></code> tool
when working with large number of ebuilds. The tool has only limited
ability to process and modify ebuilds, and therefore developers must
make sure that it works correctly on their ebuilds.</p>
</section>
<section id="pg0106">
<span id="license-must-not-contain-variables"></span><span id="index-5"></span><h2>LICENSE must not contain variables<a class="headerlink" href="#pg0106" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG<span class="colon">:</span></dt>
<dd class="field-odd"><p>0106</p>
</dd>
<dt class="field-even">Source<span class="colon">:</span></dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported<span class="colon">:</span></dt>
<dd class="field-odd"><p>no</p>
</dd>
</dl>
<p>The <code class="docutils literal notranslate"><span class="pre">LICENSE</span></code> variable in an ebuild must specify all the license names
verbatim, without referring to any variables. The only exception is
(implicit or explicit) use of <code class="docutils literal notranslate"><span class="pre">LICENSE</span></code> itself, i.e. appending is
allowed.</p>
<p><em>Rationale</em>: since license names do not contain dynamic parts (such as
package versions), using variables there has little advantage. On the
other hand, variables reduce the usefulness of plain tools such as grep.</p>
</section>
<section id="pg0107">
<span id="d-must-be-used-only-in-src-install-and-pkg-preinst"></span><span id="index-6"></span><h2>D must be used only in src_install and pkg_preinst<a class="headerlink" href="#pg0107" title="Permalink to this heading">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG<span class="colon">:</span></dt>
<dd class="field-odd"><p>0107</p>
</dd>
<dt class="field-even">Source<span class="colon">:</span></dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported<span class="colon">:</span></dt>
<dd class="field-odd"><p>no</p>
</dd>
</dl>
<p>The <code class="docutils literal notranslate"><span class="pre">D</span></code> and <code class="docutils literal notranslate"><span class="pre">ED</span></code> variables must be used only in the <code class="docutils literal notranslate"><span class="pre">src_install</span></code>
and <code class="docutils literal notranslate"><span class="pre">pkg_preinst</span></code> phase functions. Exceptions to this policy can be
granted by the QA team.</p>
<p><em>Rationale</em>: using <code class="docutils literal notranslate"><span class="pre">D</span></code> in other phases (e.g. <code class="docutils literal notranslate"><span class="pre">src_configure</span></code>) is
error-prone and may lead to the path being embedded in files of the
installed image. In addition, the directory pointed to by <code class="docutils literal notranslate"><span class="pre">${D}</span></code>
does not exist in other phases.</p>
</section>
</section>
<div class="row" style="margin-top:50px;">
<div class="col-sm-6">
<a href="deprecation.html" style="color:#767676;">
<i class="fa fa-angle-double-left" aria-hidden="true"></i>
Deprecations
</a>
</div>
<div class="col-sm-6">
<a href="filesystem.html" class="pull-right" style="color:#767676;">
File system layout
<i class="fa fa-angle-double-right" aria-hidden="true"></i>
</a>
</div>
</div>
</div>
<div class="col-md-3 hidden-sm hidden-xs" role="main">
<div class="" role="navigation" aria-label="main navigation">
<div class="">
<nav class="bs-docs-sidebar" data-spy="affix" data-offset-top="140" data-offset-bottom="400">
<p class="hidden" role="heading"><span class="hidden-text">Contents:</span></p>
<ul class='current nav'>
<li class="toctree-l1"><a class="reference internal" href="preface.html">Preface</a></li>
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation and history</a></li>
<li class="toctree-l1"><a class="reference internal" href="basics.html">Basic information</a></li>
<li class="toctree-l1"><a class="reference internal" href="other-docs.html">Other policy documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecation.html">Deprecations</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Ebuild file format</a><ul class='nav'>
<li class="toctree-l2"><a class="reference internal" href="#pg0101">Coding style</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0102">Code must be contained within ebuild and eclasses</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0103">HOMEPAGE must not contain variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0104">SRC_URI must not refer to HOMEPAGE</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0105">KEYWORDS must be defined on a single line</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0106">LICENSE must not contain variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0107">D must be used only in src_install and pkg_preinst</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="installed-files.html">Installed files</a></li>
<li class="toctree-l1"><a class="reference internal" href="keywords.html">Keywording and stabilization</a></li>
<li class="toctree-l1"><a class="reference internal" href="languages.html">Language-specific policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="maintainer.html">Package Maintainers</a></li>
<li class="toctree-l1"><a class="reference internal" href="other-metadata.html">Other metadata variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="use-flags.html">USE flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-group.html">Users and groups</a></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-12 col-md-offset-2 col-md-7">
<h3 class="footerhead">Gentoo Policy Guide </h3>
<div class="row">
<div class="col-xs-12 col-md-4">
<span class="kk-group-header">Powered by</span><br><span><a href="http://sphinx-doc.org/">Sphinx 6.1.3</a> & <a href="https://github.com/mmagorsc/tyrian_sphinx_theme">Tyrian Theme 0.0.7</a></span>
</div>
<div class="col-xs-12 col-md-4">
</div>
<div class="col-xs-12 col-md-4">
</div>
</div>
</div>
<div class="col-xs-12 col-md-3">
<h3 class="footerhead">Questions or comments?</h3>
Please feel free to <a href="https://www.gentoo.org/inside-gentoo/contact/">contact us</a>.
</div>
</div>
<div class="row">
<div class="col-xs-2 col-sm-3 col-md-2">
<ul class="footerlinks three-icons">
<li><a href="https://twitter.com/gentoo" title="@Gentoo on Twitter"><span class="fa fa-twitter fa-fw"></span></a></li>
<li><a href="https://plus.google.com/+Gentoo" title="+Gentoo on Google+"><span class="fa fa-google-plus fa-fw"></span></a></li>
<li><a href="https://www.facebook.com/gentoo.org" title="Gentoo on Facebook"><span class="fa fa-facebook fa-fw"></span></a></li>
</ul>
</div>
<div class="col-xs-10 col-sm-9 col-md-10">
<strong>© 2001–2023 Gentoo Authors</strong><br>
<small>
Gentoo is a trademark of the Gentoo Foundation, Inc.
The contents of this document, unless otherwise expressly stated, are licensed under the
<a href="https://creativecommons.org/licenses/by-sa/4.0/" rel="license">CC-BY-SA-4.0</a> license.
The <a href="https://www.gentoo.org/inside-gentoo/foundation/name-logo-guidelines.html">Gentoo Name and Logo Usage Guidelines</a> apply.
</small>
</div>
</div>
</div>
</footer>
<script src="https://assets.gentoo.org/tyrian/bootstrap.min.js"></script>
<script type="text/javascript">
$('body').scrollspy({
target: '.bs-docs-sidebar',
offset: 40
});
</script>
<script type="text/javascript">
$('#indices-and-tables').hide()
</script>
</body>
</html>
|
GitWeb