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
|
<!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="viewport" content="width=device-width, initial-scale=1" />
<title>Editing and publishing updates to this Guide — Gentoo Policy Guide documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/tyrian-sphinx-theme.css?v=637b0b67" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=56c4699f" />
<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?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/tyrian-sphinx-theme.css?v=637b0b67" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=56c4699f" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Dependencies" href="dependencies.html" />
<link rel="prev" title="Other policy documents" href="other-docs.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/editing.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="editing-and-publishing-updates-to-this-guide">
<h1>Editing and publishing updates to this Guide<a class="headerlink" href="#editing-and-publishing-updates-to-this-guide" title="Link to this heading">¶</a></h1>
<section id="formatting-and-style">
<h2>Formatting and style<a class="headerlink" href="#formatting-and-style" title="Link to this heading">¶</a></h2>
<p>While editing the Guide, please respect the existing formatting rules.
Notably:</p>
<ul class="simple">
<li><p>wrap lines at 72 characters</p></li>
<li><p>two spaces between sentences (after full stop), one space otherwise</p></li>
<li><p>one empty line between titles and paragraphs, two empty lines between
text and next section</p></li>
<li><p>indent using spaces, aligning to previous line</p></li>
</ul>
<p>When adding a new rule, use the chapter with a fitting topic. Some
rules match multiple chapters, choose the one that fits it best. Make
sure to match existing keywords in index.</p>
</section>
<section id="getting-sources">
<h2>Getting sources<a class="headerlink" href="#getting-sources" title="Link to this heading">¶</a></h2>
<p>The reference repository is hosted at git.gentoo.org, and available
via <a class="reference external" href="https://gitweb.gentoo.org/proj/policy-guide.git/">proj/policy-guide.git gitweb</a>. To clone it:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># via https</span>
<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">anongit</span><span class="o">.</span><span class="n">gentoo</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">git</span><span class="o">/</span><span class="n">proj</span><span class="o">/</span><span class="n">policy</span><span class="o">-</span><span class="n">guide</span><span class="o">.</span><span class="n">git</span>
<span class="c1"># via ssh</span>
<span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="nd">@git</span><span class="o">.</span><span class="n">gentoo</span><span class="o">.</span><span class="n">org</span><span class="p">:</span><span class="n">proj</span><span class="o">/</span><span class="n">policy</span><span class="o">-</span><span class="n">guide</span><span class="o">.</span><span class="n">git</span>
</pre></div>
</div>
<p>Non-developers wishing to send pull requests may prefer to fork
the GitHub <a class="reference external" href="https://github.com/gentoo/policy-guide">gentoo/policy-guide repository</a> and clone their own fork
instead.</p>
</section>
<section id="building">
<h2>Building<a class="headerlink" href="#building" title="Link to this heading">¶</a></h2>
<p>A tox-file is provided to build the Guide in a virtualenv, installing
all necessary dependencies. To build the HTML version, run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tox</span>
</pre></div>
</div>
<p>Another format (as well as other make arguments) can be specified
as a command-line argument, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tox</span> <span class="n">latexpdf</span>
</pre></div>
</div>
</section>
<section id="sending-contributions">
<h2>Sending contributions<a class="headerlink" href="#sending-contributions" title="Link to this heading">¶</a></h2>
<p>Changes to this document can be either submitted to <a class="reference external" href="https://bugs.gentoo.org/enter_bug.cgi?product=Documentation&component=Policy+Guide">Policy Manual
Gentoo Bugzilla component</a> as git-format patches attached to the bugs,
or to <a class="reference external" href="https://github.com/gentoo/policy-guide">gentoo/policy-guide repository</a> as pull requests.</p>
</section>
<section id="merging-pull-requests">
<h2>Merging pull requests<a class="headerlink" href="#merging-pull-requests" title="Link to this heading">¶</a></h2>
<p>The recommended way to merge pull requests is to use
<code class="docutils literal notranslate"><span class="pre">app-portage/pram</span></code>. To configure the remote before the first use,
run the following command in your checkout:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">config</span> <span class="o">--</span><span class="n">replace</span><span class="o">-</span><span class="nb">all</span> <span class="n">pram</span><span class="o">.</span><span class="n">repo</span> <span class="n">gentoo</span><span class="o">/</span><span class="n">policy</span><span class="o">-</span><span class="n">guide</span>
</pre></div>
</div>
<p>Afterwards, call the tool to merge pull request by number:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pram</span> <span class="n">N</span>
</pre></div>
</div>
</section>
<section id="publishing">
<h2>Publishing<a class="headerlink" href="#publishing" title="Link to this heading">¶</a></h2>
<p>The built version of Policy Guide is currently published via a git
repository. The recommended method is to clone the repository
into <code class="docutils literal notranslate"><span class="pre">_build/html</span></code> in order to make Sphinx output into the checkout:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rm</span> <span class="o">-</span><span class="n">r</span> <span class="n">_build</span><span class="o">/</span><span class="n">html</span>
<span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="nd">@git</span><span class="o">.</span><span class="n">gentoo</span><span class="o">.</span><span class="n">org</span><span class="p">:</span><span class="n">sites</span><span class="o">/</span><span class="n">projects</span><span class="o">/</span><span class="n">qa</span><span class="o">/</span><span class="n">policy</span><span class="o">-</span><span class="n">guide</span><span class="o">.</span><span class="n">git</span> \
<span class="n">_build</span><span class="o">/</span><span class="n">html</span>
</pre></div>
</div>
<p>Commit and push all the changes after rebuilding the Guide.</p>
</section>
</section>
<div class="row" style="margin-top:50px;">
<div class="col-sm-6">
<a href="other-docs.html" style="color:#767676;">
<i class="fa fa-angle-double-left" aria-hidden="true"></i>
Other policy documents
</a>
</div>
<div class="col-sm-6">
<a href="dependencies.html" class="pull-right" style="color:#767676;">
Dependencies
<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 current"><a class="current reference internal" href="#">Editing and publishing updates to this Guide</a><ul class='nav'>
<li class="toctree-l2"><a class="reference internal" href="#formatting-and-style">Formatting and style</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getting-sources">Getting sources</a></li>
<li class="toctree-l2"><a class="reference internal" href="#building">Building</a></li>
<li class="toctree-l2"><a class="reference internal" href="#sending-contributions">Sending contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#merging-pull-requests">Merging pull requests</a></li>
<li class="toctree-l2"><a class="reference internal" href="#publishing">Publishing</a></li>
</ul>
</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"><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 7.2.6</a> & <a href="https://github.com/mmagorsc/tyrian_sphinx_theme">Tyrian Theme 0.0.8</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="text-center">
<a href="https://wiki.gentoo.org/wiki/Foundation:Privacy_Policy">Privacy Policy</a>
</div>
<div class="col-xs-10 col-sm-9 col-md-10">
<strong>© 2001–2024 Gentoo Authors</strong><br>
<small>
Gentoo is a trademark of the Gentoo Foundation, Inc. and of Förderverein Gentoo e.V.
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