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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
|
<!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">
<title>File system layout — 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">
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installed files" href="installed-files.html" />
<link rel="prev" title="Ebuild file format" href="ebuild-format.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/filesystem.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">
<div class="section" id="file-system-layout">
<h1>File system layout<a class="headerlink" href="#file-system-layout" title="Permalink to this headline">¶</a></h1>
<div class="section" id="pg0201">
<span id="installation-paths"></span><span id="index-0"></span><h2>Installation paths<a class="headerlink" href="#pg0201" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0201</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://gitweb.gentoo.org/repo/gentoo.git/tree/metadata/install-qa-check.d/08gentoo-paths">https://gitweb.gentoo.org/repo/gentoo.git/tree/metadata/install-qa-check.d/08gentoo-paths</a></p>
</dd>
<dt class="field-even">Reported</dt>
<dd class="field-even"><p>via install-qa-check.d</p>
</dd>
</dl>
<p>Gentoo packages may only install into one of the following top-level
directories:</p>
<table class="hlist"><tr><td><ul class="simple">
<li><p>/bin</p></li>
<li><p>/boot</p></li>
</ul>
</td><td><ul class="simple">
<li><p>/dev</p></li>
<li><p>/etc</p></li>
</ul>
</td><td><ul class="simple">
<li><p>/lib*</p></li>
<li><p>/opt</p></li>
</ul>
</td><td><ul class="simple">
<li><p>/sbin</p></li>
<li><p>/srv</p></li>
</ul>
</td><td><ul class="simple">
<li><p>/usr</p></li>
<li><p>/var</p></li>
</ul>
</td></tr></table>
<p>Furthermore, only the following subdirectories of /usr are permitted:</p>
<table class="hlist"><tr><td><ul class="simple">
<li><p>/usr/bin</p></li>
<li><p>/usr/include</p></li>
</ul>
</td><td><ul class="simple">
<li><p>/usr/lib*</p></li>
<li><p>/usr/libexec</p></li>
</ul>
</td><td><ul class="simple">
<li><p>/usr/sbin</p></li>
<li><p>/usr/share</p></li>
</ul>
</td><td><ul class="simple">
<li><p>/usr/src</p></li>
<li><p>/usr/<triplet></p></li>
</ul>
</td></tr></table>
<p>Furthermore, within /usr/share/doc hierarchy only a subdirectory named
after full package name and version with revision (PF) is permitted.</p>
<p>In the aforementioned lists, ‘lib*’ indicates lib and its appropriate
suffixed variants for the architecture in question. ‘<triplet>’
indicates either CHOST or CTARGET value, as used by toolchain packages.</p>
<p>Additional exceptions can be granted by the QA team. Currently those
exceptions are:</p>
<ul class="simple">
<li><p>/gnu for the guix package manager</p></li>
<li><p>/nix for the nix package manager</p></li>
</ul>
</div>
<div class="section" id="pg0202">
<span id="support-for-separate-usr"></span><span id="index-1"></span><h2>Support for separate /usr<a class="headerlink" href="#pg0202" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0202</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://projects.gentoo.org/council/meeting-logs/20130813-summary.txt">https://projects.gentoo.org/council/meeting-logs/20130813-summary.txt</a>
<a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20130924-summary.txt">https://projects.gentoo.org/council/meeting-logs/20130924-summary.txt</a></p>
</dd>
<dt class="field-even">Reported</dt>
<dd class="field-even"><p>no</p>
</dd>
</dl>
<p>Developers are not required to support using separate /usr filesystem
without an initramfs.</p>
<p><em>Rationale</em>: upstream software (as of 2013) is already making support
for early boot without /usr mounted difficult, and whenever it is still
works, it is either subtly broken or relying on hacks (udev). In setups
using initramfs, some of the boot and repair functionality can be moved
from rootfs to initramfs.</p>
</div>
<div class="section" id="pg0203">
<span id="strict-multilib-layout"></span><span id="index-2"></span><h2>Strict multilib layout<a class="headerlink" href="#pg0203" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0203</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://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80multilib-strict">https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80multilib-strict</a></p>
</dd>
<dt class="field-even">Reported</dt>
<dd class="field-even"><p>via install-qa-check.d, fatal</p>
</dd>
</dl>
<p>Libraries must be installed into an appropriate /lib* or /usr/lib*
directory corresponding to their ABI. For example, 64-bit libraries
on amd64 must be installed into lib64 and not lib.</p>
<p>Libraries installed as a part of larger software package can be
installed along with it into a subdirectory of lib.</p>
<p><em>Rationale</em>: historically, Gentoo has been symlinking /lib to /lib64
in order to maintain compatibility with old packages hardcoding /lib
path. With modern Gentoo profiles, this is no longer the case
and packages must install libraries into appropriate directory for them
to be correctly found by the dynamic loader.</p>
</div>
<div class="section" id="pg0204">
<span id="static-libraries-and-libtool-files"></span><span id="index-3"></span><h2>Static libraries and libtool files<a class="headerlink" href="#pg0204" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0204</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://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80libraries">https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80libraries</a></p>
</dd>
<dt class="field-even">Reported</dt>
<dd class="field-even"><p>via install-qa-check.d, fatal</p>
</dd>
</dl>
<p>Static libraries and libtool files (.la) must be installed into /usr
hierarchy and never to root filesystem (/lib*). If an additional shared
version of the library is installed to /lib*, a .so linker script must
be installed into /usr/lib* in order to ensure correct linking.</p>
<p><em>Rationale</em>: historically, the purpose of root filesystem was to hold
files strictly needed at boot. For this reason, many old Gentoo
installations may still use small / partition. Static libraries are
used only during package builds, and installing them to rootfs would
be a waste of space.</p>
</div>
<div class="section" id="pg0205">
<span id="game-install-locations-and-ownership"></span><span id="index-4"></span><h2>Game install locations and ownership<a class="headerlink" href="#pg0205" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0205</p>
</dd>
<dt class="field-even">Source</dt>
<dd class="field-even"><p>Council, clarified by QA</p>
</dd>
<dt class="field-odd">Reference</dt>
<dd class="field-odd"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20151213-summary.txt">https://projects.gentoo.org/council/meeting-logs/20151213-summary.txt</a>
<a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt">https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt</a></p>
</dd>
<dt class="field-even">Reported</dt>
<dd class="field-even"><p>via install-qa-check.d</p>
</dd>
</dl>
<p>The historical game install locations (/usr/games and /etc/games) must
not be used anymore. Instead, games should follow normal guidelines
for install locations. As an exception, /usr/share/games can be used
if this location is used upstream, and /var/games can be used for shared
game files (e.g. high scores, game state files).</p>
<p>The historical games group must no longer be used. Games must work
for users that are not in this group. The aforementioned install
locations must therefore be owned by root and be world-readable.</p>
<p>If games need privileged access to shared files, the group gamestat
can be used for this purpose. The game executables should be owned
by that group and made setgid. The shared files must be installed
into /var/games hierarchy, and writable to gamestat group.</p>
<p><em>Rationale</em>: there is no technical reason to isolate games from other
applications on the system, or to restrict access to them. The boundary
between game and non-game packages is very blurry on modern systems,
especially due to web browsers.</p>
<p>The historical use of games group on Gentoo to control access is
inconsistent with the use in other distributions where it was used to
share data files. Since the latter implied users must not be added
to the games group, a new group (gamestat) needed to be created to
fulfill that purpose.</p>
</div>
<div class="section" id="pg0206">
<span id="absolute-symbolic-link-targets"></span><span id="index-5"></span><h2>Absolute symbolic link targets<a class="headerlink" href="#pg0206" title="Permalink to this headline">¶</a></h2>
<dl class="field-list simple">
<dt class="field-odd">PG</dt>
<dd class="field-odd"><p>0206</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 repoman and pkgcheck (when ebuild-generated)</p>
</dd>
</dl>
<p>Packages must not install symbolic links with absolute targets.
Instead, relative paths must be used. An exception is granted
for symlinks to specially mounted filesystems (such as /proc, /run)
when symlinks are supposed to always reference the running host system.</p>
<p><em>Example</em>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># BAD:</span>
<span class="n">dosym</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">frobnicate</span><span class="o">/</span><span class="n">frobnicate</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">frobnicate</span>
<span class="c1"># GOOD:</span>
<span class="n">dosym</span> <span class="o">../</span><span class="n">lib</span><span class="o">/</span><span class="n">frobnicate</span><span class="o">/</span><span class="n">frobnicate</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">frobnicate</span>
<span class="c1"># ACCEPTABLE EXCEPTION:</span>
<span class="n">dosym</span> <span class="o">/</span><span class="n">proc</span><span class="o">/</span><span class="bp">self</span><span class="o">/</span><span class="n">mounts</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">mtab</span>
</pre></div>
</div>
<p><em>Rationale</em>: absolute symlinks work correctly only when the root
filesystem is mounted at /. They point at the wrong location whenever
it is mounted in another location, e.g. for the purposes of recovery.</p>
</div>
</div>
<div class="row" style="margin-top:50px;">
<div class="col-sm-6">
<a href="ebuild-format.html" style="color:#767676;">
<i class="fa fa-angle-double-left" aria-hidden="true"></i>
Ebuild file format
</a>
</div>
<div class="col-sm-6">
<a href="installed-files.html" class="pull-right" style="color:#767676;">
Installed files
<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"><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="ebuild-format.html">Ebuild file format</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">File system layout</a><ul class='nav'>
<li class="toctree-l2"><a class="reference internal" href="#pg0201">Installation paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0202">Support for separate /usr</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0203">Strict multilib layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0204">Static libraries and libtool files</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0205">Game install locations and ownership</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0206">Absolute symbolic link targets</a></li>
</ul>
</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 2.4.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–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