/[gentoo]/xml/htdocs/proj/en/glep/glep-0001.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0001.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.4 Revision 1.10
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.2.8: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 1 -- GLEP Purpose and Guidelines</title> 12 <title>GLEP 1 -- GLEP Purpose and Guidelines</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <style type="text/css">
14
15/*
16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2007/01/25 03:27:08 $
19:version: $Revision: 1.10 $
20:copyright: This stylesheet has been placed in the public domain.
21
22Default cascading style sheet for the PEP HTML output of Docutils.
23*/
24
25.first {
26 margin-top: 0 }
27
28.last {
29 margin-bottom: 0 }
30
31.navigation {
32 width: 100% ;
33 background: #cc99ff ;
34 margin-top: 0px ;
35 margin-bottom: 0px }
36
37.navigation .navicon {
38 width: 150px ;
39 height: 35px }
40
41.navigation .textlinks {
42 padding-left: 1em ;
43 text-align: left }
44
45.navigation td, .navigation th {
46 padding-left: 0em ;
47 padding-right: 0em ;
48 vertical-align: middle }
49
50.rfc2822 {
51 margin-top: 0.5em ;
52 margin-left: 0.5em ;
53 margin-right: 0.5em ;
54 margin-bottom: 0em }
55
56.rfc2822 td {
57 text-align: left }
58
59.rfc2822 th.field-name {
60 text-align: right ;
61 font-family: sans-serif ;
62 padding-right: 0.5em ;
63 font-weight: bold ;
64 margin-bottom: 0em }
65
66a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75dd {
76 margin-bottom: 0.5em }
77
78div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88div.abstract {
89 margin: 2em 5em }
90
91div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95div.attention, div.caution, div.danger, div.error, div.hint,
96div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101div.attention p.admonition-title, div.caution p.admonition-title,
102div.danger p.admonition-title, div.error p.admonition-title,
103div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108div.hint p.admonition-title, div.important p.admonition-title,
109div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113div.figure {
114 margin-left: 2em }
115
116div.footer, div.header {
117 font-size: smaller }
118
119div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123div.system-messages {
124 margin: 5em }
125
126div.system-messages h1 {
127 color: red }
128
129div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137div.topic {
138 margin: 2em }
139
140h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166.section hr {
167 width: 75% }
168
169ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172ol.arabic {
173 list-style: decimal }
174
175ol.loweralpha {
176 list-style: lower-alpha }
177
178ol.upperalpha {
179 list-style: upper-alpha }
180
181ol.lowerroman {
182 list-style: lower-roman }
183
184ol.upperroman {
185 list-style: upper-roman }
186
187p.caption {
188 font-style: italic }
189
190p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194p.label {
195 white-space: nowrap }
196
197p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218span.interpreted {
219 font-family: sans-serif }
220
221span.option-argument {
222 font-style: italic }
223
224span.pre {
225 white-space: pre }
226
227span.problematic {
228 color: red }
229
230table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239td.num {
240 text-align: right }
241
242th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250tt {
251 background-color: #eeeeee }
252
253ul.auto-toc {
254 list-style-type: none }
255
256</style>
14</head> 257</head>
15<body bgcolor="white"> 258<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 259<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 260 width="100%" border="0">
18<tr><td class="navicon" width="150" height="35"> 261<tr><td class="navicon" width="150" height="35">
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 262<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 263<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 264 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 265<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 266[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] 267[<b><a href="http://www.gentoo.org/proj/en/glep/">GLEP Index</a></b>]
25[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0001.txt">GLEP Source</a></b>] 268[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0001.txt">GLEP Source</a></b>]
26</td></tr></table> 269</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 270<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 271<col class="field-name" />
30<col class="field-body" /> 272<col class="field-body" />
31<tbody valign="top"> 273<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td>
33</tr> 275</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td>
35</tr> 277</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.8</td>
37</tr> 279</tr>
38<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/glep-0001.txt">2003/06/10 17:33:02</a></td> 280<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0001.txt?cvsroot=gentoo">2004/04/04 23:05:35</a></td>
39</tr> 281</tr>
40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear &lt;g2boojum&#32;&#97;t&#32;gentoo.org&gt;</td> 282<tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear &lt;g2boojum&#32;&#97;t&#32;gentoo.org&gt;</td>
41</tr> 283</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 284<tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
43</tr> 285</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td> 286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
45</tr> 287</tr>
46<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> 288<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
47</tr> 289</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Jun-2003, 2-Jul-2003</td> 292<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Jun-2003, 2-Jul-2003</td>
51</tr> 293</tr>
52</tbody> 294</tbody>
53</table> 295</table>
54<hr /> 296<hr />
55<div class="contents topic" id="contents"> 297<div class="contents topic">
56<p class="topic-title"><a name="contents">Contents</a></p> 298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
57<ul class="simple"> 299<ul class="simple">
58<li><a class="reference" href="#credits" id="id17" name="id17">Credits</a></li> 300<li><a class="reference" href="#credits" id="id17" name="id17">Credits</a></li>
59<li><a class="reference" href="#what-is-a-glep" id="id18" name="id18">What is a GLEP?</a></li> 301<li><a class="reference" href="#what-is-a-glep" id="id18" name="id18">What is a GLEP?</a></li>
60<li><a class="reference" href="#kinds-of-gleps" id="id19" name="id19">Kinds of GLEPs</a></li> 302<li><a class="reference" href="#kinds-of-gleps" id="id19" name="id19">Kinds of GLEPs</a></li>
61<li><a class="reference" href="#glep-work-flow" id="id20" name="id20">GLEP Work Flow</a></li> 303<li><a class="reference" href="#glep-work-flow" id="id20" name="id20">GLEP Work Flow</a></li>
66<li><a class="reference" href="#transferring-glep-ownership" id="id25" name="id25">Transferring GLEP Ownership</a></li> 308<li><a class="reference" href="#transferring-glep-ownership" id="id25" name="id25">Transferring GLEP Ownership</a></li>
67<li><a class="reference" href="#references-and-footnotes" id="id26" name="id26">References and Footnotes</a></li> 309<li><a class="reference" href="#references-and-footnotes" id="id26" name="id26">References and Footnotes</a></li>
68<li><a class="reference" href="#copyright" id="id27" name="id27">Copyright</a></li> 310<li><a class="reference" href="#copyright" id="id27" name="id27">Copyright</a></li>
69</ul> 311</ul>
70</div> 312</div>
71<div class="section" id="credits"> 313<div class="section">
72<h1><a class="toc-backref" href="#id17" name="credits">Credits</a></h1> 314<h1><a class="toc-backref" href="#id17" id="credits" name="credits">Credits</a></h1>
73<p>The GLEP concept, and, in fact, much of the text of this document, 315<p>The GLEP concept, and, in fact, much of the text of this document,
74is liberally stolen from Python's <a class="footnote-reference" href="#python" id="id1" name="id1">[1]</a> PEPs 316is liberally stolen from Python's <a class="footnote-reference" href="#python" id="id1" name="id1">[1]</a> PEPs
75<a class="footnote-reference" href="#peps" id="id2" name="id2">[2]</a>, especially 317<a class="footnote-reference" href="#peps" id="id2" name="id2">[2]</a>, especially
76PEP-0001 <a class="footnote-reference" href="#pep1" id="id3" name="id3">[3]</a> by Barry A. Warsaw, Jeremy Hylton, and David Goodger.</p> 318PEP-0001 <a class="footnote-reference" href="#pep1" id="id3" name="id3">[3]</a> by Barry A. Warsaw, Jeremy Hylton, and David Goodger.</p>
77</div> 319</div>
78<div class="section" id="what-is-a-glep"> 320<div class="section">
79<h1><a class="toc-backref" href="#id18" name="what-is-a-glep">What is a GLEP?</a></h1> 321<h1><a class="toc-backref" href="#id18" id="what-is-a-glep" name="what-is-a-glep">What is a GLEP?</a></h1>
80<p>GLEP stands for &quot;Gentoo Linux Enhancement Proposal&quot;. A GLEP is a design 322<p>GLEP stands for &quot;Gentoo Linux Enhancement Proposal&quot;. A GLEP is a design
81document providing information to the Gentoo Linux community, or describing 323document providing information to the Gentoo Linux community, or describing
82a new feature for Gentoo Linux. The GLEP should provide a concise technical 324a new feature for Gentoo Linux. The GLEP should provide a concise technical
83specification of the feature and rationale for the feature.</p> 325specification of the feature and rationale for the feature.</p>
84<p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new 326<p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new
88documenting dissenting opinions.</p> 330documenting dissenting opinions.</p>
89<p>Because the GLEPs are maintained as text files under CVS control, their 331<p>Because the GLEPs are maintained as text files under CVS control, their
90revision history is the historical record of the feature proposal 332revision history is the historical record of the feature proposal
91<a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p> 333<a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p>
92</div> 334</div>
93<div class="section" id="kinds-of-gleps"> 335<div class="section">
94<h1><a class="toc-backref" href="#id19" name="kinds-of-gleps">Kinds of GLEPs</a></h1> 336<h1><a class="toc-backref" href="#id19" id="kinds-of-gleps" name="kinds-of-gleps">Kinds of GLEPs</a></h1>
95<p>There are two kinds of GLEPs. A Standards Track GLEP describes a new feature 337<p>There are two kinds of GLEPs. A Standards Track GLEP describes a new feature
96or implementation for Gentoo Linux. An Informational GLEP describes provides 338or implementation for Gentoo Linux. An Informational GLEP describes provides
97general guidelines or information to the Gentoo Linux community, but does not 339general guidelines or information to the Gentoo Linux community, but does not
98propose a new feature. Informational GLEPs do not necessarily represent a 340propose a new feature. Informational GLEPs do not necessarily represent a
99Gentoo Linux community consensus or recommendation, so users and implementors 341Gentoo Linux community consensus or recommendation, so users and implementors
100are free to ignore Informational GLEPs or follow their advice.</p> 342are free to ignore Informational GLEPs or follow their advice.</p>
101</div> 343</div>
102<div class="section" id="glep-work-flow"> 344<div class="section">
103<h1><a class="toc-backref" href="#id20" name="glep-work-flow">GLEP Work Flow</a></h1> 345<h1><a class="toc-backref" href="#id20" id="glep-work-flow" name="glep-work-flow">GLEP Work Flow</a></h1>
104<p>The GLEP editors assign GLEP numbers and change their status. The current 346<p>The GLEP editors assign GLEP numbers and change their status. The current
105GLEP editors are Grant Goodyear and Alastair Tse. Please send all 347GLEP editors are Grant Goodyear and Alastair Tse. Please send all
106GLEP-related email to &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;.</p> 348GLEP-related email to &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;.</p>
107<p>The GLEP process begins with a new idea for Gentoo Linux. It is highly 349<p>The GLEP process begins with a new idea for Gentoo Linux. It is highly
108recommended that a single GLEP contain a single key proposal or new idea. The 350recommended that a single GLEP contain a single key proposal or new idea. The
117injected into the Gentoo Linux development work flow with an enhancement &quot;bug&quot; 359injected into the Gentoo Linux development work flow with an enhancement &quot;bug&quot;
118submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5" name="id5">[6]</a>.</p> 360submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5" name="id5">[6]</a>.</p>
119<p>The GLEP champion then emails the GLEP editors &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt; with a 361<p>The GLEP champion then emails the GLEP editors &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt; with a
120proposed title and a rough, but fleshed out, draft of the GLEP. This draft 362proposed title and a rough, but fleshed out, draft of the GLEP. This draft
121must be written in GLEP style as described below.</p> 363must be written in GLEP style as described below.</p>
122<p>If the GLEP editor approves, he will assign the GLEP a number, label it 364<p>If the GLEP editor accepts the GLEP, he will assign the GLEP a number, label
123as Standards Track (a better name would be nice here -- suggestions?) 365it as Standards Track (a better name would be nice here -- suggestions?) or
124or Informational, give it status &quot;Draft&quot;, and 366Informational, give it status &quot;Draft&quot;, and create and check-in the initial
125create and check-in the initial draft of the GLEP. The GLEP editors will 367draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP.
126not unreasonably deny a GLEP. Reasons for denying GLEP status include 368Reasons for denying GLEP status include duplication of effort, being
127duplication of effort, being technically unsound, not providing proper 369technically unsound, not providing proper motivation or addressing backwards
128motivation or addressing backwards compatibility, or not in keeping 370compatibility, or not in keeping with Gentoo Linux philosophy.</p>
129with Gentoo Linux philosophy.</p>
130<p>If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the 371<p>If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the
131<a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a> mailing list to help flesh it out, gain feedback and 372<a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a> mailing list to help flesh it out, gain feedback and
132consensus from the community at large, and improve the GLEP for re-submission.</p> 373consensus from the community at large, and improve the GLEP for re-submission.</p>
133<p>The author of the GLEP is then responsible for posting the GLEP to the 374<p>The author of the GLEP is then responsible for posting the GLEP to the
134gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and 375gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and
148include setting up a specific forums thread for the topic, having the GLEP 389include setting up a specific forums thread for the topic, having the GLEP
149author accept private comments in the early design phases, etc. GLEP authors 390author accept private comments in the early design phases, etc. GLEP authors
150should use their discretion here.</p> 391should use their discretion here.</p>
151<p>Once the authors have completed a GLEP, they must inform the GLEP editors that 392<p>Once the authors have completed a GLEP, they must inform the GLEP editors that
152it is ready for review. GLEPs are reviewed by the appropriate Gentoo 393it is ready for review. GLEPs are reviewed by the appropriate Gentoo
153Manager <a class="footnote-reference" href="#manager" id="id8" name="id8">[8]</a>, who may accept or reject a GLEP outright, or 394Manager <a class="footnote-reference" href="#manager" id="id8" name="id8">[8]</a>, who may approve or reject a GLEP outright, or
154send it back to the author(s) for revision. For a GLEP that is pre-determined 395send it back to the author(s) for revision. For a GLEP that is pre-determined
155to be acceptable (e.g., it is an obvious win as-is and/or its implementation 396to be approvable (e.g., it is an obvious win as-is and/or its implementation
156has already been checked in) the appropriate Gentoo Manager <a class="footnote-reference" href="#manager" id="id9" name="id9">[8]</a> 397has already been checked in) the appropriate Gentoo Manager <a class="footnote-reference" href="#manager" id="id9" name="id9">[8]</a>
157may also initiate a GLEP review, first notifying the GLEP author(s) and giving 398may also initiate a GLEP review, first notifying the GLEP author(s) and giving
158them a chance to make revisions.</p> 399them a chance to make revisions.</p>
159<p>For a GLEP to be accepted it must meet certain minimum criteria. It must be a 400<p>For a GLEP to be approved it must meet certain minimum criteria. It must be a
160clear and complete description of the proposed enhancement. The enhancement 401clear and complete description of the proposed enhancement. The enhancement
161must represent a net improvement. The proposed implementation, if applicable, 402must represent a net improvement. The proposed implementation, if applicable,
162must be solid and must not complicate the distribution unduly. Finally, a 403must be solid and must not complicate the distribution unduly. Finally, a
163proposed enhancement must satisfy the philosophy of Gentoo Linux.</p> 404proposed enhancement must satisfy the philosophy of Gentoo Linux.</p>
164<p>Once a GLEP has been accepted, the reference implementation must be completed. 405<p>Once a GLEP has been accepted, the reference implementation must be completed.
180Deferred 421Deferred
181</pre> 422</pre>
182<p>Some Informational GLEPs may also have a status of &quot;Active&quot; if they are never 423<p>Some Informational GLEPs may also have a status of &quot;Active&quot; if they are never
183meant to be completed. E.g. GLEP 1 (this GLEP).</p> 424meant to be completed. E.g. GLEP 1 (this GLEP).</p>
184</div> 425</div>
185<div class="section" id="what-belongs-in-a-successful-glep"> 426<div class="section">
186<h1><a class="toc-backref" href="#id21" name="what-belongs-in-a-successful-glep">What belongs in a successful GLEP?</a></h1> 427<h1><a class="toc-backref" href="#id21" id="what-belongs-in-a-successful-glep" name="what-belongs-in-a-successful-glep">What belongs in a successful GLEP?</a></h1>
187<p>Each GLEP should have the following parts:</p> 428<p>Each GLEP should have the following parts:</p>
188<ol class="arabic"> 429<ol class="arabic">
189<li><p class="first">Preamble -- <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style headers containing meta-data about the 430<li><p class="first">Preamble -- <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style headers containing meta-data about the
190GLEP, including the GLEP number, a short descriptive title (limited 431GLEP, including the GLEP number, a short descriptive title (limited
191to a maximum of 44 characters), the names, and optionally the 432to a maximum of 44 characters), the names, and optionally the
210were made. It should describe alternate designs that were considered and 451were made. It should describe alternate designs that were considered and
211related work, e.g. how the feature is supported in other distributions.</p> 452related work, e.g. how the feature is supported in other distributions.</p>
212<p>The rationale should provide evidence of consensus within the community and 453<p>The rationale should provide evidence of consensus within the community and
213discuss important objections or concerns raised during discussion.</p> 454discuss important objections or concerns raised during discussion.</p>
214</li> 455</li>
215<li><p class="first">Backwards Compatibility -- All GLEPs 456<li><p class="first">Backwards Compatibility -- All GLEPs
216must include a section describing any issues of backwards incompatibilities 457must include a section describing any issues of backwards incompatibilities
217and their severity. The GLEP must explain how the author proposes to deal 458and their severity. The GLEP must explain how the author proposes to deal
218with these incompatibilities. (Even if there are none, this section should 459with these incompatibilities. (Even if there are none, this section should
219be included to clearly state that fact.) GLEP submissions without a 460be included to clearly state that fact.) GLEP submissions without a
220sufficient backwards compatibility treatise may be rejected outright.</p> 461sufficient backwards compatibility treatise may be rejected outright.</p>
229labelled as placed in the public domain (see this GLEP as an example) or 470labelled as placed in the public domain (see this GLEP as an example) or
230licensed under the Open Publication License [#OPL].</p> 471licensed under the Open Publication License [#OPL].</p>
231</li> 472</li>
232</ol> 473</ol>
233</div> 474</div>
234<div class="section" id="glep-formating-and-template"> 475<div class="section">
235<h1><a class="toc-backref" href="#id22" name="glep-formating-and-template">GLEP Formating and Template</a></h1> 476<h1><a class="toc-backref" href="#id22" id="glep-formating-and-template" name="glep-formating-and-template">GLEP Formating and Template</a></h1>
236<p>GLEPs are written either in Gentoo Linux Guide-XML <a class="footnote-reference" href="#guidexml" id="id10" name="id10">[11]</a> or in 477<p>GLEPs are written either in Gentoo Linux Guide-XML <a class="footnote-reference" href="#guidexml" id="id10" name="id10">[11]</a> or in
237a just-barely-marked-up version of plain ASCII text 478a just-barely-marked-up version of plain ASCII text
238called ReStructuredText <a class="footnote-reference" href="#resthome" id="id11" name="id11">[10]</a> that is then converted to HTML using 479called ReStructuredText <a class="footnote-reference" href="#resthome" id="id11" name="id11">[10]</a> that is then converted to HTML using
239Docutils <a class="footnote-reference" href="#docutils" id="id12" name="id12">[12]</a>. Using ReStructuredText GLEPs allows for rich markup 480Docutils <a class="footnote-reference" href="#docutils" id="id12" name="id12">[12]</a>. Using ReStructuredText GLEPs allows for rich markup
240that is still quite easy to read, but results in much better-looking and more 481that is still quite easy to read, but results in much better-looking and more
241functional HTML. Moreover, it should be straightforward to convert GLEPs to 482functional HTML. Moreover, it should be straightforward to convert GLEPs to
242Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id13" name="id13">[11]</a> if needed. GLEP 2 contains a boilerplate 483Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id13" name="id13">[11]</a> if needed. GLEP 2 contains a boilerplate
243template <a class="footnote-reference" href="#rest" id="id14" name="id14">[5]</a> for use with ReStructuredText GLEPs.</p> 484template <a class="footnote-reference" href="#rest" id="id14" name="id14">[5]</a> for use with ReStructuredText GLEPs.</p>
244</div> 485</div>
245<div class="section" id="glep-header-preamble"> 486<div class="section">
246<h1><a class="toc-backref" href="#id23" name="glep-header-preamble">GLEP Header Preamble</a></h1> 487<h1><a class="toc-backref" href="#id23" id="glep-header-preamble" name="glep-header-preamble">GLEP Header Preamble</a></h1>
247<p>Each GLEP must begin with an <a class="reference" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> style header preamble. The headers 488<p>Each GLEP must begin with an <a class="reference" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> style header preamble. The headers
248must appear in the following order. Headers marked with &quot;*&quot; are 489must appear in the following order. Headers marked with &quot;*&quot; are
249optional and are described below. All other headers are required.</p> 490optional and are described below. All other headers are required.</p>
250<pre class="literal-block"> 491<pre class="literal-block">
251 GLEP: &lt;glep number&gt; 492 GLEP: &lt;glep number&gt;
283GLEP is being discussed privately with the author, or on the gentoo-dev 524GLEP is being discussed privately with the author, or on the gentoo-dev
284mailing list. Note that email addresses in the Discussions-To header will not 525mailing list. Note that email addresses in the Discussions-To header will not
285be obscured.</p> 526be obscured.</p>
286<p>The Type header specifies the type of GLEP: Informational or Standards 527<p>The Type header specifies the type of GLEP: Informational or Standards
287Track.</p> 528Track.</p>
288<p>The format of a GLEP is specified with a Content-Type header, which 529<p>The format of a GLEP is specified with a Content-Type header, which
289should read &quot;text/xml&quot; for Gentoo Guide XML or 530should read &quot;text/xml&quot; for Gentoo Guide XML or
290&quot;text/x-rst&quot; for ReStructuredText GLEPs (see GLEP 2 531&quot;text/x-rst&quot; for ReStructuredText GLEPs (see GLEP 2
291<a class="footnote-reference" href="#rest" id="id15" name="id15">[5]</a>).</p> 532<a class="footnote-reference" href="#rest" id="id15" name="id15">[5]</a>).</p>
292<p>The Created header records the date that the GLEP was assigned a number, while 533<p>The Created header records the date that the GLEP was assigned a number, while
293Post-History is used to record the dates of when new versions of the GLEP are 534Post-History is used to record the dates of when new versions of the GLEP are
294posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. 535posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g.
298<p>GLEPs may also have a Replaced-By header indicating that a GLEP has been 539<p>GLEPs may also have a Replaced-By header indicating that a GLEP has been
299rendered obsolete by a later document; the value is the number of the GLEP 540rendered obsolete by a later document; the value is the number of the GLEP
300that replaces the current document. The newer GLEP must have a Replaces 541that replaces the current document. The newer GLEP must have a Replaces
301header containing the number of the GLEP that it rendered obsolete.</p> 542header containing the number of the GLEP that it rendered obsolete.</p>
302</div> 543</div>
303<div class="section" id="reporting-glep-bugs-or-submitting-glep-updates"> 544<div class="section">
304<h1><a class="toc-backref" href="#id24" name="reporting-glep-bugs-or-submitting-glep-updates">Reporting GLEP Bugs, or Submitting GLEP Updates</a></h1> 545<h1><a class="toc-backref" href="#id24" id="reporting-glep-bugs-or-submitting-glep-updates" name="reporting-glep-bugs-or-submitting-glep-updates">Reporting GLEP Bugs, or Submitting GLEP Updates</a></h1>
305<p>How you report a bug, or submit a GLEP update depends on several factors, such 546<p>How you report a bug, or submit a GLEP update depends on several factors, such
306as the maturity of the GLEP, the preferences of the GLEP author, and the 547as the maturity of the GLEP, the preferences of the GLEP author, and the
307nature of your comments. For the early draft stages of the GLEP, it's 548nature of your comments. For the early draft stages of the GLEP, it's
308probably best to send your comments and changes directly to the GLEP author. 549probably best to send your comments and changes directly to the GLEP author.
309For more mature, or finished GLEPs you may want to submit corrections to the 550For more mature, or finished GLEPs you may want to submit corrections to the
313<p>When in doubt about where to send your changes, please check first with the 554<p>When in doubt about where to send your changes, please check first with the
314GLEP author and/or GLEP editors.</p> 555GLEP author and/or GLEP editors.</p>
315<p>GLEP authors who are also Gentoo Linux developers can update the GLEPs 556<p>GLEP authors who are also Gentoo Linux developers can update the GLEPs
316themselves by using &quot;cvs commit&quot; to commit their changes.</p> 557themselves by using &quot;cvs commit&quot; to commit their changes.</p>
317</div> 558</div>
318<div class="section" id="transferring-glep-ownership"> 559<div class="section">
319<h1><a class="toc-backref" href="#id25" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1> 560<h1><a class="toc-backref" href="#id25" id="transferring-glep-ownership" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1>
320<p>It occasionally becomes necessary to transfer ownership of GLEPs to a new 561<p>It occasionally becomes necessary to transfer ownership of GLEPs to a new
321champion. In general, we'd like to retain the original author as a co-author 562champion. In general, we'd like to retain the original author as a co-author
322of the transferred GLEP, but that's really up to the original author. A good 563of the transferred GLEP, but that's really up to the original author. A good
323reason to transfer ownership is because the original author no longer has the 564reason to transfer ownership is because the original author no longer has the
324time or interest in updating it or following through with the GLEP process, or 565time or interest in updating it or following through with the GLEP process, or
330to take over, addressed to both the original author and the GLEP editors 571to take over, addressed to both the original author and the GLEP editors
331&lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;. If the original author doesn't respond to email in a 572&lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;. If the original author doesn't respond to email in a
332timely manner, the GLEP editors will make a unilateral decision (it's not like 573timely manner, the GLEP editors will make a unilateral decision (it's not like
333such decisions can't be reversed :).</p> 574such decisions can't be reversed :).</p>
334</div> 575</div>
335<div class="section" id="references-and-footnotes"> 576<div class="section">
336<h1><a class="toc-backref" href="#id26" name="references-and-footnotes">References and Footnotes</a></h1> 577<h1><a class="toc-backref" href="#id26" id="references-and-footnotes" name="references-and-footnotes">References and Footnotes</a></h1>
337<table class="footnote" frame="void" id="python" rules="none"> 578<table class="docutils footnote" frame="void" id="python" rules="none">
338<colgroup><col class="label" /><col /></colgroup> 579<colgroup><col class="label" /><col /></colgroup>
339<tbody valign="top"> 580<tbody valign="top">
340<tr><td class="label"><a class="fn-backref" href="#id1" name="python">[1]</a></td><td><a class="reference" href="http://www.python.org">http://www.python.org</a></td></tr> 581<tr><td class="label"><a class="fn-backref" href="#id1" name="python">[1]</a></td><td><a class="reference" href="http://www.python.org">http://www.python.org</a></td></tr>
341</tbody> 582</tbody>
342</table> 583</table>
343<table class="footnote" frame="void" id="peps" rules="none"> 584<table class="docutils footnote" frame="void" id="peps" rules="none">
344<colgroup><col class="label" /><col /></colgroup> 585<colgroup><col class="label" /><col /></colgroup>
345<tbody valign="top"> 586<tbody valign="top">
346<tr><td class="label"><a class="fn-backref" href="#id2" name="peps">[2]</a></td><td><a class="reference" href="http://www.python.org/peps">http://www.python.org/peps</a></td></tr> 587<tr><td class="label"><a class="fn-backref" href="#id2" name="peps">[2]</a></td><td><a class="reference" href="http://www.python.org/peps">http://www.python.org/peps</a></td></tr>
347</tbody> 588</tbody>
348</table> 589</table>
349<table class="footnote" frame="void" id="pep1" rules="none"> 590<table class="docutils footnote" frame="void" id="pep1" rules="none">
350<colgroup><col class="label" /><col /></colgroup> 591<colgroup><col class="label" /><col /></colgroup>
351<tbody valign="top"> 592<tbody valign="top">
352<tr><td class="label"><a class="fn-backref" href="#id3" name="pep1">[3]</a></td><td><a class="reference" href="http://www.python.org/peps/pep-0001.html">http://www.python.org/peps/pep-0001.html</a></td></tr> 593<tr><td class="label"><a class="fn-backref" href="#id3" name="pep1">[3]</a></td><td><a class="reference" href="http://www.python.org/peps/pep-0001.html">http://www.python.org/peps/pep-0001.html</a></td></tr>
353</tbody> 594</tbody>
354</table> 595</table>
355<table class="footnote" frame="void" id="cvs" rules="none"> 596<table class="docutils footnote" frame="void" id="cvs" rules="none">
356<colgroup><col class="label" /><col /></colgroup> 597<colgroup><col class="label" /><col /></colgroup>
357<tbody valign="top"> 598<tbody valign="top">
358<tr><td class="label"><a class="fn-backref" href="#id4" name="cvs">[4]</a></td><td>This historical record is available by the normal CVS commands 599<tr><td class="label"><a class="fn-backref" href="#id4" name="cvs">[4]</a></td><td>This historical record is available by the normal CVS commands
359for retrieving older revisions. For those without direct access to the CVS 600for retrieving older revisions. For those without direct access to the CVS
360tree, you can browse the current and past GLEP revisions via the Gentoo 601tree, you can browse the current and past GLEP revisions via the Gentoo
361Linux viewcvs web site at 602Linux viewcvs web site at
362<a class="reference" href="http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/">http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/</a></td></tr> 603<a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/">http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/</a></td></tr>
363</tbody> 604</tbody>
364</table> 605</table>
365<table class="footnote" frame="void" id="rest" rules="none"> 606<table class="docutils footnote" frame="void" id="rest" rules="none">
366<colgroup><col class="label" /><col /></colgroup> 607<colgroup><col class="label" /><col /></colgroup>
367<tbody valign="top"> 608<tbody valign="top">
368<tr><td class="label"><a name="rest">[5]</a></td><td><em>(<a class="fn-backref" href="#id14">1</a>, <a class="fn-backref" href="#id15">2</a>)</em> GLEP 2, Sample ReStructuredText GLEP Template, 609<tr><td class="label"><a name="rest">[5]</a></td><td><em>(<a class="fn-backref" href="#id14">1</a>, <a class="fn-backref" href="#id15">2</a>)</em> GLEP 2, Sample ReStructuredText GLEP Template,
369(<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr> 610(<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr>
370</tbody> 611</tbody>
371</table> 612</table>
372<table class="footnote" frame="void" id="bugs" rules="none"> 613<table class="docutils footnote" frame="void" id="bugs" rules="none">
373<colgroup><col class="label" /><col /></colgroup> 614<colgroup><col class="label" /><col /></colgroup>
374<tbody valign="top"> 615<tbody valign="top">
375<tr><td class="label"><a name="bugs">[6]</a></td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id16">2</a>)</em> <a class="reference" href="http://bugs.gentoo.org">http://bugs.gentoo.org</a></td></tr> 616<tr><td class="label"><a name="bugs">[6]</a></td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id16">2</a>)</em> <a class="reference" href="http://bugs.gentoo.org">http://bugs.gentoo.org</a></td></tr>
376</tbody> 617</tbody>
377</table> 618</table>
378<table class="footnote" frame="void" id="forums" rules="none"> 619<table class="docutils footnote" frame="void" id="forums" rules="none">
379<colgroup><col class="label" /><col /></colgroup> 620<colgroup><col class="label" /><col /></colgroup>
380<tbody valign="top"> 621<tbody valign="top">
381<tr><td class="label"><a name="forums">[7]</a></td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference" href="http://forums.gentoo.org">http://forums.gentoo.org</a></td></tr> 622<tr><td class="label"><a name="forums">[7]</a></td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference" href="http://forums.gentoo.org">http://forums.gentoo.org</a></td></tr>
382</tbody> 623</tbody>
383</table> 624</table>
384<table class="footnote" frame="void" id="manager" rules="none"> 625<table class="docutils footnote" frame="void" id="manager" rules="none">
385<colgroup><col class="label" /><col /></colgroup> 626<colgroup><col class="label" /><col /></colgroup>
386<tbody valign="top"> 627<tbody valign="top">
387<tr><td class="label"><a name="manager">[8]</a></td><td><em>(<a class="fn-backref" href="#id8">1</a>, <a class="fn-backref" href="#id9">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/management-structure.xml">http://www.gentoo.org/doc/en/management-structure.xml</a></td></tr> 628<tr><td class="label"><a name="manager">[8]</a></td><td><em>(<a class="fn-backref" href="#id8">1</a>, <a class="fn-backref" href="#id9">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/management-structure.xml">http://www.gentoo.org/doc/en/management-structure.xml</a></td></tr>
388</tbody> 629</tbody>
389</table> 630</table>
390<table class="footnote" frame="void" id="opl" rules="none"> 631<table class="docutils footnote" frame="void" id="opl" rules="none">
391<colgroup><col class="label" /><col /></colgroup> 632<colgroup><col class="label" /><col /></colgroup>
392<tbody valign="top"> 633<tbody valign="top">
393<tr><td class="label"><a name="opl">[9]</a></td><td><a class="reference" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr> 634<tr><td class="label"><a name="opl">[9]</a></td><td><a class="reference" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr>
394</tbody> 635</tbody>
395</table> 636</table>
396<table class="footnote" frame="void" id="resthome" rules="none"> 637<table class="docutils footnote" frame="void" id="resthome" rules="none">
397<colgroup><col class="label" /><col /></colgroup> 638<colgroup><col class="label" /><col /></colgroup>
398<tbody valign="top"> 639<tbody valign="top">
399<tr><td class="label"><a class="fn-backref" href="#id11" name="resthome">[10]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr> 640<tr><td class="label"><a class="fn-backref" href="#id11" name="resthome">[10]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr>
400</tbody> 641</tbody>
401</table> 642</table>
402<table class="footnote" frame="void" id="guidexml" rules="none"> 643<table class="docutils footnote" frame="void" id="guidexml" rules="none">
403<colgroup><col class="label" /><col /></colgroup> 644<colgroup><col class="label" /><col /></colgroup>
404<tbody valign="top"> 645<tbody valign="top">
405<tr><td class="label"><a name="guidexml">[11]</a></td><td><em>(<a class="fn-backref" href="#id10">1</a>, <a class="fn-backref" href="#id13">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr> 646<tr><td class="label"><a name="guidexml">[11]</a></td><td><em>(<a class="fn-backref" href="#id10">1</a>, <a class="fn-backref" href="#id13">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr>
406</tbody> 647</tbody>
407</table> 648</table>
408<table class="footnote" frame="void" id="docutils" rules="none"> 649<table class="docutils footnote" frame="void" id="docutils" rules="none">
409<colgroup><col class="label" /><col /></colgroup> 650<colgroup><col class="label" /><col /></colgroup>
410<tbody valign="top"> 651<tbody valign="top">
411<tr><td class="label"><a class="fn-backref" href="#id12" name="docutils">[12]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr> 652<tr><td class="label"><a class="fn-backref" href="#id12" name="docutils">[12]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr>
412</tbody> 653</tbody>
413</table> 654</table>
414</div> 655</div>
415<div class="section" id="copyright"> 656<div class="section">
416<h1><a class="toc-backref" href="#id27" name="copyright">Copyright</a></h1> 657<h1><a class="toc-backref" href="#id27" id="copyright" name="copyright">Copyright</a></h1>
417<p>This document has been placed in the public domain.</p> 658<p>This document has been placed in the public domain.</p>
418</div> 659</div>
419</div>
420 660
421<hr class="footer"/> 661</div>
422<div class="footer"> 662<div class="footer">
663<hr class="footer" />
423<a class="reference" href="glep-0001.txt">View document source</a>. 664<a class="reference" href="glep-0001.txt">View document source</a>.
424Generated on: 2003-07-02 20:02 UTC. 665Generated on: 2006-10-10 20:23 UTC.
425Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 666Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
667
426</div> 668</div>
427</body> 669</body>
428</html> 670</html>
429 671

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.10

  ViewVC Help
Powered by ViewVC 1.1.20