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
|
<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml">
<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.17.1: http://docutils.sourceforge.net/" />
<title>Other metadata variables — 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/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="USE flags" href="use-flags.html" />
<link rel="prev" title="Package Maintainers" href="maintainer.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/other-metadata.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="other-metadata-variables">
<h1>Other metadata variables<a class="headerlink" href="#other-metadata-variables" title="Permalink to this headline">¶</a></h1>
<span class="target" id="index-0"></span><section id="pg0701">
<span id="dynamic-slots-multislot-flag"></span><span id="index-1"></span><h2>Dynamic slots (multislot flag)<a class="headerlink" href="#pg0701" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0701</p>
</dd>
<dt class="field-even">Source</dt>
<dd class="field-even"><p>QA (inferred from PMS)</p>
</dd>
<dt class="field-odd">Reference</dt>
<dd class="field-odd"><p><a class="reference external" href="https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#multislot.2FUSE-dependent_SLOT">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#multislot.2FUSE-dependent_SLOT</a></p>
</dd>
<dt class="field-even">Reported</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">use</span></code> in global scope triggers fatal error</p>
</dd>
</dl>
<p>The use of <code class="docutils literal notranslate"><span class="pre">multislot</span></code> to alter <code class="docutils literal notranslate"><span class="pre">SLOT</span></code> values (as well as any other
USE-dependent slot values) in the Gentoo repository is forbidden.
Such a feature can be used in overlays, and it is acceptable to provide
such support in eclasses as long as it is not used in ::gentoo.</p>
<p>This policy has been explicitly declared in response to historical
(pre-2016) use of <code class="docutils literal notranslate"><span class="pre">USE=multislot</span></code> in toolchain ebuilds. When the flag
was disabled, all package versions used the same slot, and upgrades were
handled as for non-slotted packages. When the flag was enabled, each
version used a separate slot, permitting multiple versions being
installed simultaneously. This allowed the user to choose between
the two options.</p>
<p>The original violation has been resolved by unconditionally slotting
the packages. This permitted the users to install multiple versions
in parallel, while removal of old versions was to be handled via
<code class="docutils literal notranslate"><span class="pre">emerge</span> <span class="pre">--depclean</span></code>.</p>
<p><em>Rationale</em>: this feature was in direct violation of PMS <a class="reference external" href="https://projects.gentoo.org/pms/7/pms.html#x1-600007.1">metadata
invariance</a> requirements. It caused the cached slot value to depend
on the state of querying the USE flag (which in turn could technically
depend on slot, via <code class="docutils literal notranslate"><span class="pre">package.use</span></code>). This caused undefined package
manager behavior which could include use of unpredictable slot, cache
invalidation or explicit errors.</p>
</section>
<section id="pg0702">
<span id="homepage-value-must-be-meaningful"></span><span id="index-2"></span><h2>HOMEPAGE value must be meaningful<a class="headerlink" href="#pg0702" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0702</p>
</dd>
<dt class="field-even">Source</dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reference</dt>
<dd class="field-odd"><p><a class="reference external" href="https://archives.gentoo.org/gentoo-dev/message/83cc5bbd7bbe8bdf04dd3c3bc7f8a035">https://archives.gentoo.org/gentoo-dev/message/83cc5bbd7bbe8bdf04dd3c3bc7f8a035</a></p>
</dd>
<dt class="field-even">Reported</dt>
<dd class="field-even"><p>known bad values are reported by pkgcheck</p>
</dd>
</dl>
<p>The HOMEPAGE specified for the package should either be dedicated
to the package in question or make it easy to find dedicated
information. Packages must not use <code class="docutils literal notranslate"><span class="pre">https://www.gentoo.org/</span></code>
or a similar generic homepage. If no homepage is available, the special
value of <code class="docutils literal notranslate"><span class="pre">https://wiki.gentoo.org/wiki/No_homepage</span></code> must be used.</p>
<p><em>Rationale</em>: The homepage specified in ebuilds is normally used to
locate information about the upstream project, e.g. downloads, source
code repository, bug tracker, documentation. Homepages that make it
hard to locate information about a specific project have little value,
and the Gentoo homepage generally does not do a good job at linking even
major Gentoo projects. Furthermore, many of the projects did not even
have a single dedicated subpage anywhere in Gentoo web space. In all
those cases, using the explicit No_homepage marker at least makes it
easy to identify such packages.</p>
</section>
<section id="pg0703">
<span id="restrict-test-for-use-test"></span><span id="index-3"></span><h2>RESTRICT=test for USE=-test<a class="headerlink" href="#pg0703" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0703</p>
</dd>
<dt class="field-even">Source</dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported</dt>
<dd class="field-odd"><p>by pkgcheck</p>
</dd>
</dl>
<p>Whenever the package uses <code class="docutils literal notranslate"><span class="pre">test</span></code> flag to control test prerequisites
(or another flag with a similar purpose), it must explicitly restrict
tests when the flag is unset.</p>
<p><em>Example</em>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">IUSE</span><span class="o">=</span><span class="s2">"test"</span>
<span class="n">RESTRICT</span><span class="o">=</span><span class="s2">"!test? ( test )"</span>
</pre></div>
</div>
<p><em>Rationale</em>: contrary to common assumption, <code class="docutils literal notranslate"><span class="pre">test</span></code> flag is not special
and the package manager can execute tests when the flag is disabled.
The explicit restriction guarantees that tests will be skipped under
this circumstance, and they will not fail for users.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Technically there are packages that do not strictly require this
restriction since they handle missing test prerequisites gracefully
(e.g. by skipping the tests). However, we enforce the rule for all
packages since omitting the restriction by mistake is much more
common, and there is little harm in overspecifying it.</p>
</div>
</section>
<section id="pg0704">
<span id="license"></span><span id="index-4"></span><h2>LICENSE<a class="headerlink" href="#pg0704" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0704</p>
</dd>
<dt class="field-even">Source</dt>
<dd class="field-even"><p>QA</p>
</dd>
<dt class="field-odd">Reported</dt>
<dd class="field-odd"><p>no</p>
</dd>
</dl>
<p>The <code class="docutils literal notranslate"><span class="pre">LICENSE</span></code> variable must explicitly list licenses for all files
installed by the package. If some of the applicable licenses are
conditional to USE flags, appropriate USE conditionals need to
be expressed in the variable.</p>
<p>If a package bundles any dependencies that are either installed,
statically linked or in any other way combined with installed files,
the licenses of these dependencies need to be listed as well. This
is not presently required when statically linking to dependencies
installed by separate packages in the repository.</p>
<p>The licenses for files that are not installed but that are used at build
time are not listed explicitly.</p>
<p><em>Rationale</em>: the primary purpose of the license support in the package
manager is to provide the users with ability to decide on acceptable
licenses for their installed systems (and binary packages). In order
for this to work effectively, the packages must provide a correct
and complete license list.</p>
<p>Static linking combines code from multiple packages, potentially covered
by different licenses. Listing all licenses is the simplest way
of ensuring that nothing is missed, as well as protecting against wrong
derivative work licenses stated upstream (i.e. when a less restrictively
licensed package links to a more restrictively licensed dependency).</p>
<p>Listing of licenses is enforced for bundled dependencies but not for
static linking to other packages, as in the latter case it is
non-trivial to implement and the package manager already verifies
the license while building dependencies (but not when installing binary
packages).</p>
<p>The ebuild format does not provide a separate variable to list licenses
needed only at build time. So far it has not been considered important
enough to have one, as the relevant files exist only temporarily
on the user’s system and do not affect the runtime use of packages.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Please remember to include the licenses of support files provided
by the ebuild, e.g. init.d scripts (usually GPL-2).</p>
</div>
</section>
</section>
<div class="row" style="margin-top:50px;">
<div class="col-sm-6">
<a href="maintainer.html" style="color:#767676;">
<i class="fa fa-angle-double-left" aria-hidden="true"></i>
Package Maintainers
</a>
</div>
<div class="col-sm-6">
<a href="use-flags.html" class="pull-right" style="color:#767676;">
USE flags
<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"><a class="reference internal" href="ebuild-format.html">Ebuild file format</a></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 current"><a class="current reference internal" href="#">Other metadata variables</a><ul class='nav'>
<li class="toctree-l2"><a class="reference internal" href="#pg0701">Dynamic slots (multislot flag)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0702">HOMEPAGE value must be meaningful</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0703">RESTRICT=test for USE=-test</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0704">LICENSE</a></li>
</ul>
</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 4.1.2</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–2020 Gentoo Foundation, Inc.</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