summaryrefslogtreecommitdiff
blob: faa4a1f6d482e354a1348dea2a5877976f9172c5 (plain)
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
<!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>Gentoo Policy Guide &#8212; 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 type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" 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="Preface" href="preface.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 class="active">
                            <a href="index.html">Home</a></li>
                                    <li class=""><a href="_sources/index.rst.txt">Source</a></li>
                                        <li>
                                    <a href="search.html">Search</a></li>
                                <li>
                                <a href="genindex.html">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="gentoo-policy-guide">
<h1>Gentoo Policy Guide<a class="headerlink" href="#gentoo-policy-guide" title="Permalink to this headline"></a></h1>
<p>Gentoo Policy Guide aims to become a definitive clear source of all
Tree Policies that are currently binding to Gentoo developers.
It combines both policies that are global by design (i.e. set by the QA
team or the Council), as well as specific to other Gentoo projects.
The policies are meant to be supplied with rationale and clear
indication of the body setting the policy, and therefore the process
in which the policy can be updated.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="preface.html">Preface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="preface.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="preface.html#authors">Authors</a></li>
<li class="toctree-l2"><a class="reference internal" href="preface.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation and history</a><ul>
<li class="toctree-l2"><a class="reference internal" href="motivation.html#historical-state-of-policy-documentation">Historical state of policy documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="motivation.html#purpose-of-the-policy-guide">Purpose of the Policy Guide</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="basics.html">Basic information</a><ul>
<li class="toctree-l2"><a class="reference internal" href="basics.html#goals-of-policy-making">Goals of policy making</a></li>
<li class="toctree-l2"><a class="reference internal" href="basics.html#policy-compliance-checking">Policy compliance checking</a></li>
<li class="toctree-l2"><a class="reference internal" href="basics.html#policy-enforcement">Policy enforcement</a></li>
<li class="toctree-l2"><a class="reference internal" href="basics.html#policy-making-changes-and-appeals">Policy making, changes and appeals</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="other-docs.html">Other policy documents</a><ul>
<li class="toctree-l2"><a class="reference internal" href="other-docs.html#gentoo-specific-documentation">Gentoo-specific documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="other-docs.html#external-standards">External standards</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#optional-runtime-dependencies">Optional runtime dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#dependencies-with-no-revision">=-dependencies with no revision</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#slot-and-subslot-dependencies">Slot and subslot dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#revision-bumps-on-runtime-dependency-changes">Revision bumps on runtime dependency changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#use-dependencies">USE dependencies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ebuild-format.html">Ebuild file format</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#coding-style">Coding style</a></li>
<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#code-must-be-contained-within-ebuild-and-eclasses">Code must be contained within ebuild and eclasses</a></li>
<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#homepage-must-not-contain-variables">HOMEPAGE must not contain variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#src-uri-must-not-refer-to-homepage">SRC_URI must not refer to HOMEPAGE</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system layout</a><ul>
<li class="toctree-l2"><a class="reference internal" href="filesystem.html#installation-paths">Installation paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="filesystem.html#support-for-separate-usr">Support for separate /usr</a></li>
<li class="toctree-l2"><a class="reference internal" href="filesystem.html#strict-multilib-layout">Strict multilib layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="filesystem.html#static-libraries-and-libtool-files">Static libraries and libtool files</a></li>
<li class="toctree-l2"><a class="reference internal" href="filesystem.html#game-install-locations-and-ownership">Game install locations and ownership</a></li>
<li class="toctree-l2"><a class="reference internal" href="filesystem.html#absolute-symbolic-link-targets">Absolute symbolic link targets</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installed-files.html">Installed files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installed-files.html#installation-of-small-files">Installation of small files</a></li>
<li class="toctree-l2"><a class="reference internal" href="installed-files.html#installation-of-static-libraries">Installation of static libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="installed-files.html#installation-of-libtool-la-files">Installation of libtool (.la) files</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="keywords.html">Keywording and stabilization</a><ul>
<li class="toctree-l2"><a class="reference internal" href="keywords.html#rekeywording-on-dropped-keywords">Rekeywording on dropped keywords</a></li>
<li class="toctree-l2"><a class="reference internal" href="keywords.html#stabilizing-new-versions">Stabilizing new versions</a></li>
<li class="toctree-l2"><a class="reference internal" href="keywords.html#removing-stable-keywords">Removing stable keywords</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="languages.html">Language-specific policies</a><ul>
<li class="toctree-l2"><a class="reference internal" href="languages.html#python">Python</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="maintainer.html">Package Maintainers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="maintainer.html#adding-new-maintainers">Adding new maintainers</a></li>
<li class="toctree-l2"><a class="reference internal" href="maintainer.html#new-packages-without-a-maintainer">New packages without a maintainer</a></li>
<li class="toctree-l2"><a class="reference internal" href="maintainer.html#removing-package-maintainers">Removing package maintainers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="other-metadata.html">Other metadata variables</a><ul>
<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#dynamic-slots-multislot-flag">Dynamic slots (multislot flag)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="use-flags.html">USE flags</a><ul>
<li class="toctree-l2"><a class="reference internal" href="use-flags.html#versioned-use-flags">Versioned USE flags</a></li>
<li class="toctree-l2"><a class="reference internal" href="use-flags.html#use-gui-flag">USE=gui flag</a></li>
<li class="toctree-l2"><a class="reference internal" href="use-flags.html#underscores-in-use-flag-names">Underscores in USE flag names</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user-group.html">Users and groups</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user-group.html#user-and-group-account-policy">User and group account policy</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>



                    
    
        
        <div class="row" style="margin-top:50px;">
            <div class="col-sm-6">
                
            </div>

            <div class="col-sm-6">
                
                <a href="preface.html" class="pull-right" style="color:#767676;">
                    
                        Preface
                    
                    <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='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"><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 2.3.1</a> &amp; <a href="#">Tyrian Theme 0.0.1</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/3.0/" rel="license">CC-BY-SA-3.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>

        <div id="custom_toc">
                <h2 style="margin-top:20px!important;">Contents</h2>
            <div class="collapse" id="collapseExample" style="margin-top:10px;">
            </div>

        </div>

        <script type="text/javascript">
            $("#custom_toc").prependTo(".toctree-wrapper");
            $("#custom_toc").css("display", "inline-block");

            $('#collapseExample').on('show.bs.collapse', function () {
                $("#show_contents").html("hide");
            })

            $('#collapseExample').on('hide.bs.collapse', function () {
                $("#show_contents").html("show");
            })

            $("#collapseExample").collapse('show');
                $(".caption").next().detach().appendTo('#collapseExample');
                $(".caption").hide();

        </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>