/[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.2 Revision 1.12
1<?xml version="1.0" encoding="utf-8" ?> 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"> 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
5This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
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!
8-->
9<head> 5<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.2.8: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 1 -- GLEP Purpose and Guidelines</title> 8 <title>GLEP 1 -- GLEP Purpose and Guidelines</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 10</head>
15<body bgcolor="white"> 11<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 12<table class="navigation" cellpadding="0" cellspacing="0"
… …
22<td class="textlinks" align="left"> 18<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 19[<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>] 20[<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>] 21[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0001.txt">GLEP Source</a></b>]
26</td></tr></table> 22</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 23<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 24<col class="field-name" />
30<col class="field-body" /> 25<col class="field-body" />
31<tbody valign="top"> 26<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td> 27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td>
33</tr> 28</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td> 29<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td>
35</tr> 30</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.10</td>
37</tr> 32</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/02 17:37:47</a></td> 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>
39</tr> 34</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> 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>
41</tr> 36</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 37<tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
43</tr> 38</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td> 39<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
45</tr> 40</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> 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>
47</tr> 42</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">31 May 2003</td> 43<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-May-2003</td>
49</tr> 44</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body"></td> 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>
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>
51</tr> 48</tr>
52</tbody> 49</tbody>
53</table> 50</table>
54<hr /> 51<hr />
55<div class="contents topic" id="contents"> 52<div class="contents topic">
56<p class="topic-title"><a name="contents">Contents</a></p> 53<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
57<ul class="simple"> 54<ul class="simple">
58<li><a class="reference" href="#credits" id="id14" name="id14">Credits</a></li> 55<li><a class="reference" href="#credits" id="id17" name="id17">Credits</a></li>
59<li><a class="reference" href="#what-is-a-glep" id="id15" name="id15">What is a GLEP?</a></li> 56<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="id16" name="id16">Kinds of GLEPs</a></li> 57<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="id17" name="id17">GLEP Work Flow</a></li> 58<li><a class="reference" href="#glep-work-flow" id="id20" name="id20">GLEP Work Flow</a></li>
62<li><a class="reference" href="#what-belongs-in-a-successful-glep" id="id18" name="id18">What belongs in a successful GLEP?</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>
63<li><a class="reference" href="#glep-formating-and-template" id="id19" name="id19">GLEP Formating and Template</a></li> 60<li><a class="reference" href="#glep-formating-and-template" id="id22" name="id22">GLEP Formating and Template</a></li>
64<li><a class="reference" href="#glep-header-preamble" id="id20" name="id20">GLEP Header Preamble</a></li> 61<li><a class="reference" href="#glep-header-preamble" id="id23" name="id23">GLEP Header Preamble</a></li>
65<li><a class="reference" href="#reporting-glep-bugs-or-submitting-glep-updates" id="id21" name="id21">Reporting GLEP Bugs, or Submitting GLEP Updates</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>
66<li><a class="reference" href="#transferring-glep-ownership" id="id22" name="id22">Transferring GLEP Ownership</a></li> 63<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="id23" name="id23">References and Footnotes</a></li> 64<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="id24" name="id24">Copyright</a></li> 65<li><a class="reference" href="#copyright" id="id27" name="id27">Copyright</a></li>
69</ul> 66</ul>
70</div> 67</div>
71<div class="section" id="credits"> 68<div class="section">
72<h1><a class="toc-backref" href="#id14" name="credits">Credits</a></h1> 69<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, 70<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 71is 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 72<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> 73PEP-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> 74</div>
78<div class="section" id="what-is-a-glep"> 75<div class="section">
79<h1><a class="toc-backref" href="#id15" name="what-is-a-glep">What is a GLEP?</a></h1> 76<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 77<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 78document providing information to the Gentoo Linux community, or describing
82a new feature for Gentoo Linux. The GLEP should provide a concise technical 79a new feature for Gentoo Linux. The GLEP should provide a concise technical
83specification of the feature and rationale for the feature.</p> 80specification 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 81<p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new
… …
88documenting dissenting opinions.</p> 85documenting dissenting opinions.</p>
89<p>Because the GLEPs are maintained as text files under CVS control, their 86<p>Because the GLEPs are maintained as text files under CVS control, their
90revision history is the historical record of the feature proposal 87revision history is the historical record of the feature proposal
91<a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p> 88<a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p>
92</div> 89</div>
93<div class="section" id="kinds-of-gleps"> 90<div class="section">
94<h1><a class="toc-backref" href="#id16" name="kinds-of-gleps">Kinds of GLEPs</a></h1> 91<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 92<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 93or implementation for Gentoo Linux. An Informational GLEP describes provides
97general guidelines or information to the Gentoo Linux community, but does not 94general guidelines or information to the Gentoo Linux community, but does not
98propose a new feature. Informational GLEPs do not necessarily represent a 95propose a new feature. Informational GLEPs do not necessarily represent a
99Gentoo Linux community consensus or recommendation, so users and implementors 96Gentoo Linux community consensus or recommendation, so users and implementors
100are free to ignore Informational GLEPs or follow their advice.</p> 97are free to ignore Informational GLEPs or follow their advice.</p>
101</div> 98</div>
102<div class="section" id="glep-work-flow"> 99<div class="section">
103<h1><a class="toc-backref" href="#id17" name="glep-work-flow">GLEP Work Flow</a></h1> 100<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 101<p>The GLEP editors assign GLEP numbers and change their status. The current
105GLEP editors are Grant Goodyear and hopefully somebody else. Please send all 102GLEP 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> 103GLEP-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 104<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 105recommended that a single GLEP contain a single key proposal or new idea. The
109more focussed the GLEP, the more successful it tends to be. The GLEP editors 106more focussed the GLEP, the more successful it tends to be. The GLEP editors
110reserve the right to reject GLEP proposals if they appear too unfocussed or 107reserve the right to reject GLEP proposals if they appear too unfocussed or
… …
114forums, and attempts to build community consensus around the idea. The GLEP 111forums, and attempts to build community consensus around the idea. The GLEP
115champion (a.k.a. Author) should first attempt to ascertain whether the idea is 112champion (a.k.a. Author) should first attempt to ascertain whether the idea is
116GLEP-able. Small enhancements or patches often don't need a GLEP and can be 113GLEP-able. Small enhancements or patches often don't need a GLEP and can be
117injected into the Gentoo Linux development work flow with an enhancement &quot;bug&quot; 114injected 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> 115submitted 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 editor &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt; with a 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
120proposed title and a rough, but fleshed out, draft of the GLEP. This draft 117proposed title and a rough, but fleshed out, draft of the GLEP. This draft
121must be written in GLEP style as described below.</p> 118must 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 119<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?) 120it as Standards Track (a better name would be nice here -- suggestions?) or
124or Informational, give it status &quot;Draft&quot;, and 121Informational, 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 122draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP.
126not unreasonably deny a GLEP. Reasons for denying GLEP status include 123Reasons for denying GLEP status include duplication of effort, being
127duplication of effort, being technically unsound, not providing proper 124technically unsound, not providing proper motivation or addressing backwards
128motivation or addressing backwards compatibility, or not in keeping 125compatibility, 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 126<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 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
132consensus from the community at large, and improve the GLEP for re-submission.</p> 128consensus 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 129<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 130gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and
… …
147mailing lists should be avoided. Strategies to keep the discussions efficient 143mailing lists should be avoided. Strategies to keep the discussions efficient
148include setting up a specific forums thread for the topic, having the GLEP 144include setting up a specific forums thread for the topic, having the GLEP
149author accept private comments in the early design phases, etc. GLEP authors 145author accept private comments in the early design phases, etc. GLEP authors
150should use their discretion here.</p> 146should use their discretion here.</p>
151<p>Once the authors have completed a GLEP, they must inform the GLEP editors that 147<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 Gentoo Linux Chief 148it is ready for review. GLEPs are reviewed by the appropriate Gentoo
153Architect or Development Manager, who may accept or reject a GLEP outright, or 149Manager <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 150send 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 151to be approvable (e.g., it is an obvious win as-is and/or its implementation
156has already been checked in) the Chief Architect or the Development Manager 152has 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 153may also initiate a GLEP review, first notifying the GLEP author(s) and giving
158them a chance to make revisions.</p> 154them a chance to make revisions.</p>
159<p>For a GLEP to be accepted it must meet certain minimum criteria. It must be a 155<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 156clear and complete description of the proposed enhancement. The enhancement
161must represent a net improvement. The proposed implementation, if applicable, 157must represent a net improvement. The proposed implementation, if applicable,
162must be solid and must not complicate the distribution unduly. Finally, a 158must be solid and must not complicate the distribution unduly. Finally, a
163proposed enhancement must satisfy the philosophy of Gentoo Linux.</p> 159proposed enhancement must satisfy the philosophy of Gentoo Linux.</p>
164<p>Once a GLEP has been accepted, the reference implementation must be completed. 160<p>Once a GLEP has been accepted, the reference implementation must be completed.
… …
180Deferred 176Deferred
181</pre> 177</pre>
182<p>Some Informational GLEPs may also have a status of &quot;Active&quot; if they are never 178<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> 179meant to be completed. E.g. GLEP 1 (this GLEP).</p>
184</div> 180</div>
185<div class="section" id="what-belongs-in-a-successful-glep"> 181<div class="section">
186<h1><a class="toc-backref" href="#id18" name="what-belongs-in-a-successful-glep">What belongs in a successful GLEP?</a></h1> 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>
187<p>Each GLEP should have the following parts:</p> 183<p>Each GLEP should have the following parts:</p>
188<ol class="arabic"> 184<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 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
190GLEP, including the GLEP number, a short descriptive title (limited 186GLEP, including the GLEP number, a short descriptive title (limited
191to a maximum of 44 characters), the names, and optionally the 187to a maximum of 44 characters), the names, and optionally the
… …
193</li> 189</li>
194<li><p class="first">Abstract -- a short (~200 word) description of the technical issue 190<li><p class="first">Abstract -- a short (~200 word) description of the technical issue
195being addressed.</p> 191being addressed.</p>
196</li> 192</li>
197<li><p class="first">Motivation -- The motivation is critical for GLEPs that want to 193<li><p class="first">Motivation -- The motivation is critical for GLEPs that want to
198change the Gentoo Linux functionality. It should clearly explain why the 194modify Gentoo Linux functionality. It should clearly explain why the
199existing functionality or policy is inadequate to address the problem that 195existing functionality or policy is inadequate to address the problem that
200the GLEP solves. GLEP submissions without sufficient motivation may be 196the GLEP solves. GLEP submissions without sufficient motivation may be
201rejected outright.</p> 197rejected outright.</p>
202</li> 198</li>
203<li><p class="first">Specification -- The technical specification should describe the 199<li><p class="first">Specification -- The technical specification should describe the
… …
210were made. It should describe alternate designs that were considered and 206were made. It should describe alternate designs that were considered and
211related work, e.g. how the feature is supported in other distributions.</p> 207related 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 208<p>The rationale should provide evidence of consensus within the community and
213discuss important objections or concerns raised during discussion.</p> 209discuss important objections or concerns raised during discussion.</p>
214</li> 210</li>
215<li><p class="first">Backwards Compatibility -- All GLEPs 211<li><p class="first">Backwards Compatibility -- All GLEPs
216must include a section describing any issues of backwards incompatibilities 212must include a section describing any issues of backwards incompatibilities
217and their severity. The GLEP must explain how the author proposes to deal 213and their severity. The GLEP must explain how the author proposes to deal
218with these incompatibilities. (Even if there are none, this section should 214with these incompatibilities. (Even if there are none, this section should
219be included to clearly state that fact.) GLEP submissions without a 215be included to clearly state that fact.) GLEP submissions without a
220sufficient backwards compatibility treatise may be rejected outright.</p> 216sufficient backwards compatibility treatise may be rejected outright.</p>
… …
229labelled as placed in the public domain (see this GLEP as an example) or 225labelled as placed in the public domain (see this GLEP as an example) or
230licensed under the Open Publication License [#OPL].</p> 226licensed under the Open Publication License [#OPL].</p>
231</li> 227</li>
232</ol> 228</ol>
233</div> 229</div>
234<div class="section" id="glep-formating-and-template"> 230<div class="section">
235<h1><a class="toc-backref" href="#id19" name="glep-formating-and-template">GLEP Formating and Template</a></h1> 231<h1><a class="toc-backref" href="#id22" id="glep-formating-and-template" name="glep-formating-and-template">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
236<p>GLEPs are written in a just-barely-marked-up version of plain ASCII text 233a just-barely-marked-up version of plain ASCII text
237called ReStructuredText <a class="footnote-reference" href="#resthome" id="id8" name="id8">[9]</a> that is then converted to HTML using 234called ReStructuredText <a class="footnote-reference" href="#resthome" id="id11" name="id11">[10]</a> that is then converted to HTML using
238Docutils <a class="footnote-reference" href="#docutils" id="id9" name="id9">[11]</a>. Using ReStructuredText GLEPs allows for rich markup 235Docutils <a class="footnote-reference" href="#docutils" id="id12" name="id12">[12]</a>. Using ReStructuredText GLEPs allows for rich markup
239that is still quite easy to read, but results in much better-looking and more 236that is still quite easy to read, but results in much better-looking and more
240functional HTML. Moreover, it should be straightforward to convert GLEPs to 237functional HTML. Moreover, it should be straightforward to convert GLEPs to
241Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id10" name="id10">[10]</a> if needed. GLEP 2 contains a boilerplate 238Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id13" name="id13">[11]</a> if needed. GLEP 2 contains a boilerplate
242template <a class="footnote-reference" href="#rest" id="id11" name="id11">[5]</a> for use with ReStructuredText GLEPs.</p> 239template <a class="footnote-reference" href="#rest" id="id14" name="id14">[5]</a> for use with ReStructuredText GLEPs.</p>
243</div> 240</div>
244<div class="section" id="glep-header-preamble"> 241<div class="section">
245<h1><a class="toc-backref" href="#id20" name="glep-header-preamble">GLEP Header Preamble</a></h1> 242<h1><a class="toc-backref" href="#id23" id="glep-header-preamble" name="glep-header-preamble">GLEP Header Preamble</a></h1>
246<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 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
247must appear in the following order. Headers marked with &quot;*&quot; are 244must appear in the following order. Headers marked with &quot;*&quot; are
248optional and are described below. All other headers are required.</p> 245optional and are described below. All other headers are required.</p>
249<pre class="literal-block"> 246<pre class="literal-block">
250 GLEP: &lt;glep number&gt; 247 GLEP: &lt;glep number&gt;
… …
282GLEP is being discussed privately with the author, or on the gentoo-dev 279GLEP is being discussed privately with the author, or on the gentoo-dev
283mailing list. Note that email addresses in the Discussions-To header will not 280mailing list. Note that email addresses in the Discussions-To header will not
284be obscured.</p> 281be obscured.</p>
285<p>The Type header specifies the type of GLEP: Informational or Standards 282<p>The Type header specifies the type of GLEP: Informational or Standards
286Track.</p> 283Track.</p>
287<p>The format of a GLEP is specified with a Content-Type header, which for now 284<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
288should always read &quot;text/x-rst&quot; for ReStructuredText GLEPs (see GLEP 2 286&quot;text/x-rst&quot; for ReStructuredText GLEPs (see GLEP 2
289<a class="footnote-reference" href="#rest" id="id12" name="id12">[5]</a>).</p> 287<a class="footnote-reference" href="#rest" id="id15" name="id15">[5]</a>).</p>
290<p>The Created header records the date that the GLEP was assigned a number, while 288<p>The Created header records the date that the GLEP was assigned a number, while
291Post-History is used to record the dates of when new versions of the GLEP are 289Post-History is used to record the dates of when new versions of the GLEP are
292posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. 290posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g.
29314-Aug-2001.</p> 29114-Aug-2001.</p>
294<p>GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP 292<p>GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP
… …
296<p>GLEPs may also have a Replaced-By header indicating that a GLEP has been 294<p>GLEPs may also have a Replaced-By header indicating that a GLEP has been
297rendered obsolete by a later document; the value is the number of the GLEP 295rendered obsolete by a later document; the value is the number of the GLEP
298that replaces the current document. The newer GLEP must have a Replaces 296that replaces the current document. The newer GLEP must have a Replaces
299header containing the number of the GLEP that it rendered obsolete.</p> 297header containing the number of the GLEP that it rendered obsolete.</p>
300</div> 298</div>
301<div class="section" id="reporting-glep-bugs-or-submitting-glep-updates"> 299<div class="section">
302<h1><a class="toc-backref" href="#id21" name="reporting-glep-bugs-or-submitting-glep-updates">Reporting GLEP Bugs, or Submitting GLEP Updates</a></h1> 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>
303<p>How you report a bug, or submit a GLEP update depends on several factors, such 301<p>How you report a bug, or submit a GLEP update depends on several factors, such
304as the maturity of the GLEP, the preferences of the GLEP author, and the 302as the maturity of the GLEP, the preferences of the GLEP author, and the
305nature of your comments. For the early draft stages of the GLEP, it's 303nature of your comments. For the early draft stages of the GLEP, it's
306probably best to send your comments and changes directly to the GLEP author. 304probably best to send your comments and changes directly to the GLEP author.
307For more mature, or finished GLEPs you may want to submit corrections to the 305For more mature, or finished GLEPs you may want to submit corrections to the
308Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id13" name="id13">[6]</a> so that your changes don't get lost. If the GLEP 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
309author is a Gentoo Linux developer, assign the bug/patch to him, otherwise 307author is a Gentoo Linux developer, assign the bug/patch to him, otherwise
310assign it to the GLEP editors.</p> 308assign it to the GLEP editors.</p>
311<p>When in doubt about where to send your changes, please check first with the 309<p>When in doubt about where to send your changes, please check first with the
312GLEP author and/or GLEP editors.</p> 310GLEP author and/or GLEP editors.</p>
313<p>GLEP authors who are also Gentoo Linux developers can update the GLEPs 311<p>GLEP authors who are also Gentoo Linux developers can update the GLEPs
314themselves by using &quot;cvs commit&quot; to commit their changes.</p> 312themselves by using &quot;cvs commit&quot; to commit their changes.</p>
315</div> 313</div>
316<div class="section" id="transferring-glep-ownership"> 314<div class="section">
317<h1><a class="toc-backref" href="#id22" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1> 315<h1><a class="toc-backref" href="#id25" id="transferring-glep-ownership" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1>
318<p>It occasionally becomes necessary to transfer ownership of GLEPs to a new 316<p>It occasionally becomes necessary to transfer ownership of GLEPs to a new
319champion. In general, we'd like to retain the original author as a co-author 317champion. In general, we'd like to retain the original author as a co-author
320of the transferred GLEP, but that's really up to the original author. A good 318of the transferred GLEP, but that's really up to the original author. A good
321reason to transfer ownership is because the original author no longer has the 319reason to transfer ownership is because the original author no longer has the
322time or interest in updating it or following through with the GLEP process, or 320time or interest in updating it or following through with the GLEP process, or
… …
328to take over, addressed to both the original author and the GLEP editors 326to take over, addressed to both the original author and the GLEP editors
329&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 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
330timely manner, the GLEP editors will make a unilateral decision (it's not like 328timely manner, the GLEP editors will make a unilateral decision (it's not like
331such decisions can't be reversed :).</p> 329such decisions can't be reversed :).</p>
332</div> 330</div>
333<div class="section" id="references-and-footnotes"> 331<div class="section">
334<h1><a class="toc-backref" href="#id23" name="references-and-footnotes">References and Footnotes</a></h1> 332<h1><a class="toc-backref" href="#id26" id="references-and-footnotes" name="references-and-footnotes">References and Footnotes</a></h1>
335<table class="footnote" frame="void" id="python" rules="none"> 333<table class="docutils footnote" frame="void" id="python" rules="none">
336<colgroup><col class="label" /><col /></colgroup> 334<colgroup><col class="label" /><col /></colgroup>
337<tbody valign="top"> 335<tbody valign="top">
338<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> 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>
339</tbody> 337</tbody>
340</table> 338</table>
341<table class="footnote" frame="void" id="peps" rules="none"> 339<table class="docutils footnote" frame="void" id="peps" rules="none">
342<colgroup><col class="label" /><col /></colgroup> 340<colgroup><col class="label" /><col /></colgroup>
343<tbody valign="top"> 341<tbody valign="top">
344<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> 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>
345</tbody> 343</tbody>
346</table> 344</table>
347<table class="footnote" frame="void" id="pep1" rules="none"> 345<table class="docutils footnote" frame="void" id="pep1" rules="none">
348<colgroup><col class="label" /><col /></colgroup> 346<colgroup><col class="label" /><col /></colgroup>
349<tbody valign="top"> 347<tbody valign="top">
350<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> 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>
351</tbody> 349</tbody>
352</table> 350</table>
353<table class="footnote" frame="void" id="cvs" rules="none"> 351<table class="docutils footnote" frame="void" id="cvs" rules="none">
354<colgroup><col class="label" /><col /></colgroup> 352<colgroup><col class="label" /><col /></colgroup>
355<tbody valign="top"> 353<tbody valign="top">
356<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 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
357for retrieving older revisions. For those without direct access to the CVS 355for retrieving older revisions. For those without direct access to the CVS
358tree, you can browse the current and past GLEP revisions via the Gentoo 356tree, you can browse the current and past GLEP revisions via the Gentoo
359Linux viewcvs web site at 357Linux viewcvs web site at
360<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> 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>
361</tbody> 359</tbody>
362</table> 360</table>
363<table class="footnote" frame="void" id="rest" rules="none"> 361<table class="docutils footnote" frame="void" id="rest" rules="none">
364<colgroup><col class="label" /><col /></colgroup> 362<colgroup><col class="label" /><col /></colgroup>
365<tbody valign="top"> 363<tbody valign="top">
366<tr><td class="label"><a name="rest">[5]</a></td><td><em>(<a class="fn-backref" href="#id11">1</a>, <a class="fn-backref" href="#id12">2</a>)</em> GLEP 2, Sample ReStructuredText GLEP Template, 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,
367(<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr> 365(<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr>
368</tbody> 366</tbody>
369</table> 367</table>
370<table class="footnote" frame="void" id="bugs" rules="none"> 368<table class="docutils footnote" frame="void" id="bugs" rules="none">
371<colgroup><col class="label" /><col /></colgroup> 369<colgroup><col class="label" /><col /></colgroup>
372<tbody valign="top"> 370<tbody valign="top">
373<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="#id13">2</a>)</em> <a class="reference" href="http://bugs.gentoo.org">http://bugs.gentoo.org</a></td></tr> 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>
374</tbody> 372</tbody>
375</table> 373</table>
376<table class="footnote" frame="void" id="forums" rules="none"> 374<table class="docutils footnote" frame="void" id="forums" rules="none">
377<colgroup><col class="label" /><col /></colgroup> 375<colgroup><col class="label" /><col /></colgroup>
378<tbody valign="top"> 376<tbody valign="top">
379<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> 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>
380</tbody> 378</tbody>
381</table> 379</table>
380<table class="docutils footnote" frame="void" id="manager" rules="none">
381<colgroup><col class="label" /><col /></colgroup>
382<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>
384</tbody>
385</table>
382<table class="footnote" frame="void" id="opl" rules="none"> 386<table class="docutils footnote" frame="void" id="opl" rules="none">
383<colgroup><col class="label" /><col /></colgroup> 387<colgroup><col class="label" /><col /></colgroup>
384<tbody valign="top"> 388<tbody valign="top">
385<tr><td class="label"><a name="opl">[8]</a></td><td><a class="reference" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr> 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>
386</tbody> 390</tbody>
387</table> 391</table>
388<table class="footnote" frame="void" id="resthome" rules="none"> 392<table class="docutils footnote" frame="void" id="resthome" rules="none">
389<colgroup><col class="label" /><col /></colgroup> 393<colgroup><col class="label" /><col /></colgroup>
390<tbody valign="top"> 394<tbody valign="top">
391<tr><td class="label"><a class="fn-backref" href="#id8" name="resthome">[9]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr> 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>
392</tbody> 396</tbody>
393</table> 397</table>
394<table class="footnote" frame="void" id="guidexml" rules="none"> 398<table class="docutils footnote" frame="void" id="guidexml" rules="none">
395<colgroup><col class="label" /><col /></colgroup> 399<colgroup><col class="label" /><col /></colgroup>
396<tbody valign="top"> 400<tbody valign="top">
397<tr><td class="label"><a class="fn-backref" href="#id10" name="guidexml">[10]</a></td><td><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> 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>
398</tbody> 402</tbody>
399</table> 403</table>
400<table class="footnote" frame="void" id="docutils" rules="none"> 404<table class="docutils footnote" frame="void" id="docutils" rules="none">
401<colgroup><col class="label" /><col /></colgroup> 405<colgroup><col class="label" /><col /></colgroup>
402<tbody valign="top"> 406<tbody valign="top">
403<tr><td class="label"><a class="fn-backref" href="#id9" name="docutils">[11]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr> 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>
404</tbody> 408</tbody>
405</table> 409</table>
406</div> 410</div>
407<div class="section" id="copyright"> 411<div class="section">
408<h1><a class="toc-backref" href="#id24" name="copyright">Copyright</a></h1> 412<h1><a class="toc-backref" href="#id27" id="copyright" name="copyright">Copyright</a></h1>
409<p>This document has been placed in the public domain.</p> 413<p>This document has been placed in the public domain.</p>
410</div> 414</div>
411</div>
412 415
413<hr class="footer"/> 416</div>
414<div class="footer"> 417<div class="footer">
418<hr class="footer" />
415<a class="reference" href="glep-0001.txt">View document source</a>. 419<a class="reference" href="glep-0001.txt">View document source</a>.
416Generated on: 2003-06-04 19:48 UTC. 420Generated on: 2008-01-20 02:56 UTC.
417Generated 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. 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.
422
418</div> 423</div>
419</body> 424</body>
420</html> 425</html>
421 426
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.12
  ViewVC Help
Powered by ViewVC 1.1.13