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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.10 - (show annotations) (download) (as text)
Thu Jan 25 03:27:08 2007 UTC (7 years, 6 months ago) by antarus
Branch: MAIN
Changes since 1.9: +3 -3 lines
File MIME type: text/html
Fix headers in all current gleps

1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <!--
5 This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6 PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7 to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 1 -- GLEP Purpose and Guidelines</title>
13 <style type="text/css">
14
15 /*
16 :Author: David Goodger
17 :Contact: goodger@users.sourceforge.net
18 :date: $Date: 2006/10/10 20:25:14 $
19 :version: $Revision: 1.9 $
20 :copyright: This stylesheet has been placed in the public domain.
21
22 Default 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
66 a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70 body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75 dd {
76 margin-bottom: 0.5em }
77
78 div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83 div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88 div.abstract {
89 margin: 2em 5em }
90
91 div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95 div.attention, div.caution, div.danger, div.error, div.hint,
96 div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101 div.attention p.admonition-title, div.caution p.admonition-title,
102 div.danger p.admonition-title, div.error p.admonition-title,
103 div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108 div.hint p.admonition-title, div.important p.admonition-title,
109 div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113 div.figure {
114 margin-left: 2em }
115
116 div.footer, div.header {
117 font-size: smaller }
118
119 div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123 div.system-messages {
124 margin: 5em }
125
126 div.system-messages h1 {
127 color: red }
128
129 div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133 div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137 div.topic {
138 margin: 2em }
139
140 h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144 h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148 h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152 h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157 h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161 h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166 .section hr {
167 width: 75% }
168
169 ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172 ol.arabic {
173 list-style: decimal }
174
175 ol.loweralpha {
176 list-style: lower-alpha }
177
178 ol.upperalpha {
179 list-style: upper-alpha }
180
181 ol.lowerroman {
182 list-style: lower-roman }
183
184 ol.upperroman {
185 list-style: upper-roman }
186
187 p.caption {
188 font-style: italic }
189
190 p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194 p.label {
195 white-space: nowrap }
196
197 p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201 pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205 pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210 span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214 span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218 span.interpreted {
219 font-family: sans-serif }
220
221 span.option-argument {
222 font-style: italic }
223
224 span.pre {
225 white-space: pre }
226
227 span.problematic {
228 color: red }
229
230 table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234 td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239 td.num {
240 text-align: right }
241
242 th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247 h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250 tt {
251 background-color: #eeeeee }
252
253 ul.auto-toc {
254 list-style-type: none }
255
256 </style>
257 </head>
258 <body bgcolor="white">
259 <table class="navigation" cellpadding="0" cellspacing="0"
260 width="100%" border="0">
261 <tr><td class="navicon" width="150" height="35">
262 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
263 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
264 border="0" width="150" height="35" /></a></td>
265 <td class="textlinks" align="left">
266 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
267 [<b><a href="http://www.gentoo.org/proj/en/glep/">GLEP Index</a></b>]
268 [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0001.txt">GLEP Source</a></b>]
269 </td></tr></table>
270 <table class="rfc2822 docutils field-list" frame="void" rules="none">
271 <col class="field-name" />
272 <col class="field-body" />
273 <tbody valign="top">
274 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td>
275 </tr>
276 <tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td>
277 </tr>
278 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.8</td>
279 </tr>
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>
281 </tr>
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>
283 </tr>
284 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
285 </tr>
286 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
287 </tr>
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>
289 </tr>
290 <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-May-2003</td>
291 </tr>
292 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Jun-2003, 2-Jul-2003</td>
293 </tr>
294 </tbody>
295 </table>
296 <hr />
297 <div class="contents topic">
298 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
299 <ul class="simple">
300 <li><a class="reference" href="#credits" id="id17" name="id17">Credits</a></li>
301 <li><a class="reference" href="#what-is-a-glep" id="id18" name="id18">What is a GLEP?</a></li>
302 <li><a class="reference" href="#kinds-of-gleps" id="id19" name="id19">Kinds of GLEPs</a></li>
303 <li><a class="reference" href="#glep-work-flow" id="id20" name="id20">GLEP Work Flow</a></li>
304 <li><a class="reference" href="#what-belongs-in-a-successful-glep" id="id21" name="id21">What belongs in a successful GLEP?</a></li>
305 <li><a class="reference" href="#glep-formating-and-template" id="id22" name="id22">GLEP Formating and Template</a></li>
306 <li><a class="reference" href="#glep-header-preamble" id="id23" name="id23">GLEP Header Preamble</a></li>
307 <li><a class="reference" href="#reporting-glep-bugs-or-submitting-glep-updates" id="id24" name="id24">Reporting GLEP Bugs, or Submitting GLEP Updates</a></li>
308 <li><a class="reference" href="#transferring-glep-ownership" id="id25" name="id25">Transferring GLEP Ownership</a></li>
309 <li><a class="reference" href="#references-and-footnotes" id="id26" name="id26">References and Footnotes</a></li>
310 <li><a class="reference" href="#copyright" id="id27" name="id27">Copyright</a></li>
311 </ul>
312 </div>
313 <div class="section">
314 <h1><a class="toc-backref" href="#id17" id="credits" name="credits">Credits</a></h1>
315 <p>The GLEP concept, and, in fact, much of the text of this document,
316 is liberally stolen from Python's <a class="footnote-reference" href="#python" id="id1" name="id1">[1]</a> PEPs
317 <a class="footnote-reference" href="#peps" id="id2" name="id2">[2]</a>, especially
318 PEP-0001 <a class="footnote-reference" href="#pep1" id="id3" name="id3">[3]</a> by Barry A. Warsaw, Jeremy Hylton, and David Goodger.</p>
319 </div>
320 <div class="section">
321 <h1><a class="toc-backref" href="#id18" id="what-is-a-glep" name="what-is-a-glep">What is a GLEP?</a></h1>
322 <p>GLEP stands for &quot;Gentoo Linux Enhancement Proposal&quot;. A GLEP is a design
323 document providing information to the Gentoo Linux community, or describing
324 a new feature for Gentoo Linux. The GLEP should provide a concise technical
325 specification of the feature and rationale for the feature.</p>
326 <p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new
327 features, for collecting community input on an issue, and for
328 documenting the design decisions that have gone into Gentoo Linux. The GLEP
329 author is responsible for building consensus within the community and
330 documenting dissenting opinions.</p>
331 <p>Because the GLEPs are maintained as text files under CVS control, their
332 revision history is the historical record of the feature proposal
333 <a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p>
334 </div>
335 <div class="section">
336 <h1><a class="toc-backref" href="#id19" id="kinds-of-gleps" name="kinds-of-gleps">Kinds of GLEPs</a></h1>
337 <p>There are two kinds of GLEPs. A Standards Track GLEP describes a new feature
338 or implementation for Gentoo Linux. An Informational GLEP describes provides
339 general guidelines or information to the Gentoo Linux community, but does not
340 propose a new feature. Informational GLEPs do not necessarily represent a
341 Gentoo Linux community consensus or recommendation, so users and implementors
342 are free to ignore Informational GLEPs or follow their advice.</p>
343 </div>
344 <div class="section">
345 <h1><a class="toc-backref" href="#id20" id="glep-work-flow" name="glep-work-flow">GLEP Work Flow</a></h1>
346 <p>The GLEP editors assign GLEP numbers and change their status. The current
347 GLEP editors are Grant Goodyear and Alastair Tse. Please send all
348 GLEP-related email to &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;.</p>
349 <p>The GLEP process begins with a new idea for Gentoo Linux. It is highly
350 recommended that a single GLEP contain a single key proposal or new idea. The
351 more focussed the GLEP, the more successful it tends to be. The GLEP editors
352 reserve the right to reject GLEP proposals if they appear too unfocussed or
353 too broad. If in doubt, split your GLEP into several well-focussed ones.</p>
354 <p>Each GLEP must have a champion -- someone who writes the GLEP using the style
355 and format described below, shepherds the discussions in the appropriate
356 forums, and attempts to build community consensus around the idea. The GLEP
357 champion (a.k.a. Author) should first attempt to ascertain whether the idea is
358 GLEP-able. Small enhancements or patches often don't need a GLEP and can be
359 injected into the Gentoo Linux development work flow with an enhancement &quot;bug&quot;
360 submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5" name="id5">[6]</a>.</p>
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
362 proposed title and a rough, but fleshed out, draft of the GLEP. This draft
363 must be written in GLEP style as described below.</p>
364 <p>If the GLEP editor accepts the GLEP, he will assign the GLEP a number, label
365 it as Standards Track (a better name would be nice here -- suggestions?) or
366 Informational, give it status &quot;Draft&quot;, and create and check-in the initial
367 draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP.
368 Reasons for denying GLEP status include duplication of effort, being
369 technically unsound, not providing proper motivation or addressing backwards
370 compatibility, or not in keeping with Gentoo Linux philosophy.</p>
371 <p>If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the
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
373 consensus from the community at large, and improve the GLEP for re-submission.</p>
374 <p>The author of the GLEP is then responsible for posting the GLEP to the
375 gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and
376 marshaling community support for it. As updates are necessary, the GLEP
377 author can check in new versions if they have CVS commit permissions, or can
378 email new GLEP versions to the GLEP editors for committing.</p>
379 <p>Standards Track GLEPs consist of two parts, a design document and a reference
380 implementation. The GLEP should be reviewed and accepted before a reference
381 implementation is begun, unless a reference implementation will aid people in
382 studying the GLEP. Standards Track GLEPs must include an implementation -- in
383 the form of code, patch, or URL to same -- before it can be considered Final.</p>
384 <p>GLEP authors are responsible for collecting community feedback on a GLEP
385 before submitting it for review. A GLEP that has not been discussed on
386 <a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a> and/or the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id7" name="id7">[7]</a> will not be
387 accepted. However, wherever possible, long open-ended discussions on public
388 mailing lists should be avoided. Strategies to keep the discussions efficient
389 include setting up a specific forums thread for the topic, having the GLEP
390 author accept private comments in the early design phases, etc. GLEP authors
391 should use their discretion here.</p>
392 <p>Once the authors have completed a GLEP, they must inform the GLEP editors that
393 it is ready for review. GLEPs are reviewed by the appropriate Gentoo
394 Manager <a class="footnote-reference" href="#manager" id="id8" name="id8">[8]</a>, who may approve or reject a GLEP outright, or
395 send it back to the author(s) for revision. For a GLEP that is pre-determined
396 to be approvable (e.g., it is an obvious win as-is and/or its implementation
397 has already been checked in) the appropriate Gentoo Manager <a class="footnote-reference" href="#manager" id="id9" name="id9">[8]</a>
398 may also initiate a GLEP review, first notifying the GLEP author(s) and giving
399 them a chance to make revisions.</p>
400 <p>For a GLEP to be approved it must meet certain minimum criteria. It must be a
401 clear and complete description of the proposed enhancement. The enhancement
402 must represent a net improvement. The proposed implementation, if applicable,
403 must be solid and must not complicate the distribution unduly. Finally, a
404 proposed enhancement must satisfy the philosophy of Gentoo Linux.</p>
405 <p>Once a GLEP has been accepted, the reference implementation must be completed.
406 When the reference implementation is complete and accepted, the status will be
407 changed to &quot;Final&quot;.</p>
408 <p>A GLEP can also be assigned status &quot;Deferred&quot;. The GLEP author or editor can
409 assign the GLEP this status when no progress is being made on the GLEP. Once
410 a GLEP is deferred, the GLEP editor can re-assign it to draft status.</p>
411 <p>A GLEP can also be &quot;Rejected&quot;. Perhaps after all is said and done it was not
412 a good idea. It is still important to have a record of this fact.</p>
413 <p>GLEPs can also be replaced by a different GLEP, rendering the original
414 obsolete (where version 2 of a policy, for example, might replace version 1).</p>
415 <p>GLEP work flow is as follows:</p>
416 <pre class="literal-block">
417 Draft -&gt; Accepted -&gt; Final -&gt; Replaced
418 ^
419 +----&gt; Rejected
420 v
421 Deferred
422 </pre>
423 <p>Some Informational GLEPs may also have a status of &quot;Active&quot; if they are never
424 meant to be completed. E.g. GLEP 1 (this GLEP).</p>
425 </div>
426 <div class="section">
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>
428 <p>Each GLEP should have the following parts:</p>
429 <ol class="arabic">
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
431 GLEP, including the GLEP number, a short descriptive title (limited
432 to a maximum of 44 characters), the names, and optionally the
433 contact info for each author, etc.</p>
434 </li>
435 <li><p class="first">Abstract -- a short (~200 word) description of the technical issue
436 being addressed.</p>
437 </li>
438 <li><p class="first">Motivation -- The motivation is critical for GLEPs that want to
439 modify Gentoo Linux functionality. It should clearly explain why the
440 existing functionality or policy is inadequate to address the problem that
441 the GLEP solves. GLEP submissions without sufficient motivation may be
442 rejected outright.</p>
443 </li>
444 <li><p class="first">Specification -- The technical specification should describe the
445 specific areas of Gentoo Linux that would be touched by this GLEP. If new
446 functionality is being introduced, what packages will that functionality
447 affect? If new policy, who will be affected?</p>
448 </li>
449 <li><p class="first">Rationale -- The rationale fleshes out the specification by
450 describing what motivated the design and why particular design decisions
451 were made. It should describe alternate designs that were considered and
452 related work, e.g. how the feature is supported in other distributions.</p>
453 <p>The rationale should provide evidence of consensus within the community and
454 discuss important objections or concerns raised during discussion.</p>
455 </li>
456 <li><p class="first">Backwards Compatibility -- All GLEPs
457 must include a section describing any issues of backwards incompatibilities
458 and their severity. The GLEP must explain how the author proposes to deal
459 with these incompatibilities. (Even if there are none, this section should
460 be included to clearly state that fact.) GLEP submissions without a
461 sufficient backwards compatibility treatise may be rejected outright.</p>
462 </li>
463 <li><p class="first">Reference Implementation -- The reference implementation must be
464 completed before any GLEP is given status &quot;Final&quot;, but it need not be
465 completed before the GLEP is accepted. It is better to finish the
466 specification and rationale first and reach consensus on it before writing
467 code or significantly modifying ebuilds.</p>
468 </li>
469 <li><p class="first">Copyright/public domain -- Each GLEP must either be explicitly
470 labelled as placed in the public domain (see this GLEP as an example) or
471 licensed under the Open Publication License [#OPL].</p>
472 </li>
473 </ol>
474 </div>
475 <div class="section">
476 <h1><a class="toc-backref" href="#id22" id="glep-formating-and-template" name="glep-formating-and-template">GLEP Formating and Template</a></h1>
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
478 a just-barely-marked-up version of plain ASCII text
479 called ReStructuredText <a class="footnote-reference" href="#resthome" id="id11" name="id11">[10]</a> that is then converted to HTML using
480 Docutils <a class="footnote-reference" href="#docutils" id="id12" name="id12">[12]</a>. Using ReStructuredText GLEPs allows for rich markup
481 that is still quite easy to read, but results in much better-looking and more
482 functional HTML. Moreover, it should be straightforward to convert GLEPs to
483 Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id13" name="id13">[11]</a> if needed. GLEP 2 contains a boilerplate
484 template <a class="footnote-reference" href="#rest" id="id14" name="id14">[5]</a> for use with ReStructuredText GLEPs.</p>
485 </div>
486 <div class="section">
487 <h1><a class="toc-backref" href="#id23" id="glep-header-preamble" name="glep-header-preamble">GLEP Header Preamble</a></h1>
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
489 must appear in the following order. Headers marked with &quot;*&quot; are
490 optional and are described below. All other headers are required.</p>
491 <pre class="literal-block">
492 GLEP: &lt;glep number&gt;
493 Title: &lt;glep title&gt;
494 Version: &lt;cvs version string&gt;
495 Last-Modified: &lt;cvs date string&gt;
496 Author: &lt;list of authors' real names and optionally, email addrs&gt;
497 * Discussions-To: &lt;email address&gt;
498 Status: &lt;Draft | Active | Accepted | Deferred | Rejected |
499 Final | Replaced&gt;
500 Type: &lt;Informational | Standards Track&gt;
501 * Content-Type: &lt;text/plain | text/x-rst&gt;
502 * Requires: &lt;glep numbers&gt;
503 Created: &lt;date created on, in dd-mmm-yyyy format&gt;
504 Post-History: &lt;dates of postings to gentoo-dev&gt;
505 * Replaces: &lt;glep number&gt;
506 * Replaced-By: &lt;glep number&gt;
507 </pre>
508 <p>The Author header lists the names, and optionally the email addresses
509 of all the authors/owners of the GLEP. The format of the Author header
510 value must be</p>
511 <blockquote>
512 Random J. User &lt;<a class="reference" href="mailto:address&#64;dom.ain">address&#64;dom.ain</a>&gt;</blockquote>
513 <p>if the email address is included, and just</p>
514 <blockquote>
515 Random J. User</blockquote>
516 <p>if the address is not given.</p>
517 <p>If there are multiple authors, each should be on a separate line
518 following <a class="reference" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> continuation line conventions. Note that personal
519 email addresses in GLEPs will be obscured as a defense against spam
520 harvesters.</p>
521 <p>While a GLEP is in private discussions (usually during the initial Draft
522 phase), a Discussions-To header will indicate the mailing list or URL where
523 the GLEP is being discussed. No Discussions-To header is necessary if the
524 GLEP is being discussed privately with the author, or on the gentoo-dev
525 mailing list. Note that email addresses in the Discussions-To header will not
526 be obscured.</p>
527 <p>The Type header specifies the type of GLEP: Informational or Standards
528 Track.</p>
529 <p>The format of a GLEP is specified with a Content-Type header, which
530 should read &quot;text/xml&quot; for Gentoo Guide XML or
531 &quot;text/x-rst&quot; for ReStructuredText GLEPs (see GLEP 2
532 <a class="footnote-reference" href="#rest" id="id15" name="id15">[5]</a>).</p>
533 <p>The Created header records the date that the GLEP was assigned a number, while
534 Post-History is used to record the dates of when new versions of the GLEP are
535 posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g.
536 14-Aug-2001.</p>
537 <p>GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP
538 depends on.</p>
539 <p>GLEPs may also have a Replaced-By header indicating that a GLEP has been
540 rendered obsolete by a later document; the value is the number of the GLEP
541 that replaces the current document. The newer GLEP must have a Replaces
542 header containing the number of the GLEP that it rendered obsolete.</p>
543 </div>
544 <div class="section">
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>
546 <p>How you report a bug, or submit a GLEP update depends on several factors, such
547 as the maturity of the GLEP, the preferences of the GLEP author, and the
548 nature of your comments. For the early draft stages of the GLEP, it's
549 probably best to send your comments and changes directly to the GLEP author.
550 For more mature, or finished GLEPs you may want to submit corrections to the
551 Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id16" name="id16">[6]</a> so that your changes don't get lost. If the GLEP
552 author is a Gentoo Linux developer, assign the bug/patch to him, otherwise
553 assign it to the GLEP editors.</p>
554 <p>When in doubt about where to send your changes, please check first with the
555 GLEP author and/or GLEP editors.</p>
556 <p>GLEP authors who are also Gentoo Linux developers can update the GLEPs
557 themselves by using &quot;cvs commit&quot; to commit their changes.</p>
558 </div>
559 <div class="section">
560 <h1><a class="toc-backref" href="#id25" id="transferring-glep-ownership" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1>
561 <p>It occasionally becomes necessary to transfer ownership of GLEPs to a new
562 champion. In general, we'd like to retain the original author as a co-author
563 of the transferred GLEP, but that's really up to the original author. A good
564 reason to transfer ownership is because the original author no longer has the
565 time or interest in updating it or following through with the GLEP process, or
566 has fallen off the face of the 'net (i.e. is unreachable or not responding to
567 email). A bad reason to transfer ownership is because you don't agree with
568 the direction of the GLEP. We try to build consensus around a GLEP, but if
569 that's not possible, you can always submit a competing GLEP.</p>
570 <p>If you are interested in assuming ownership of a GLEP, send a message asking
571 to take over, addressed to both the original author and the GLEP editors
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
573 timely manner, the GLEP editors will make a unilateral decision (it's not like
574 such decisions can't be reversed :).</p>
575 </div>
576 <div class="section">
577 <h1><a class="toc-backref" href="#id26" id="references-and-footnotes" name="references-and-footnotes">References and Footnotes</a></h1>
578 <table class="docutils footnote" frame="void" id="python" rules="none">
579 <colgroup><col class="label" /><col /></colgroup>
580 <tbody valign="top">
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>
582 </tbody>
583 </table>
584 <table class="docutils footnote" frame="void" id="peps" rules="none">
585 <colgroup><col class="label" /><col /></colgroup>
586 <tbody valign="top">
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>
588 </tbody>
589 </table>
590 <table class="docutils footnote" frame="void" id="pep1" rules="none">
591 <colgroup><col class="label" /><col /></colgroup>
592 <tbody valign="top">
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>
594 </tbody>
595 </table>
596 <table class="docutils footnote" frame="void" id="cvs" rules="none">
597 <colgroup><col class="label" /><col /></colgroup>
598 <tbody valign="top">
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
600 for retrieving older revisions. For those without direct access to the CVS
601 tree, you can browse the current and past GLEP revisions via the Gentoo
602 Linux viewcvs web site at
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>
604 </tbody>
605 </table>
606 <table class="docutils footnote" frame="void" id="rest" rules="none">
607 <colgroup><col class="label" /><col /></colgroup>
608 <tbody valign="top">
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,
610 (<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr>
611 </tbody>
612 </table>
613 <table class="docutils footnote" frame="void" id="bugs" rules="none">
614 <colgroup><col class="label" /><col /></colgroup>
615 <tbody valign="top">
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>
617 </tbody>
618 </table>
619 <table class="docutils footnote" frame="void" id="forums" rules="none">
620 <colgroup><col class="label" /><col /></colgroup>
621 <tbody valign="top">
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>
623 </tbody>
624 </table>
625 <table class="docutils footnote" frame="void" id="manager" rules="none">
626 <colgroup><col class="label" /><col /></colgroup>
627 <tbody valign="top">
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>
629 </tbody>
630 </table>
631 <table class="docutils footnote" frame="void" id="opl" rules="none">
632 <colgroup><col class="label" /><col /></colgroup>
633 <tbody valign="top">
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>
635 </tbody>
636 </table>
637 <table class="docutils footnote" frame="void" id="resthome" rules="none">
638 <colgroup><col class="label" /><col /></colgroup>
639 <tbody valign="top">
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>
641 </tbody>
642 </table>
643 <table class="docutils footnote" frame="void" id="guidexml" rules="none">
644 <colgroup><col class="label" /><col /></colgroup>
645 <tbody valign="top">
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>
647 </tbody>
648 </table>
649 <table class="docutils footnote" frame="void" id="docutils" rules="none">
650 <colgroup><col class="label" /><col /></colgroup>
651 <tbody valign="top">
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>
653 </tbody>
654 </table>
655 </div>
656 <div class="section">
657 <h1><a class="toc-backref" href="#id27" id="copyright" name="copyright">Copyright</a></h1>
658 <p>This document has been placed in the public domain.</p>
659 </div>
660
661 </div>
662 <div class="footer">
663 <hr class="footer" />
664 <a class="reference" href="glep-0001.txt">View document source</a>.
665 Generated on: 2006-10-10 20:23 UTC.
666 Generated 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
668 </div>
669 </body>
670 </html>

  ViewVC Help
Powered by ViewVC 1.1.20