/[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.12 Revision 1.15
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 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"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 4
5<head> 5<head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
8 <title>GLEP 1 -- GLEP Purpose and Guidelines</title> 8 <title>GLEP 1 -- GLEP Purpose and Guidelines</title>
9 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" /></head>
10</head>
11<body bgcolor="white"> 10<body bgcolor="white">
12<table class="navigation" cellpadding="0" cellspacing="0" 11<table class="navigation" cellpadding="0" cellspacing="0"
13 width="100%" border="0"> 12 width="100%" border="0">
14<tr><td class="navicon" width="150" height="35"> 13<tr><td class="navicon" width="150" height="35">
15<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 14<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
26<tbody valign="top"> 25<tbody valign="top">
27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td> 26<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td>
28</tr> 27</tr>
29<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td> 28<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td>
30</tr> 29</tr>
31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.10</td> 30<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.12</td>
32</tr> 31</tr>
33<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">2008/01/05 03:05:07</a></td> 32<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0001.txt?cvsroot=gentoo">2008/06/05 06:05:32</a></td>
34</tr> 33</tr>
35<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> 34<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>
36</tr> 35</tr>
37<tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td> 36<tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
38</tr> 37</tr>
39<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td> 38<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
40</tr> 39</tr>
41<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> 40<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="glep-0002.html">text/x-rst</a></td>
42</tr> 41</tr>
43<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-May-2003</td> 42<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-May-2003</td>
44</tr> 43</tr>
45<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Jun-2003, 2-Jul-2003, 19-Jan-2008</td> 44<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Jun-2003, 2-Jul-2003, 19-Jan-2008, 05-Jun-2008, 09-Mar-2011</td>
46</tr>
47<tr class="field"><th class="field-name">Replaced-By:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/proj/en/glepglep-0039.html">39</a></td>
48</tr> 45</tr>
49</tbody> 46</tbody>
50</table> 47</table>
51<hr /> 48<hr />
52<div class="contents topic"> 49<div class="contents topic" id="contents">
53<p class="topic-title first"><a id="contents" name="contents">Contents</a></p> 50<p class="topic-title first">Contents</p>
54<ul class="simple"> 51<ul class="simple">
55<li><a class="reference" href="#credits" id="id17" name="id17">Credits</a></li> 52<li><a class="reference internal" href="#credits" id="id16">Credits</a></li>
56<li><a class="reference" href="#what-is-a-glep" id="id18" name="id18">What is a GLEP?</a></li> 53<li><a class="reference internal" href="#what-is-a-glep" id="id17">What is a GLEP?</a></li>
57<li><a class="reference" href="#kinds-of-gleps" id="id19" name="id19">Kinds of GLEPs</a></li> 54<li><a class="reference internal" href="#kinds-of-gleps" id="id18">Kinds of GLEPs</a></li>
58<li><a class="reference" href="#glep-work-flow" id="id20" name="id20">GLEP Work Flow</a></li> 55<li><a class="reference internal" href="#glep-work-flow" id="id19">GLEP Work Flow</a></li>
59<li><a class="reference" href="#what-belongs-in-a-successful-glep" id="id21" name="id21">What belongs in a successful GLEP?</a></li> 56<li><a class="reference internal" href="#what-belongs-in-a-successful-glep" id="id20">What belongs in a successful GLEP?</a></li>
60<li><a class="reference" href="#glep-formating-and-template" id="id22" name="id22">GLEP Formating and Template</a></li> 57<li><a class="reference internal" href="#glep-formating-and-template" id="id21">GLEP Formating and Template</a></li>
61<li><a class="reference" href="#glep-header-preamble" id="id23" name="id23">GLEP Header Preamble</a></li> 58<li><a class="reference internal" href="#glep-header-preamble" id="id22">GLEP Header Preamble</a></li>
62<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> 59<li><a class="reference internal" href="#reporting-glep-bugs-or-submitting-glep-updates" id="id23">Reporting GLEP Bugs, or Submitting GLEP Updates</a></li>
63<li><a class="reference" href="#transferring-glep-ownership" id="id25" name="id25">Transferring GLEP Ownership</a></li> 60<li><a class="reference internal" href="#transferring-glep-ownership" id="id24">Transferring GLEP Ownership</a></li>
64<li><a class="reference" href="#references-and-footnotes" id="id26" name="id26">References and Footnotes</a></li> 61<li><a class="reference internal" href="#references-and-footnotes" id="id25">References and Footnotes</a></li>
65<li><a class="reference" href="#copyright" id="id27" name="id27">Copyright</a></li> 62<li><a class="reference internal" href="#copyright" id="id26">Copyright</a></li>
66</ul> 63</ul>
67</div> 64</div>
68<div class="section"> 65<div class="section" id="credits">
69<h1><a class="toc-backref" href="#id17" id="credits" name="credits">Credits</a></h1> 66<h1><a class="toc-backref" href="#id16">Credits</a></h1>
70<p>The GLEP concept, and, in fact, much of the text of this document, 67<p>The GLEP concept, and, in fact, much of the text of this document,
71is liberally stolen from Python's <a class="footnote-reference" href="#python" id="id1" name="id1">[1]</a> PEPs 68is liberally stolen from Python's <a class="footnote-reference" href="#python" id="id1">[1]</a> PEPs
72<a class="footnote-reference" href="#peps" id="id2" name="id2">[2]</a>, especially 69<a class="footnote-reference" href="#peps" id="id2">[2]</a>, especially
73PEP-0001 <a class="footnote-reference" href="#pep1" id="id3" name="id3">[3]</a> by Barry A. Warsaw, Jeremy Hylton, and David Goodger.</p> 70PEP-0001 <a class="footnote-reference" href="#pep1" id="id3">[3]</a> by Barry A. Warsaw, Jeremy Hylton, and David Goodger.</p>
74</div> 71</div>
75<div class="section"> 72<div class="section" id="what-is-a-glep">
76<h1><a class="toc-backref" href="#id18" id="what-is-a-glep" name="what-is-a-glep">What is a GLEP?</a></h1> 73<h1><a class="toc-backref" href="#id17">What is a GLEP?</a></h1>
77<p>GLEP stands for &quot;Gentoo Linux Enhancement Proposal&quot;. A GLEP is a design 74<p>GLEP stands for &quot;Gentoo Linux Enhancement Proposal&quot;. A GLEP is a design
78document providing information to the Gentoo Linux community, or describing 75document providing information to the Gentoo Linux community, or describing
79a new feature for Gentoo Linux. The GLEP should provide a concise technical 76a new feature for Gentoo Linux. The GLEP should provide a concise technical
80specification of the feature and rationale for the feature.</p> 77specification of the feature and rationale for the feature.</p>
81<p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new 78<p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new
83documenting the design decisions that have gone into Gentoo Linux. The GLEP 80documenting the design decisions that have gone into Gentoo Linux. The GLEP
84author is responsible for building consensus within the community and 81author is responsible for building consensus within the community and
85documenting dissenting opinions.</p> 82documenting dissenting opinions.</p>
86<p>Because the GLEPs are maintained as text files under CVS control, their 83<p>Because the GLEPs are maintained as text files under CVS control, their
87revision history is the historical record of the feature proposal 84revision history is the historical record of the feature proposal
88<a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p> 85<a class="footnote-reference" href="#cvs" id="id4">[4]</a>.</p>
89</div> 86</div>
90<div class="section"> 87<div class="section" id="kinds-of-gleps">
91<h1><a class="toc-backref" href="#id19" id="kinds-of-gleps" name="kinds-of-gleps">Kinds of GLEPs</a></h1> 88<h1><a class="toc-backref" href="#id18">Kinds of GLEPs</a></h1>
92<p>There are two kinds of GLEPs. A Standards Track GLEP describes a new feature 89<p>There are two kinds of GLEPs. A Standards Track GLEP describes a new feature
93or implementation for Gentoo Linux. An Informational GLEP describes provides 90or implementation for Gentoo Linux. An Informational GLEP describes provides
94general guidelines or information to the Gentoo Linux community, but does not 91general guidelines or information to the Gentoo Linux community, but does not
95propose a new feature. Informational GLEPs do not necessarily represent a 92propose a new feature. Informational GLEPs do not necessarily represent a
96Gentoo Linux community consensus or recommendation, so users and implementors 93Gentoo Linux community consensus or recommendation, so users and implementors
97are free to ignore Informational GLEPs or follow their advice.</p> 94are free to ignore Informational GLEPs or follow their advice.</p>
98</div> 95</div>
99<div class="section"> 96<div class="section" id="glep-work-flow">
100<h1><a class="toc-backref" href="#id20" id="glep-work-flow" name="glep-work-flow">GLEP Work Flow</a></h1> 97<h1><a class="toc-backref" href="#id19">GLEP Work Flow</a></h1>
101<p>The GLEP editors assign GLEP numbers and change their status. The current 98<p>The GLEP editors assign GLEP numbers and change their status. The current
102GLEP editors are Grant Goodyear and Alastair Tse. Please send all 99GLEP editors are Grant Goodyear and Alastair Tse. Please send all
103GLEP-related email to &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;.</p> 100GLEP-related email to &lt;<a class="reference external" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;.</p>
104<p>The GLEP process begins with a new idea for Gentoo Linux. It is highly 101<p>The GLEP process begins with a new idea for Gentoo Linux. It is highly
105recommended that a single GLEP contain a single key proposal or new idea. The 102recommended that a single GLEP contain a single key proposal or new idea. The
106more focussed the GLEP, the more successful it tends to be. The GLEP editors 103more focused the GLEP, the more successful it tends to be. The GLEP editors
107reserve the right to reject GLEP proposals if they appear too unfocussed or 104reserve the right to reject GLEP proposals if they appear too unfocused or
108too broad. If in doubt, split your GLEP into several well-focussed ones.</p> 105too broad. If in doubt, split your GLEP into several well-focused ones.</p>
109<p>Each GLEP must have a champion -- someone who writes the GLEP using the style 106<p>Each GLEP must have a champion -- someone who writes the GLEP using the style
110and format described below, shepherds the discussions in the appropriate 107and format described below, shepherds the discussions in the appropriate
111forums, and attempts to build community consensus around the idea. The GLEP 108forums, and attempts to build community consensus around the idea. The GLEP
112champion (a.k.a. Author) should first attempt to ascertain whether the idea is 109champion (a.k.a. Author) should first attempt to ascertain whether the idea is
113GLEP-able. Small enhancements or patches often don't need a GLEP and can be 110GLEP-able. Small enhancements or patches often don't need a GLEP and can be
114injected into the Gentoo Linux development work flow with an enhancement &quot;bug&quot; 111injected into the Gentoo Linux development work flow with an enhancement &quot;bug&quot;
115submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5" name="id5">[6]</a>.</p> 112submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5">[6]</a>.</p>
116<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 113<p>The GLEP champion then emails the GLEP editors &lt;<a class="reference external" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt; with a
117proposed title and a rough, but fleshed out, draft of the GLEP. This draft 114proposed title and a rough, but fleshed out, draft of the GLEP. This draft
118must be written in GLEP style as described below.</p> 115must be written in GLEP style as described below.</p>
119<p>If the GLEP editor accepts the GLEP, he will assign the GLEP a number, label 116<p>If the GLEP editor accepts the GLEP, he will assign the GLEP a number, label
120it as Standards Track (a better name would be nice here -- suggestions?) or 117it as Standards Track (a better name would be nice here -- suggestions?) or
121Informational, give it status &quot;Draft&quot;, and create and check-in the initial 118Informational, give it status &quot;Draft&quot;, and create and check-in the initial
122draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP. 119draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP.
123Reasons for denying GLEP status include duplication of effort, being 120Reasons for denying GLEP status include duplication of effort, being
124technically unsound, not providing proper motivation or addressing backwards 121technically unsound, not providing proper motivation or addressing backwards
125compatibility, or not in keeping with Gentoo Linux philosophy.</p> 122compatibility, or not in keeping with Gentoo Linux philosophy.</p>
126<p>If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the 123<p>If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the
127<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 124<a class="reference external" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a> mailing list to help flesh it out, gain feedback and
128consensus from the community at large, and improve the GLEP for re-submission.</p> 125consensus from the community at large, and improve the GLEP for re-submission.</p>
129<p>The author of the GLEP is then responsible for posting the GLEP to the 126<p>The author of the GLEP is then responsible for posting the GLEP to the
130gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and 127gentoo-dev mailing list (and additionally to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6">[7]</a>
131marshaling community support for it. As updates are necessary, the GLEP 128if they so desire), and marshaling community support for it. As updates are
132author can check in new versions if they have CVS commit permissions, or can 129necessary, the GLEP author may check in new versions directly, or forward to
133email new GLEP versions to the GLEP editors for committing.</p> 130a Gentoo developer with commit access.</p>
134<p>Standards Track GLEPs consist of two parts, a design document and a reference 131<p>Standards Track GLEPs consist of two parts, a design document and a reference
135implementation. The GLEP should be reviewed and accepted before a reference 132implementation. The GLEP should be reviewed and accepted before a reference
136implementation is begun, unless a reference implementation will aid people in 133implementation is begun, unless a reference implementation will aid people in
137studying the GLEP. Standards Track GLEPs must include an implementation -- in 134studying the GLEP. Standards Track GLEPs must include an implementation -- in
138the form of code, patch, or URL to same -- before it can be considered Final.</p> 135the form of code, patch, or URL to same -- before it can be considered Final.</p>
139<p>GLEP authors are responsible for collecting community feedback on a GLEP 136<p>GLEP authors are responsible for collecting community feedback on a GLEP
140before submitting it for review. A GLEP that has not been discussed on 137before submitting it for review. A GLEP that has not been discussed on
141<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 138<a class="reference external" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a> and the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id7">[7]</a> will not be
142accepted. However, wherever possible, long open-ended discussions on public 139accepted. However, wherever possible, long open-ended discussions on public
143mailing lists should be avoided. Strategies to keep the discussions efficient 140mailing lists should be avoided. Strategies to keep the discussions efficient
144include setting up a specific forums thread for the topic, having the GLEP 141include setting up a specific forums thread for the topic, having the GLEP
145author accept private comments in the early design phases, etc. GLEP authors 142author accept private comments in the early design phases, etc. GLEP authors
146should use their discretion here.</p> 143should use their discretion here.</p>
147<p>Once the authors have completed a GLEP, they must inform the GLEP editors that 144<p>Once the authors have completed a GLEP, they must inform the Gentoo Council
148it is ready for review. GLEPs are reviewed by the appropriate Gentoo 145<a class="footnote-reference" href="#council" id="id8">[8]</a> that it is ready for review by way of the gentoo-dev mailing
149Manager <a class="footnote-reference" href="#manager" id="id8" name="id8">[8]</a>, who may approve or reject a GLEP outright, or 146list. GLEPs are then reviewed at a Council meeting where the may be approved
150send it back to the author(s) for revision. For a GLEP that is pre-determined 147or rejected outright, or sent back to the author(s) for revision. This
151to be approvable (e.g., it is an obvious win as-is and/or its implementation 148generally should be done a few weeks in advance of the actual review so as to
152has already been checked in) the appropriate Gentoo Manager <a class="footnote-reference" href="#manager" id="id9" name="id9">[8]</a> 149avoid the appearance of &quot;slipping&quot; a GLEP in without proper public review
153may also initiate a GLEP review, first notifying the GLEP author(s) and giving 150by the Gentoo developer community.</p>
154them a chance to make revisions.</p>
155<p>For a GLEP to be approved it must meet certain minimum criteria. It must be a 151<p>For a GLEP to be approved it must meet certain minimum criteria. It must be a
156clear and complete description of the proposed enhancement. The enhancement 152clear and complete description of the proposed enhancement. The enhancement
157must represent a net improvement. The proposed implementation, if applicable, 153must represent a net improvement. The proposed implementation, if applicable,
158must be solid and must not complicate the distribution unduly. Finally, a 154must be solid and must not complicate the distribution unduly. Finally, a
159proposed enhancement must satisfy the philosophy of Gentoo Linux.</p> 155proposed enhancement must satisfy the philosophy of Gentoo Linux.</p>
176Deferred 172Deferred
177</pre> 173</pre>
178<p>Some Informational GLEPs may also have a status of &quot;Active&quot; if they are never 174<p>Some Informational GLEPs may also have a status of &quot;Active&quot; if they are never
179meant to be completed. E.g. GLEP 1 (this GLEP).</p> 175meant to be completed. E.g. GLEP 1 (this GLEP).</p>
180</div> 176</div>
181<div class="section"> 177<div class="section" id="what-belongs-in-a-successful-glep">
182<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> 178<h1><a class="toc-backref" href="#id20">What belongs in a successful GLEP?</a></h1>
183<p>Each GLEP should have the following parts:</p> 179<p>Each GLEP should have the following parts:</p>
184<ol class="arabic"> 180<ol class="arabic">
185<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 181<li><p class="first">Preamble -- <a class="reference external" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style headers containing meta-data about the
186GLEP, including the GLEP number, a short descriptive title (limited 182GLEP, including the GLEP number, a short descriptive title (limited
187to a maximum of 44 characters), the names, and optionally the 183to a maximum of 44 characters), the names, and optionally the
188contact info for each author, etc.</p> 184contact info for each author, etc.</p>
189</li> 185</li>
190<li><p class="first">Abstract -- a short (~200 word) description of the technical issue 186<li><p class="first">Abstract -- a short (~200 word) description of the technical issue
225labelled as placed in the public domain (see this GLEP as an example) or 221labelled as placed in the public domain (see this GLEP as an example) or
226licensed under the Open Publication License [#OPL].</p> 222licensed under the Open Publication License [#OPL].</p>
227</li> 223</li>
228</ol> 224</ol>
229</div> 225</div>
230<div class="section"> 226<div class="section" id="glep-formating-and-template">
231<h1><a class="toc-backref" href="#id22" id="glep-formating-and-template" name="glep-formating-and-template">GLEP Formating and Template</a></h1> 227<h1><a class="toc-backref" href="#id21">GLEP Formating and Template</a></h1>
232<p>GLEPs are written either in Gentoo Linux Guide-XML <a class="footnote-reference" href="#guidexml" id="id10" name="id10">[11]</a> or in 228<p>GLEPs are written either in Gentoo Linux Guide-XML <a class="footnote-reference" href="#guidexml" id="id9">[11]</a> or in
233a just-barely-marked-up version of plain ASCII text 229a just-barely-marked-up version of plain ASCII text
234called ReStructuredText <a class="footnote-reference" href="#resthome" id="id11" name="id11">[10]</a> that is then converted to HTML using 230called ReStructuredText <a class="footnote-reference" href="#resthome" id="id10">[10]</a> that is then converted to HTML using
235Docutils <a class="footnote-reference" href="#docutils" id="id12" name="id12">[12]</a>. Using ReStructuredText GLEPs allows for rich markup 231Docutils <a class="footnote-reference" href="#docutils" id="id11">[12]</a>. Using ReStructuredText GLEPs allows for rich markup
236that is still quite easy to read, but results in much better-looking and more 232that is still quite easy to read, but results in much better-looking and more
237functional HTML. Moreover, it should be straightforward to convert GLEPs to 233functional HTML. Moreover, it should be straightforward to convert GLEPs to
238Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id13" name="id13">[11]</a> if needed. GLEP 2 contains a boilerplate 234Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id12">[11]</a> if needed. GLEP 2 contains a boilerplate
239template <a class="footnote-reference" href="#rest" id="id14" name="id14">[5]</a> for use with ReStructuredText GLEPs.</p> 235template <a class="footnote-reference" href="#rest" id="id13">[5]</a> for use with ReStructuredText GLEPs.</p>
240</div> 236</div>
241<div class="section"> 237<div class="section" id="glep-header-preamble">
242<h1><a class="toc-backref" href="#id23" id="glep-header-preamble" name="glep-header-preamble">GLEP Header Preamble</a></h1> 238<h1><a class="toc-backref" href="#id22">GLEP Header Preamble</a></h1>
243<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 239<p>Each GLEP must begin with an <a class="reference external" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> style header preamble. The headers
244must appear in the following order. Headers marked with &quot;*&quot; are 240must appear in the following order. Headers marked with &quot;*&quot; are
245optional and are described below. All other headers are required.</p> 241optional and are described below. All other headers are required.</p>
246<pre class="literal-block"> 242<pre class="literal-block">
247 GLEP: &lt;glep number&gt; 243 GLEP: &lt;glep number&gt;
248 Title: &lt;glep title&gt; 244 Title: &lt;glep title&gt;
262</pre> 258</pre>
263<p>The Author header lists the names, and optionally the email addresses 259<p>The Author header lists the names, and optionally the email addresses
264of all the authors/owners of the GLEP. The format of the Author header 260of all the authors/owners of the GLEP. The format of the Author header
265value must be</p> 261value must be</p>
266<blockquote> 262<blockquote>
267Random J. User &lt;<a class="reference" href="mailto:address&#64;dom.ain">address&#64;dom.ain</a>&gt;</blockquote> 263Random J. User &lt;<a class="reference external" href="mailto:address&#64;dom.ain">address&#64;dom.ain</a>&gt;</blockquote>
268<p>if the email address is included, and just</p> 264<p>if the email address is included, and just</p>
269<blockquote> 265<blockquote>
270Random J. User</blockquote> 266Random J. User</blockquote>
271<p>if the address is not given.</p> 267<p>if the address is not given.</p>
272<p>If there are multiple authors, each should be on a separate line 268<p>If there are multiple authors, each should be on a separate line
273following <a class="reference" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> continuation line conventions. Note that personal 269following <a class="reference external" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> continuation line conventions. Note that personal
274email addresses in GLEPs will be obscured as a defense against spam 270email addresses in GLEPs will be obscured as a defense against spam
275harvesters.</p> 271harvesters.</p>
276<p>While a GLEP is in private discussions (usually during the initial Draft 272<p>While a GLEP is in private discussions (usually during the initial Draft
277phase), a Discussions-To header will indicate the mailing list or URL where 273phase), a Discussions-To header will indicate the mailing list or URL where
278the GLEP is being discussed. No Discussions-To header is necessary if the 274the GLEP is being discussed. No Discussions-To header is necessary if the
282<p>The Type header specifies the type of GLEP: Informational or Standards 278<p>The Type header specifies the type of GLEP: Informational or Standards
283Track.</p> 279Track.</p>
284<p>The format of a GLEP is specified with a Content-Type header, which 280<p>The format of a GLEP is specified with a Content-Type header, which
285should read &quot;text/xml&quot; for Gentoo Guide XML or 281should read &quot;text/xml&quot; for Gentoo Guide XML or
286&quot;text/x-rst&quot; for ReStructuredText GLEPs (see GLEP 2 282&quot;text/x-rst&quot; for ReStructuredText GLEPs (see GLEP 2
287<a class="footnote-reference" href="#rest" id="id15" name="id15">[5]</a>).</p> 283<a class="footnote-reference" href="#rest" id="id14">[5]</a>).</p>
288<p>The Created header records the date that the GLEP was assigned a number, while 284<p>The Created header records the date that the GLEP was assigned a number, while
289Post-History is used to record the dates of when new versions of the GLEP are 285Post-History is used to record the dates of when new versions of the GLEP are
290posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. 286posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g.
29114-Aug-2001.</p> 28714-Aug-2001.</p>
292<p>GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP 288<p>GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP
294<p>GLEPs may also have a Replaced-By header indicating that a GLEP has been 290<p>GLEPs may also have a Replaced-By header indicating that a GLEP has been
295rendered obsolete by a later document; the value is the number of the GLEP 291rendered obsolete by a later document; the value is the number of the GLEP
296that replaces the current document. The newer GLEP must have a Replaces 292that replaces the current document. The newer GLEP must have a Replaces
297header containing the number of the GLEP that it rendered obsolete.</p> 293header containing the number of the GLEP that it rendered obsolete.</p>
298</div> 294</div>
299<div class="section"> 295<div class="section" id="reporting-glep-bugs-or-submitting-glep-updates">
300<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> 296<h1><a class="toc-backref" href="#id23">Reporting GLEP Bugs, or Submitting GLEP Updates</a></h1>
301<p>How you report a bug, or submit a GLEP update depends on several factors, such 297<p>How you report a bug, or submit a GLEP update depends on several factors, such
302as the maturity of the GLEP, the preferences of the GLEP author, and the 298as the maturity of the GLEP, the preferences of the GLEP author, and the
303nature of your comments. For the early draft stages of the GLEP, it's 299nature of your comments. For the early draft stages of the GLEP, it's
304probably best to send your comments and changes directly to the GLEP author. 300probably best to send your comments and changes directly to the GLEP author.
305For more mature, or finished GLEPs you may want to submit corrections to the 301For more mature, or finished GLEPs you may want to submit corrections to the
306Gentoo 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 302Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id15">[6]</a> so that your changes don't get lost. If the GLEP
307author is a Gentoo Linux developer, assign the bug/patch to him, otherwise 303author is a Gentoo Linux developer, assign the bug/patch to him, otherwise
308assign it to the GLEP editors.</p> 304assign it to the GLEP editors.</p>
309<p>When in doubt about where to send your changes, please check first with the 305<p>When in doubt about where to send your changes, please check first with the
310GLEP author and/or GLEP editors.</p> 306GLEP author and/or GLEP editors.</p>
311<p>GLEP authors who are also Gentoo Linux developers can update the GLEPs 307<p>GLEP authors who are also Gentoo Linux developers can update the GLEPs
312themselves by using &quot;cvs commit&quot; to commit their changes.</p> 308themselves by using &quot;cvs commit&quot; to commit their changes.</p>
313</div> 309</div>
314<div class="section"> 310<div class="section" id="transferring-glep-ownership">
315<h1><a class="toc-backref" href="#id25" id="transferring-glep-ownership" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1> 311<h1><a class="toc-backref" href="#id24">Transferring GLEP Ownership</a></h1>
316<p>It occasionally becomes necessary to transfer ownership of GLEPs to a new 312<p>It occasionally becomes necessary to transfer ownership of GLEPs to a new
317champion. In general, we'd like to retain the original author as a co-author 313champion. In general, we'd like to retain the original author as a co-author
318of the transferred GLEP, but that's really up to the original author. A good 314of the transferred GLEP, but that's really up to the original author. A good
319reason to transfer ownership is because the original author no longer has the 315reason to transfer ownership is because the original author no longer has the
320time or interest in updating it or following through with the GLEP process, or 316time or interest in updating it or following through with the GLEP process, or
322email). A bad reason to transfer ownership is because you don't agree with 318email). A bad reason to transfer ownership is because you don't agree with
323the direction of the GLEP. We try to build consensus around a GLEP, but if 319the direction of the GLEP. We try to build consensus around a GLEP, but if
324that's not possible, you can always submit a competing GLEP.</p> 320that's not possible, you can always submit a competing GLEP.</p>
325<p>If you are interested in assuming ownership of a GLEP, send a message asking 321<p>If you are interested in assuming ownership of a GLEP, send a message asking
326to take over, addressed to both the original author and the GLEP editors 322to take over, addressed to both the original author and the GLEP editors
327&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 323&lt;<a class="reference external" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;. If the original author doesn't respond to email in a
328timely manner, the GLEP editors will make a unilateral decision (it's not like 324timely manner, the GLEP editors will make a unilateral decision (it's not like
329such decisions can't be reversed :).</p> 325such decisions can't be reversed :).</p>
330</div> 326</div>
331<div class="section"> 327<div class="section" id="references-and-footnotes">
332<h1><a class="toc-backref" href="#id26" id="references-and-footnotes" name="references-and-footnotes">References and Footnotes</a></h1> 328<h1><a class="toc-backref" href="#id25">References and Footnotes</a></h1>
333<table class="docutils footnote" frame="void" id="python" rules="none"> 329<table class="docutils footnote" frame="void" id="python" rules="none">
334<colgroup><col class="label" /><col /></colgroup> 330<colgroup><col class="label" /><col /></colgroup>
335<tbody valign="top"> 331<tbody valign="top">
336<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> 332<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://www.python.org">http://www.python.org</a></td></tr>
337</tbody> 333</tbody>
338</table> 334</table>
339<table class="docutils footnote" frame="void" id="peps" rules="none"> 335<table class="docutils footnote" frame="void" id="peps" rules="none">
340<colgroup><col class="label" /><col /></colgroup> 336<colgroup><col class="label" /><col /></colgroup>
341<tbody valign="top"> 337<tbody valign="top">
342<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> 338<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td><a class="reference external" href="http://www.python.org/peps">http://www.python.org/peps</a></td></tr>
343</tbody> 339</tbody>
344</table> 340</table>
345<table class="docutils footnote" frame="void" id="pep1" rules="none"> 341<table class="docutils footnote" frame="void" id="pep1" rules="none">
346<colgroup><col class="label" /><col /></colgroup> 342<colgroup><col class="label" /><col /></colgroup>
347<tbody valign="top"> 343<tbody valign="top">
348<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> 344<tr><td class="label"><a class="fn-backref" href="#id3">[3]</a></td><td><a class="reference external" href="http://www.python.org/peps/pep-0001.html">http://www.python.org/peps/pep-0001.html</a></td></tr>
349</tbody> 345</tbody>
350</table> 346</table>
351<table class="docutils footnote" frame="void" id="cvs" rules="none"> 347<table class="docutils footnote" frame="void" id="cvs" rules="none">
352<colgroup><col class="label" /><col /></colgroup> 348<colgroup><col class="label" /><col /></colgroup>
353<tbody valign="top"> 349<tbody valign="top">
354<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 350<tr><td class="label"><a class="fn-backref" href="#id4">[4]</a></td><td>This historical record is available by the normal CVS commands
355for retrieving older revisions. For those without direct access to the CVS 351for retrieving older revisions. For those without direct access to the CVS
356tree, you can browse the current and past GLEP revisions via the Gentoo 352tree, you can browse the current and past GLEP revisions via the Gentoo
357Linux viewcvs web site at 353Linux viewcvs web site at
358<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> 354<a class="reference external" 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>
359</tbody> 355</tbody>
360</table> 356</table>
361<table class="docutils footnote" frame="void" id="rest" rules="none"> 357<table class="docutils footnote" frame="void" id="rest" rules="none">
362<colgroup><col class="label" /><col /></colgroup> 358<colgroup><col class="label" /><col /></colgroup>
363<tbody valign="top"> 359<tbody valign="top">
364<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, 360<tr><td class="label">[5]</td><td><em>(<a class="fn-backref" href="#id13">1</a>, <a class="fn-backref" href="#id14">2</a>)</em> GLEP 2, Sample ReStructuredText GLEP Template,
365(<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr> 361(<a class="reference external" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr>
366</tbody> 362</tbody>
367</table> 363</table>
368<table class="docutils footnote" frame="void" id="bugs" rules="none"> 364<table class="docutils footnote" frame="void" id="bugs" rules="none">
369<colgroup><col class="label" /><col /></colgroup> 365<colgroup><col class="label" /><col /></colgroup>
370<tbody valign="top"> 366<tbody valign="top">
371<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> 367<tr><td class="label">[6]</td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id15">2</a>)</em> <a class="reference external" href="http://bugs.gentoo.org">http://bugs.gentoo.org</a></td></tr>
372</tbody> 368</tbody>
373</table> 369</table>
374<table class="docutils footnote" frame="void" id="forums" rules="none"> 370<table class="docutils footnote" frame="void" id="forums" rules="none">
375<colgroup><col class="label" /><col /></colgroup> 371<colgroup><col class="label" /><col /></colgroup>
376<tbody valign="top"> 372<tbody valign="top">
377<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> 373<tr><td class="label">[7]</td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference external" href="http://forums.gentoo.org">http://forums.gentoo.org</a></td></tr>
378</tbody> 374</tbody>
379</table> 375</table>
380<table class="docutils footnote" frame="void" id="manager" rules="none"> 376<table class="docutils footnote" frame="void" id="council" rules="none">
381<colgroup><col class="label" /><col /></colgroup> 377<colgroup><col class="label" /><col /></colgroup>
382<tbody valign="top"> 378<tbody valign="top">
383<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> 379<tr><td class="label"><a class="fn-backref" href="#id8">[8]</a></td><td><a class="reference external" href="http://www.gentoo.org/proj/en/glep/glep-0039.html">http://www.gentoo.org/proj/en/glep/glep-0039.html</a></td></tr>
384</tbody> 380</tbody>
385</table> 381</table>
386<table class="docutils footnote" frame="void" id="opl" rules="none"> 382<table class="docutils footnote" frame="void" id="opl" rules="none">
387<colgroup><col class="label" /><col /></colgroup> 383<colgroup><col class="label" /><col /></colgroup>
388<tbody valign="top"> 384<tbody valign="top">
389<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> 385<tr><td class="label">[9]</td><td><a class="reference external" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr>
390</tbody> 386</tbody>
391</table> 387</table>
392<table class="docutils footnote" frame="void" id="resthome" rules="none"> 388<table class="docutils footnote" frame="void" id="resthome" rules="none">
393<colgroup><col class="label" /><col /></colgroup> 389<colgroup><col class="label" /><col /></colgroup>
394<tbody valign="top"> 390<tbody valign="top">
395<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> 391<tr><td class="label"><a class="fn-backref" href="#id10">[10]</a></td><td><a class="reference external" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr>
396</tbody> 392</tbody>
397</table> 393</table>
398<table class="docutils footnote" frame="void" id="guidexml" rules="none"> 394<table class="docutils footnote" frame="void" id="guidexml" rules="none">
399<colgroup><col class="label" /><col /></colgroup> 395<colgroup><col class="label" /><col /></colgroup>
400<tbody valign="top"> 396<tbody valign="top">
401<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> 397<tr><td class="label">[11]</td><td><em>(<a class="fn-backref" href="#id9">1</a>, <a class="fn-backref" href="#id12">2</a>)</em> <a class="reference external" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr>
402</tbody> 398</tbody>
403</table> 399</table>
404<table class="docutils footnote" frame="void" id="docutils" rules="none"> 400<table class="docutils footnote" frame="void" id="docutils" rules="none">
405<colgroup><col class="label" /><col /></colgroup> 401<colgroup><col class="label" /><col /></colgroup>
406<tbody valign="top"> 402<tbody valign="top">
407<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> 403<tr><td class="label"><a class="fn-backref" href="#id11">[12]</a></td><td><a class="reference external" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr>
408</tbody> 404</tbody>
409</table> 405</table>
410</div> 406</div>
411<div class="section"> 407<div class="section" id="copyright">
412<h1><a class="toc-backref" href="#id27" id="copyright" name="copyright">Copyright</a></h1> 408<h1><a class="toc-backref" href="#id26">Copyright</a></h1>
413<p>This document has been placed in the public domain.</p> 409<p>This document has been placed in the public domain.</p>
414</div> 410</div>
415 411
416</div> 412</div>
417<div class="footer"> 413<div class="footer">
418<hr class="footer" /> 414<hr class="footer" />
419<a class="reference" href="glep-0001.txt">View document source</a>. 415<a class="reference external" href="glep-0001.txt">View document source</a>.
420Generated on: 2008-01-20 02:56 UTC. 416Generated on: 2011-03-10 20:52 UTC.
421Generated 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. 417Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
422 418
423</div> 419</div>
424</body> 420</body>
425</html> 421</html>
426

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.15

  ViewVC Help
Powered by ViewVC 1.1.20