| 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 | |
| 5 | This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new |
|
|
| 6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
|
|
| 7 | to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
|
|
| 8 | --> |
|
|
| 9 | <head> |
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.3.0: 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.6</td> |
31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.12</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/07/17 14:26:18</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/06/05 06:05:32</a></td> |
| 39 | </tr> |
34 | </tr> |
| 40 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear <g2boojum at gentoo.org></td> |
35 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear <g2boojum at gentoo.org></td> |
| 41 | </tr> |
36 | </tr> |
| 42 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td> |
37 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td> |
| 43 | </tr> |
38 | </tr> |
| … | |
… | |
| 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">1-Jun-2003, 2-Jul-2003</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, 05-Jun-2008</td> |
| 51 | </tr> |
46 | </tr> |
| 52 | </tbody> |
47 | </tbody> |
| 53 | </table> |
48 | </table> |
| 54 | <hr /> |
49 | <hr /> |
| 55 | <div class="contents topic" id="contents"> |
50 | <div class="contents topic"> |
| 56 | <p class="topic-title"><a name="contents">Contents</a></p> |
51 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
| 57 | <ul class="simple"> |
52 | <ul class="simple"> |
| 58 | <li><a class="reference" href="#credits" id="id17" name="id17">Credits</a></li> |
53 | <li><a class="reference" href="#credits" id="id17" name="id17">Credits</a></li> |
| 59 | <li><a class="reference" href="#what-is-a-glep" id="id18" name="id18">What is a GLEP?</a></li> |
54 | <li><a class="reference" href="#what-is-a-glep" id="id18" name="id18">What is a GLEP?</a></li> |
| 60 | <li><a class="reference" href="#kinds-of-gleps" id="id19" name="id19">Kinds of GLEPs</a></li> |
55 | <li><a class="reference" href="#kinds-of-gleps" id="id19" name="id19">Kinds of GLEPs</a></li> |
| 61 | <li><a class="reference" href="#glep-work-flow" id="id20" name="id20">GLEP Work Flow</a></li> |
56 | <li><a class="reference" href="#glep-work-flow" id="id20" name="id20">GLEP Work Flow</a></li> |
| … | |
… | |
| 66 | <li><a class="reference" href="#transferring-glep-ownership" id="id25" name="id25">Transferring GLEP Ownership</a></li> |
61 | <li><a class="reference" href="#transferring-glep-ownership" id="id25" name="id25">Transferring GLEP Ownership</a></li> |
| 67 | <li><a class="reference" href="#references-and-footnotes" id="id26" name="id26">References and Footnotes</a></li> |
62 | <li><a class="reference" href="#references-and-footnotes" id="id26" name="id26">References and Footnotes</a></li> |
| 68 | <li><a class="reference" href="#copyright" id="id27" name="id27">Copyright</a></li> |
63 | <li><a class="reference" href="#copyright" id="id27" name="id27">Copyright</a></li> |
| 69 | </ul> |
64 | </ul> |
| 70 | </div> |
65 | </div> |
| 71 | <div class="section" id="credits"> |
66 | <div class="section"> |
| 72 | <h1><a class="toc-backref" href="#id17" name="credits">Credits</a></h1> |
67 | <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, |
68 | <p>The GLEP concept, and, in fact, much of the text of this document, |
| 74 | is liberally stolen from Python's <a class="footnote-reference" href="#python" id="id1" name="id1">[1]</a> PEPs |
69 | is 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 |
70 | <a class="footnote-reference" href="#peps" id="id2" name="id2">[2]</a>, especially |
| 76 | PEP-0001 <a class="footnote-reference" href="#pep1" id="id3" name="id3">[3]</a> by Barry A. Warsaw, Jeremy Hylton, and David Goodger.</p> |
71 | PEP-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> |
72 | </div> |
| 78 | <div class="section" id="what-is-a-glep"> |
73 | <div class="section"> |
| 79 | <h1><a class="toc-backref" href="#id18" name="what-is-a-glep">What is a GLEP?</a></h1> |
74 | <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 "Gentoo Linux Enhancement Proposal". A GLEP is a design |
75 | <p>GLEP stands for "Gentoo Linux Enhancement Proposal". A GLEP is a design |
| 81 | document providing information to the Gentoo Linux community, or describing |
76 | document providing information to the Gentoo Linux community, or describing |
| 82 | a new feature for Gentoo Linux. The GLEP should provide a concise technical |
77 | a new feature for Gentoo Linux. The GLEP should provide a concise technical |
| 83 | specification of the feature and rationale for the feature.</p> |
78 | specification 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 |
79 | <p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new |
| … | |
… | |
| 88 | documenting dissenting opinions.</p> |
83 | documenting dissenting opinions.</p> |
| 89 | <p>Because the GLEPs are maintained as text files under CVS control, their |
84 | <p>Because the GLEPs are maintained as text files under CVS control, their |
| 90 | revision history is the historical record of the feature proposal |
85 | revision history is the historical record of the feature proposal |
| 91 | <a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p> |
86 | <a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p> |
| 92 | </div> |
87 | </div> |
| 93 | <div class="section" id="kinds-of-gleps"> |
88 | <div class="section"> |
| 94 | <h1><a class="toc-backref" href="#id19" name="kinds-of-gleps">Kinds of GLEPs</a></h1> |
89 | <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 |
90 | <p>There are two kinds of GLEPs. A Standards Track GLEP describes a new feature |
| 96 | or implementation for Gentoo Linux. An Informational GLEP describes provides |
91 | or implementation for Gentoo Linux. An Informational GLEP describes provides |
| 97 | general guidelines or information to the Gentoo Linux community, but does not |
92 | general guidelines or information to the Gentoo Linux community, but does not |
| 98 | propose a new feature. Informational GLEPs do not necessarily represent a |
93 | propose a new feature. Informational GLEPs do not necessarily represent a |
| 99 | Gentoo Linux community consensus or recommendation, so users and implementors |
94 | Gentoo Linux community consensus or recommendation, so users and implementors |
| 100 | are free to ignore Informational GLEPs or follow their advice.</p> |
95 | are free to ignore Informational GLEPs or follow their advice.</p> |
| 101 | </div> |
96 | </div> |
| 102 | <div class="section" id="glep-work-flow"> |
97 | <div class="section"> |
| 103 | <h1><a class="toc-backref" href="#id20" name="glep-work-flow">GLEP Work Flow</a></h1> |
98 | <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 |
99 | <p>The GLEP editors assign GLEP numbers and change their status. The current |
| 105 | GLEP editors are Grant Goodyear and Alastair Tse. Please send all |
100 | GLEP editors are Grant Goodyear and Alastair Tse. Please send all |
| 106 | GLEP-related email to <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>.</p> |
101 | GLEP-related email to <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>.</p> |
| 107 | <p>The GLEP process begins with a new idea for Gentoo Linux. It is highly |
102 | <p>The GLEP process begins with a new idea for Gentoo Linux. It is highly |
| 108 | recommended that a single GLEP contain a single key proposal or new idea. The |
103 | recommended that a single GLEP contain a single key proposal or new idea. The |
| … | |
… | |
| 117 | injected into the Gentoo Linux development work flow with an enhancement "bug" |
112 | injected into the Gentoo Linux development work flow with an enhancement "bug" |
| 118 | submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5" name="id5">[6]</a>.</p> |
113 | submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5" name="id5">[6]</a>.</p> |
| 119 | <p>The GLEP champion then emails the GLEP editors <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>> with a |
114 | <p>The GLEP champion then emails the GLEP editors <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>> with a |
| 120 | proposed title and a rough, but fleshed out, draft of the GLEP. This draft |
115 | proposed title and a rough, but fleshed out, draft of the GLEP. This draft |
| 121 | must be written in GLEP style as described below.</p> |
116 | must 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 |
117 | <p>If the GLEP editor accepts the GLEP, he will assign the GLEP a number, label |
| 123 | as Standards Track (a better name would be nice here -- suggestions?) |
118 | it as Standards Track (a better name would be nice here -- suggestions?) or |
| 124 | or Informational, give it status "Draft", and |
119 | Informational, give it status "Draft", and create and check-in the initial |
| 125 | create and check-in the initial draft of the GLEP. The GLEP editors will |
120 | draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP. |
| 126 | not unreasonably deny a GLEP. Reasons for denying GLEP status include |
121 | Reasons for denying GLEP status include duplication of effort, being |
| 127 | duplication of effort, being technically unsound, not providing proper |
122 | technically unsound, not providing proper motivation or addressing backwards |
| 128 | motivation or addressing backwards compatibility, or not in keeping |
123 | compatibility, or not in keeping with Gentoo Linux philosophy.</p> |
| 129 | with Gentoo Linux philosophy.</p> |
|
|
| 130 | <p>If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the |
124 | <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@gentoo.org">gentoo-dev@gentoo.org</a> mailing list to help flesh it out, gain feedback and |
125 | <a class="reference" href="mailto:gentoo-dev@gentoo.org">gentoo-dev@gentoo.org</a> mailing list to help flesh it out, gain feedback and |
| 132 | consensus from the community at large, and improve the GLEP for re-submission.</p> |
126 | consensus 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 |
127 | <p>The author of the GLEP is then responsible for posting the GLEP to the |
| 134 | gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and |
128 | gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and |
| … | |
… | |
| 148 | include setting up a specific forums thread for the topic, having the GLEP |
142 | include setting up a specific forums thread for the topic, having the GLEP |
| 149 | author accept private comments in the early design phases, etc. GLEP authors |
143 | author accept private comments in the early design phases, etc. GLEP authors |
| 150 | should use their discretion here.</p> |
144 | should use their discretion here.</p> |
| 151 | <p>Once the authors have completed a GLEP, they must inform the GLEP editors that |
145 | <p>Once the authors have completed a GLEP, they must inform the GLEP editors that |
| 152 | it is ready for review. GLEPs are reviewed by the appropriate Gentoo |
146 | it is ready for review. GLEPs are reviewed by the appropriate Gentoo |
| 153 | Manager <a class="footnote-reference" href="#manager" id="id8" name="id8">[8]</a>, who may accept or reject a GLEP outright, or |
147 | Manager <a class="footnote-reference" href="#manager" id="id8" name="id8">[8]</a>, who may approve or reject a GLEP outright, or |
| 154 | send it back to the author(s) for revision. For a GLEP that is pre-determined |
148 | send it back to the author(s) for revision. For a GLEP that is pre-determined |
| 155 | to be acceptable (e.g., it is an obvious win as-is and/or its implementation |
149 | to be approvable (e.g., it is an obvious win as-is and/or its implementation |
| 156 | has already been checked in) the appropriate Gentoo Manager <a class="footnote-reference" href="#manager" id="id9" name="id9">[8]</a> |
150 | has already been checked in) the appropriate Gentoo Manager <a class="footnote-reference" href="#manager" id="id9" name="id9">[8]</a> |
| 157 | may also initiate a GLEP review, first notifying the GLEP author(s) and giving |
151 | may also initiate a GLEP review, first notifying the GLEP author(s) and giving |
| 158 | them a chance to make revisions.</p> |
152 | them a chance to make revisions.</p> |
| 159 | <p>For a GLEP to be accepted it must meet certain minimum criteria. It must be a |
153 | <p>For a GLEP to be approved it must meet certain minimum criteria. It must be a |
| 160 | clear and complete description of the proposed enhancement. The enhancement |
154 | clear and complete description of the proposed enhancement. The enhancement |
| 161 | must represent a net improvement. The proposed implementation, if applicable, |
155 | must represent a net improvement. The proposed implementation, if applicable, |
| 162 | must be solid and must not complicate the distribution unduly. Finally, a |
156 | must be solid and must not complicate the distribution unduly. Finally, a |
| 163 | proposed enhancement must satisfy the philosophy of Gentoo Linux.</p> |
157 | proposed enhancement must satisfy the philosophy of Gentoo Linux.</p> |
| 164 | <p>Once a GLEP has been accepted, the reference implementation must be completed. |
158 | <p>Once a GLEP has been accepted, the reference implementation must be completed. |
| … | |
… | |
| 180 | Deferred |
174 | Deferred |
| 181 | </pre> |
175 | </pre> |
| 182 | <p>Some Informational GLEPs may also have a status of "Active" if they are never |
176 | <p>Some Informational GLEPs may also have a status of "Active" if they are never |
| 183 | meant to be completed. E.g. GLEP 1 (this GLEP).</p> |
177 | meant to be completed. E.g. GLEP 1 (this GLEP).</p> |
| 184 | </div> |
178 | </div> |
| 185 | <div class="section" id="what-belongs-in-a-successful-glep"> |
179 | <div class="section"> |
| 186 | <h1><a class="toc-backref" href="#id21" name="what-belongs-in-a-successful-glep">What belongs in a successful GLEP?</a></h1> |
180 | <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> |
181 | <p>Each GLEP should have the following parts:</p> |
| 188 | <ol class="arabic"> |
182 | <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 |
183 | <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 |
| 190 | GLEP, including the GLEP number, a short descriptive title (limited |
184 | GLEP, including the GLEP number, a short descriptive title (limited |
| 191 | to a maximum of 44 characters), the names, and optionally the |
185 | to a maximum of 44 characters), the names, and optionally the |
| … | |
… | |
| 210 | were made. It should describe alternate designs that were considered and |
204 | were made. It should describe alternate designs that were considered and |
| 211 | related work, e.g. how the feature is supported in other distributions.</p> |
205 | related 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 |
206 | <p>The rationale should provide evidence of consensus within the community and |
| 213 | discuss important objections or concerns raised during discussion.</p> |
207 | discuss important objections or concerns raised during discussion.</p> |
| 214 | </li> |
208 | </li> |
| 215 | <li><p class="first">Backwards Compatibility -- All GLEPs |
209 | <li><p class="first">Backwards Compatibility -- All GLEPs |
| 216 | must include a section describing any issues of backwards incompatibilities |
210 | must include a section describing any issues of backwards incompatibilities |
| 217 | and their severity. The GLEP must explain how the author proposes to deal |
211 | and their severity. The GLEP must explain how the author proposes to deal |
| 218 | with these incompatibilities. (Even if there are none, this section should |
212 | with these incompatibilities. (Even if there are none, this section should |
| 219 | be included to clearly state that fact.) GLEP submissions without a |
213 | be included to clearly state that fact.) GLEP submissions without a |
| 220 | sufficient backwards compatibility treatise may be rejected outright.</p> |
214 | sufficient backwards compatibility treatise may be rejected outright.</p> |
| … | |
… | |
| 229 | labelled as placed in the public domain (see this GLEP as an example) or |
223 | labelled as placed in the public domain (see this GLEP as an example) or |
| 230 | licensed under the Open Publication License [#OPL].</p> |
224 | licensed under the Open Publication License [#OPL].</p> |
| 231 | </li> |
225 | </li> |
| 232 | </ol> |
226 | </ol> |
| 233 | </div> |
227 | </div> |
| 234 | <div class="section" id="glep-formating-and-template"> |
228 | <div class="section"> |
| 235 | <h1><a class="toc-backref" href="#id22" name="glep-formating-and-template">GLEP Formating and Template</a></h1> |
229 | <h1><a class="toc-backref" href="#id22" id="glep-formating-and-template" name="glep-formating-and-template">GLEP Formating and Template</a></h1> |
| 236 | <p>GLEPs are written either in Gentoo Linux Guide-XML <a class="footnote-reference" href="#guidexml" id="id10" name="id10">[11]</a> or in |
230 | <p>GLEPs are written either in Gentoo Linux Guide-XML <a class="footnote-reference" href="#guidexml" id="id10" name="id10">[11]</a> or in |
| 237 | a just-barely-marked-up version of plain ASCII text |
231 | a just-barely-marked-up version of plain ASCII text |
| 238 | called ReStructuredText <a class="footnote-reference" href="#resthome" id="id11" name="id11">[10]</a> that is then converted to HTML using |
232 | called ReStructuredText <a class="footnote-reference" href="#resthome" id="id11" name="id11">[10]</a> that is then converted to HTML using |
| 239 | Docutils <a class="footnote-reference" href="#docutils" id="id12" name="id12">[12]</a>. Using ReStructuredText GLEPs allows for rich markup |
233 | Docutils <a class="footnote-reference" href="#docutils" id="id12" name="id12">[12]</a>. Using ReStructuredText GLEPs allows for rich markup |
| 240 | that is still quite easy to read, but results in much better-looking and more |
234 | that is still quite easy to read, but results in much better-looking and more |
| 241 | functional HTML. Moreover, it should be straightforward to convert GLEPs to |
235 | functional HTML. Moreover, it should be straightforward to convert GLEPs to |
| 242 | Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id13" name="id13">[11]</a> if needed. GLEP 2 contains a boilerplate |
236 | Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id13" name="id13">[11]</a> if needed. GLEP 2 contains a boilerplate |
| 243 | template <a class="footnote-reference" href="#rest" id="id14" name="id14">[5]</a> for use with ReStructuredText GLEPs.</p> |
237 | template <a class="footnote-reference" href="#rest" id="id14" name="id14">[5]</a> for use with ReStructuredText GLEPs.</p> |
| 244 | </div> |
238 | </div> |
| 245 | <div class="section" id="glep-header-preamble"> |
239 | <div class="section"> |
| 246 | <h1><a class="toc-backref" href="#id23" name="glep-header-preamble">GLEP Header Preamble</a></h1> |
240 | <h1><a class="toc-backref" href="#id23" id="glep-header-preamble" name="glep-header-preamble">GLEP Header Preamble</a></h1> |
| 247 | <p>Each GLEP must begin with an <a class="reference" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> style header preamble. The headers |
241 | <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 |
| 248 | must appear in the following order. Headers marked with "*" are |
242 | must appear in the following order. Headers marked with "*" are |
| 249 | optional and are described below. All other headers are required.</p> |
243 | optional and are described below. All other headers are required.</p> |
| 250 | <pre class="literal-block"> |
244 | <pre class="literal-block"> |
| 251 | GLEP: <glep number> |
245 | GLEP: <glep number> |
| … | |
… | |
| 283 | GLEP is being discussed privately with the author, or on the gentoo-dev |
277 | GLEP is being discussed privately with the author, or on the gentoo-dev |
| 284 | mailing list. Note that email addresses in the Discussions-To header will not |
278 | mailing list. Note that email addresses in the Discussions-To header will not |
| 285 | be obscured.</p> |
279 | be obscured.</p> |
| 286 | <p>The Type header specifies the type of GLEP: Informational or Standards |
280 | <p>The Type header specifies the type of GLEP: Informational or Standards |
| 287 | Track.</p> |
281 | Track.</p> |
| 288 | <p>The format of a GLEP is specified with a Content-Type header, which |
282 | <p>The format of a GLEP is specified with a Content-Type header, which |
| 289 | should read "text/xml" for Gentoo Guide XML or |
283 | should read "text/xml" for Gentoo Guide XML or |
| 290 | "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 |
284 | "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 |
| 291 | <a class="footnote-reference" href="#rest" id="id15" name="id15">[5]</a>).</p> |
285 | <a class="footnote-reference" href="#rest" id="id15" name="id15">[5]</a>).</p> |
| 292 | <p>The Created header records the date that the GLEP was assigned a number, while |
286 | <p>The Created header records the date that the GLEP was assigned a number, while |
| 293 | Post-History is used to record the dates of when new versions of the GLEP are |
287 | Post-History is used to record the dates of when new versions of the GLEP are |
| 294 | posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. |
288 | posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. |
| … | |
… | |
| 298 | <p>GLEPs may also have a Replaced-By header indicating that a GLEP has been |
292 | <p>GLEPs may also have a Replaced-By header indicating that a GLEP has been |
| 299 | rendered obsolete by a later document; the value is the number of the GLEP |
293 | rendered obsolete by a later document; the value is the number of the GLEP |
| 300 | that replaces the current document. The newer GLEP must have a Replaces |
294 | that replaces the current document. The newer GLEP must have a Replaces |
| 301 | header containing the number of the GLEP that it rendered obsolete.</p> |
295 | header containing the number of the GLEP that it rendered obsolete.</p> |
| 302 | </div> |
296 | </div> |
| 303 | <div class="section" id="reporting-glep-bugs-or-submitting-glep-updates"> |
297 | <div class="section"> |
| 304 | <h1><a class="toc-backref" href="#id24" name="reporting-glep-bugs-or-submitting-glep-updates">Reporting GLEP Bugs, or Submitting GLEP Updates</a></h1> |
298 | <h1><a class="toc-backref" href="#id24" id="reporting-glep-bugs-or-submitting-glep-updates" name="reporting-glep-bugs-or-submitting-glep-updates">Reporting GLEP Bugs, or Submitting GLEP Updates</a></h1> |
| 305 | <p>How you report a bug, or submit a GLEP update depends on several factors, such |
299 | <p>How you report a bug, or submit a GLEP update depends on several factors, such |
| 306 | as the maturity of the GLEP, the preferences of the GLEP author, and the |
300 | as the maturity of the GLEP, the preferences of the GLEP author, and the |
| 307 | nature of your comments. For the early draft stages of the GLEP, it's |
301 | nature of your comments. For the early draft stages of the GLEP, it's |
| 308 | probably best to send your comments and changes directly to the GLEP author. |
302 | probably best to send your comments and changes directly to the GLEP author. |
| 309 | For more mature, or finished GLEPs you may want to submit corrections to the |
303 | For more mature, or finished GLEPs you may want to submit corrections to the |
| … | |
… | |
| 313 | <p>When in doubt about where to send your changes, please check first with the |
307 | <p>When in doubt about where to send your changes, please check first with the |
| 314 | GLEP author and/or GLEP editors.</p> |
308 | GLEP author and/or GLEP editors.</p> |
| 315 | <p>GLEP authors who are also Gentoo Linux developers can update the GLEPs |
309 | <p>GLEP authors who are also Gentoo Linux developers can update the GLEPs |
| 316 | themselves by using "cvs commit" to commit their changes.</p> |
310 | themselves by using "cvs commit" to commit their changes.</p> |
| 317 | </div> |
311 | </div> |
| 318 | <div class="section" id="transferring-glep-ownership"> |
312 | <div class="section"> |
| 319 | <h1><a class="toc-backref" href="#id25" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1> |
313 | <h1><a class="toc-backref" href="#id25" id="transferring-glep-ownership" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1> |
| 320 | <p>It occasionally becomes necessary to transfer ownership of GLEPs to a new |
314 | <p>It occasionally becomes necessary to transfer ownership of GLEPs to a new |
| 321 | champion. In general, we'd like to retain the original author as a co-author |
315 | champion. In general, we'd like to retain the original author as a co-author |
| 322 | of the transferred GLEP, but that's really up to the original author. A good |
316 | of the transferred GLEP, but that's really up to the original author. A good |
| 323 | reason to transfer ownership is because the original author no longer has the |
317 | reason to transfer ownership is because the original author no longer has the |
| 324 | time or interest in updating it or following through with the GLEP process, or |
318 | time or interest in updating it or following through with the GLEP process, or |
| … | |
… | |
| 330 | to take over, addressed to both the original author and the GLEP editors |
324 | to take over, addressed to both the original author and the GLEP editors |
| 331 | <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>. If the original author doesn't respond to email in a |
325 | <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>. If the original author doesn't respond to email in a |
| 332 | timely manner, the GLEP editors will make a unilateral decision (it's not like |
326 | timely manner, the GLEP editors will make a unilateral decision (it's not like |
| 333 | such decisions can't be reversed :).</p> |
327 | such decisions can't be reversed :).</p> |
| 334 | </div> |
328 | </div> |
| 335 | <div class="section" id="references-and-footnotes"> |
329 | <div class="section"> |
| 336 | <h1><a class="toc-backref" href="#id26" name="references-and-footnotes">References and Footnotes</a></h1> |
330 | <h1><a class="toc-backref" href="#id26" id="references-and-footnotes" name="references-and-footnotes">References and Footnotes</a></h1> |
| 337 | <table class="footnote" frame="void" id="python" rules="none"> |
331 | <table class="docutils footnote" frame="void" id="python" rules="none"> |
| 338 | <colgroup><col class="label" /><col /></colgroup> |
332 | <colgroup><col class="label" /><col /></colgroup> |
| 339 | <tbody valign="top"> |
333 | <tbody valign="top"> |
| 340 | <tr><td class="label"><a class="fn-backref" href="#id1" name="python">[1]</a></td><td><a class="reference" href="http://www.python.org">http://www.python.org</a></td></tr> |
334 | <tr><td class="label"><a class="fn-backref" href="#id1" name="python">[1]</a></td><td><a class="reference" href="http://www.python.org">http://www.python.org</a></td></tr> |
| 341 | </tbody> |
335 | </tbody> |
| 342 | </table> |
336 | </table> |
| 343 | <table class="footnote" frame="void" id="peps" rules="none"> |
337 | <table class="docutils footnote" frame="void" id="peps" rules="none"> |
| 344 | <colgroup><col class="label" /><col /></colgroup> |
338 | <colgroup><col class="label" /><col /></colgroup> |
| 345 | <tbody valign="top"> |
339 | <tbody valign="top"> |
| 346 | <tr><td class="label"><a class="fn-backref" href="#id2" name="peps">[2]</a></td><td><a class="reference" href="http://www.python.org/peps">http://www.python.org/peps</a></td></tr> |
340 | <tr><td class="label"><a class="fn-backref" href="#id2" name="peps">[2]</a></td><td><a class="reference" href="http://www.python.org/peps">http://www.python.org/peps</a></td></tr> |
| 347 | </tbody> |
341 | </tbody> |
| 348 | </table> |
342 | </table> |
| 349 | <table class="footnote" frame="void" id="pep1" rules="none"> |
343 | <table class="docutils footnote" frame="void" id="pep1" rules="none"> |
| 350 | <colgroup><col class="label" /><col /></colgroup> |
344 | <colgroup><col class="label" /><col /></colgroup> |
| 351 | <tbody valign="top"> |
345 | <tbody valign="top"> |
| 352 | <tr><td class="label"><a class="fn-backref" href="#id3" name="pep1">[3]</a></td><td><a class="reference" href="http://www.python.org/peps/pep-0001.html">http://www.python.org/peps/pep-0001.html</a></td></tr> |
346 | <tr><td class="label"><a class="fn-backref" href="#id3" name="pep1">[3]</a></td><td><a class="reference" href="http://www.python.org/peps/pep-0001.html">http://www.python.org/peps/pep-0001.html</a></td></tr> |
| 353 | </tbody> |
347 | </tbody> |
| 354 | </table> |
348 | </table> |
| 355 | <table class="footnote" frame="void" id="cvs" rules="none"> |
349 | <table class="docutils footnote" frame="void" id="cvs" rules="none"> |
| 356 | <colgroup><col class="label" /><col /></colgroup> |
350 | <colgroup><col class="label" /><col /></colgroup> |
| 357 | <tbody valign="top"> |
351 | <tbody valign="top"> |
| 358 | <tr><td class="label"><a class="fn-backref" href="#id4" name="cvs">[4]</a></td><td>This historical record is available by the normal CVS commands |
352 | <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 |
| 359 | for retrieving older revisions. For those without direct access to the CVS |
353 | for retrieving older revisions. For those without direct access to the CVS |
| 360 | tree, you can browse the current and past GLEP revisions via the Gentoo |
354 | tree, you can browse the current and past GLEP revisions via the Gentoo |
| 361 | Linux viewcvs web site at |
355 | Linux viewcvs web site at |
| 362 | <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> |
356 | <a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/">http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/</a></td></tr> |
| 363 | </tbody> |
357 | </tbody> |
| 364 | </table> |
358 | </table> |
| 365 | <table class="footnote" frame="void" id="rest" rules="none"> |
359 | <table class="docutils footnote" frame="void" id="rest" rules="none"> |
| 366 | <colgroup><col class="label" /><col /></colgroup> |
360 | <colgroup><col class="label" /><col /></colgroup> |
| 367 | <tbody valign="top"> |
361 | <tbody valign="top"> |
| 368 | <tr><td class="label"><a name="rest">[5]</a></td><td><em>(<a class="fn-backref" href="#id14">1</a>, <a class="fn-backref" href="#id15">2</a>)</em> GLEP 2, Sample ReStructuredText GLEP Template, |
362 | <tr><td class="label"><a name="rest">[5]</a></td><td><em>(<a class="fn-backref" href="#id14">1</a>, <a class="fn-backref" href="#id15">2</a>)</em> GLEP 2, Sample ReStructuredText GLEP Template, |
| 369 | (<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr> |
363 | (<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr> |
| 370 | </tbody> |
364 | </tbody> |
| 371 | </table> |
365 | </table> |
| 372 | <table class="footnote" frame="void" id="bugs" rules="none"> |
366 | <table class="docutils footnote" frame="void" id="bugs" rules="none"> |
| 373 | <colgroup><col class="label" /><col /></colgroup> |
367 | <colgroup><col class="label" /><col /></colgroup> |
| 374 | <tbody valign="top"> |
368 | <tbody valign="top"> |
| 375 | <tr><td class="label"><a name="bugs">[6]</a></td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id16">2</a>)</em> <a class="reference" href="http://bugs.gentoo.org">http://bugs.gentoo.org</a></td></tr> |
369 | <tr><td class="label"><a name="bugs">[6]</a></td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id16">2</a>)</em> <a class="reference" href="http://bugs.gentoo.org">http://bugs.gentoo.org</a></td></tr> |
| 376 | </tbody> |
370 | </tbody> |
| 377 | </table> |
371 | </table> |
| 378 | <table class="footnote" frame="void" id="forums" rules="none"> |
372 | <table class="docutils footnote" frame="void" id="forums" rules="none"> |
| 379 | <colgroup><col class="label" /><col /></colgroup> |
373 | <colgroup><col class="label" /><col /></colgroup> |
| 380 | <tbody valign="top"> |
374 | <tbody valign="top"> |
| 381 | <tr><td class="label"><a name="forums">[7]</a></td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference" href="http://forums.gentoo.org">http://forums.gentoo.org</a></td></tr> |
375 | <tr><td class="label"><a name="forums">[7]</a></td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference" href="http://forums.gentoo.org">http://forums.gentoo.org</a></td></tr> |
| 382 | </tbody> |
376 | </tbody> |
| 383 | </table> |
377 | </table> |
| 384 | <table class="footnote" frame="void" id="manager" rules="none"> |
378 | <table class="docutils footnote" frame="void" id="manager" rules="none"> |
| 385 | <colgroup><col class="label" /><col /></colgroup> |
379 | <colgroup><col class="label" /><col /></colgroup> |
| 386 | <tbody valign="top"> |
380 | <tbody valign="top"> |
| 387 | <tr><td class="label"><a name="manager">[8]</a></td><td><em>(<a class="fn-backref" href="#id8">1</a>, <a class="fn-backref" href="#id9">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/management-structure.xml">http://www.gentoo.org/doc/en/management-structure.xml</a></td></tr> |
381 | <tr><td class="label"><a name="manager">[8]</a></td><td><em>(<a class="fn-backref" href="#id8">1</a>, <a class="fn-backref" href="#id9">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/management-structure.xml">http://www.gentoo.org/doc/en/management-structure.xml</a></td></tr> |
| 388 | </tbody> |
382 | </tbody> |
| 389 | </table> |
383 | </table> |
| 390 | <table class="footnote" frame="void" id="opl" rules="none"> |
384 | <table class="docutils footnote" frame="void" id="opl" rules="none"> |
| 391 | <colgroup><col class="label" /><col /></colgroup> |
385 | <colgroup><col class="label" /><col /></colgroup> |
| 392 | <tbody valign="top"> |
386 | <tbody valign="top"> |
| 393 | <tr><td class="label"><a name="opl">[9]</a></td><td><a class="reference" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr> |
387 | <tr><td class="label"><a name="opl">[9]</a></td><td><a class="reference" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr> |
| 394 | </tbody> |
388 | </tbody> |
| 395 | </table> |
389 | </table> |
| 396 | <table class="footnote" frame="void" id="resthome" rules="none"> |
390 | <table class="docutils footnote" frame="void" id="resthome" rules="none"> |
| 397 | <colgroup><col class="label" /><col /></colgroup> |
391 | <colgroup><col class="label" /><col /></colgroup> |
| 398 | <tbody valign="top"> |
392 | <tbody valign="top"> |
| 399 | <tr><td class="label"><a class="fn-backref" href="#id11" name="resthome">[10]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr> |
393 | <tr><td class="label"><a class="fn-backref" href="#id11" name="resthome">[10]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr> |
| 400 | </tbody> |
394 | </tbody> |
| 401 | </table> |
395 | </table> |
| 402 | <table class="footnote" frame="void" id="guidexml" rules="none"> |
396 | <table class="docutils footnote" frame="void" id="guidexml" rules="none"> |
| 403 | <colgroup><col class="label" /><col /></colgroup> |
397 | <colgroup><col class="label" /><col /></colgroup> |
| 404 | <tbody valign="top"> |
398 | <tbody valign="top"> |
| 405 | <tr><td class="label"><a name="guidexml">[11]</a></td><td><em>(<a class="fn-backref" href="#id10">1</a>, <a class="fn-backref" href="#id13">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr> |
399 | <tr><td class="label"><a name="guidexml">[11]</a></td><td><em>(<a class="fn-backref" href="#id10">1</a>, <a class="fn-backref" href="#id13">2</a>)</em> <a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr> |
| 406 | </tbody> |
400 | </tbody> |
| 407 | </table> |
401 | </table> |
| 408 | <table class="footnote" frame="void" id="docutils" rules="none"> |
402 | <table class="docutils footnote" frame="void" id="docutils" rules="none"> |
| 409 | <colgroup><col class="label" /><col /></colgroup> |
403 | <colgroup><col class="label" /><col /></colgroup> |
| 410 | <tbody valign="top"> |
404 | <tbody valign="top"> |
| 411 | <tr><td class="label"><a class="fn-backref" href="#id12" name="docutils">[12]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr> |
405 | <tr><td class="label"><a class="fn-backref" href="#id12" name="docutils">[12]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr> |
| 412 | </tbody> |
406 | </tbody> |
| 413 | </table> |
407 | </table> |
| 414 | </div> |
408 | </div> |
| 415 | <div class="section" id="copyright"> |
409 | <div class="section"> |
| 416 | <h1><a class="toc-backref" href="#id27" name="copyright">Copyright</a></h1> |
410 | <h1><a class="toc-backref" href="#id27" id="copyright" name="copyright">Copyright</a></h1> |
| 417 | <p>This document has been placed in the public domain.</p> |
411 | <p>This document has been placed in the public domain.</p> |
| 418 | </div> |
412 | </div> |
| 419 | </div> |
|
|
| 420 | |
413 | |
| 421 | <hr class="footer"/> |
414 | </div> |
| 422 | <div class="footer"> |
415 | <div class="footer"> |
|
|
416 | <hr class="footer" /> |
| 423 | <a class="reference" href="glep-0001.txt">View document source</a>. |
417 | <a class="reference" href="glep-0001.txt">View document source</a>. |
| 424 | Generated on: 2003-07-19 12:07 UTC. |
418 | Generated on: 2008-06-05 06:05 UTC. |
| 425 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
419 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
|
|
420 | |
| 426 | </div> |
421 | </div> |
| 427 | </body> |
422 | </body> |
| 428 | </html> |
423 | </html> |
| 429 | |
424 | |