| 1 | GLEP: 1 |
1 | GLEP: 1 |
| 2 | Title: GLEP Purpose and Guidelines |
2 | Title: GLEP Purpose and Guidelines |
| 3 | Version: $Revision: 1.2 $ |
3 | Version: $Revision: 1.5 $ |
| 4 | Last-Modified: $Date: 2003/06/02 17:37:47 $ |
4 | Last-Modified: $Date: 2003/07/02 20:05:42 $ |
| 5 | Author: Grant Goodyear |
5 | Author: Grant Goodyear <g2boojum@gentoo.org> |
| 6 | Status: Draft |
6 | Status: Draft |
| 7 | Type: Informational |
7 | Type: Informational |
| 8 | Content-Type: text/x-rst |
8 | Content-Type: text/x-rst |
| 9 | Created: 31 May 2003 |
9 | Created: 31-May-2003 |
| 10 | Post-History: |
10 | Post-History: 1-Jun-2003, 2-Jul-2003 |
| 11 | |
11 | |
| 12 | |
12 | |
| 13 | Credits |
13 | Credits |
| 14 | ======= |
14 | ======= |
| 15 | |
15 | |
| … | |
… | |
| 50 | |
50 | |
| 51 | GLEP Work Flow |
51 | GLEP Work Flow |
| 52 | ============== |
52 | ============== |
| 53 | |
53 | |
| 54 | The GLEP editors assign GLEP numbers and change their status. The current |
54 | The GLEP editors assign GLEP numbers and change their status. The current |
| 55 | GLEP editors are Grant Goodyear and hopefully somebody else. Please send all |
55 | GLEP editors are Grant Goodyear and Alastair Tse. Please send all |
| 56 | GLEP-related email to <glep@gentoo.org>. |
56 | GLEP-related email to <glep@gentoo.org>. |
| 57 | |
57 | |
| 58 | The GLEP process begins with a new idea for Gentoo Linux. It is highly |
58 | The GLEP process begins with a new idea for Gentoo Linux. It is highly |
| 59 | recommended that a single GLEP contain a single key proposal or new idea. The |
59 | recommended that a single GLEP contain a single key proposal or new idea. The |
| 60 | more focussed the GLEP, the more successful it tends to be. The GLEP editors |
60 | more focussed the GLEP, the more successful it tends to be. The GLEP editors |
| … | |
… | |
| 67 | champion (a.k.a. Author) should first attempt to ascertain whether the idea is |
67 | champion (a.k.a. Author) should first attempt to ascertain whether the idea is |
| 68 | GLEP-able. Small enhancements or patches often don't need a GLEP and can be |
68 | GLEP-able. Small enhancements or patches often don't need a GLEP and can be |
| 69 | injected into the Gentoo Linux development work flow with an enhancement "bug" |
69 | injected into the Gentoo Linux development work flow with an enhancement "bug" |
| 70 | submitted to the Gentoo Linux bugzilla [#BUGS]_. |
70 | submitted to the Gentoo Linux bugzilla [#BUGS]_. |
| 71 | |
71 | |
| 72 | The GLEP champion then emails the GLEP editor <glep@gentoo.org> with a |
72 | The GLEP champion then emails the GLEP editors <glep@gentoo.org> with a |
| 73 | proposed title and a rough, but fleshed out, draft of the GLEP. This draft |
73 | proposed title and a rough, but fleshed out, draft of the GLEP. This draft |
| 74 | must be written in GLEP style as described below. |
74 | must be written in GLEP style as described below. |
| 75 | |
75 | |
| 76 | If the GLEP editor approves, he will assign the GLEP a number, label it |
76 | If the GLEP editor approves, he will assign the GLEP a number, label it |
| 77 | as Standards Track (a better name would be nice here -- suggestions?) |
77 | as Standards Track (a better name would be nice here -- suggestions?) |
| … | |
… | |
| 106 | include setting up a specific forums thread for the topic, having the GLEP |
106 | include setting up a specific forums thread for the topic, having the GLEP |
| 107 | author accept private comments in the early design phases, etc. GLEP authors |
107 | author accept private comments in the early design phases, etc. GLEP authors |
| 108 | should use their discretion here. |
108 | should use their discretion here. |
| 109 | |
109 | |
| 110 | Once the authors have completed a GLEP, they must inform the GLEP editors that |
110 | Once the authors have completed a GLEP, they must inform the GLEP editors that |
| 111 | it is ready for review. GLEPs are reviewed by the Gentoo Linux Chief |
111 | it is ready for review. GLEPs are reviewed by the appropriate Gentoo |
| 112 | Architect or Development Manager, who may accept or reject a GLEP outright, or |
112 | Manager [#MANAGER]_, who may accept or reject a GLEP outright, or |
| 113 | send it back to the author(s) for revision. For a GLEP that is pre-determined |
113 | send it back to the author(s) for revision. For a GLEP that is pre-determined |
| 114 | to be acceptable (e.g., it is an obvious win as-is and/or its implementation |
114 | to be acceptable (e.g., it is an obvious win as-is and/or its implementation |
| 115 | has already been checked in) the Chief Architect or the Development Manager |
115 | has already been checked in) the appropriate Gentoo Manager [#MANAGER]_ |
| 116 | may also initiate a GLEP review, first notifying the GLEP author(s) and giving |
116 | may also initiate a GLEP review, first notifying the GLEP author(s) and giving |
| 117 | them a chance to make revisions. |
117 | them a chance to make revisions. |
| 118 | |
118 | |
| 119 | For a GLEP to be accepted it must meet certain minimum criteria. It must be a |
119 | For a GLEP to be accepted it must meet certain minimum criteria. It must be a |
| 120 | clear and complete description of the proposed enhancement. The enhancement |
120 | clear and complete description of the proposed enhancement. The enhancement |
| … | |
… | |
| 160 | |
160 | |
| 161 | 2. Abstract -- a short (~200 word) description of the technical issue |
161 | 2. Abstract -- a short (~200 word) description of the technical issue |
| 162 | being addressed. |
162 | being addressed. |
| 163 | |
163 | |
| 164 | 3. Motivation -- The motivation is critical for GLEPs that want to |
164 | 3. Motivation -- The motivation is critical for GLEPs that want to |
| 165 | change the Gentoo Linux functionality. It should clearly explain why the |
165 | modify Gentoo Linux functionality. It should clearly explain why the |
| 166 | existing functionality or policy is inadequate to address the problem that |
166 | existing functionality or policy is inadequate to address the problem that |
| 167 | the GLEP solves. GLEP submissions without sufficient motivation may be |
167 | the GLEP solves. GLEP submissions without sufficient motivation may be |
| 168 | rejected outright. |
168 | rejected outright. |
| 169 | |
169 | |
| 170 | 4. Specification -- The technical specification should describe the |
170 | 4. Specification -- The technical specification should describe the |
| … | |
… | |
| 199 | |
199 | |
| 200 | |
200 | |
| 201 | GLEP Formating and Template |
201 | GLEP Formating and Template |
| 202 | =========================== |
202 | =========================== |
| 203 | |
203 | |
|
|
204 | GLEPs are written either in Gentoo Linux Guide-XML [#GUIDEXML]_ or in |
| 204 | GLEPs are written in a just-barely-marked-up version of plain ASCII text |
205 | a just-barely-marked-up version of plain ASCII text |
| 205 | called ReStructuredText [#ReSTHOME]_ that is then converted to HTML using |
206 | called ReStructuredText [#ReSTHOME]_ that is then converted to HTML using |
| 206 | Docutils [#DOCUTILS]_. Using ReStructuredText GLEPs allows for rich markup |
207 | Docutils [#DOCUTILS]_. Using ReStructuredText GLEPs allows for rich markup |
| 207 | that is still quite easy to read, but results in much better-looking and more |
208 | that is still quite easy to read, but results in much better-looking and more |
| 208 | functional HTML. Moreover, it should be straightforward to convert GLEPs to |
209 | functional HTML. Moreover, it should be straightforward to convert GLEPs to |
| 209 | Gentoo Linux guide xml [#GUIDEXML]_ if needed. GLEP 2 contains a boilerplate |
210 | Gentoo Linux guide xml [#GUIDEXML]_ if needed. GLEP 2 contains a boilerplate |
| … | |
… | |
| 258 | be obscured. |
259 | be obscured. |
| 259 | |
260 | |
| 260 | The Type header specifies the type of GLEP: Informational or Standards |
261 | The Type header specifies the type of GLEP: Informational or Standards |
| 261 | Track. |
262 | Track. |
| 262 | |
263 | |
| 263 | The format of a GLEP is specified with a Content-Type header, which for now |
264 | The format of a GLEP is specified with a Content-Type header, which |
|
|
265 | should read "text/xml" for Gentoo Guide XML or |
| 264 | should always read "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 |
266 | "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 |
| 265 | [#ReST]_). |
267 | [#ReST]_). |
| 266 | |
268 | |
| 267 | The Created header records the date that the GLEP was assigned a number, while |
269 | The Created header records the date that the GLEP was assigned a number, while |
| 268 | Post-History is used to record the dates of when new versions of the GLEP are |
270 | Post-History is used to record the dates of when new versions of the GLEP are |
| 269 | posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. |
271 | posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. |
| … | |
… | |
| 336 | |
338 | |
| 337 | .. [#BUGS] http://bugs.gentoo.org |
339 | .. [#BUGS] http://bugs.gentoo.org |
| 338 | |
340 | |
| 339 | .. [#FORUMS] http://forums.gentoo.org |
341 | .. [#FORUMS] http://forums.gentoo.org |
| 340 | |
342 | |
|
|
343 | .. [#MANAGER] http://www.gentoo.org/doc/en/management-structure.xml |
|
|
344 | |
| 341 | .. [#OPL] http://www.opencontent.org/openpub/ |
345 | .. [#OPL] http://www.opencontent.org/openpub/ |
| 342 | |
346 | |
| 343 | .. [#ReSTHOME] http://docutils.sourceforge.net/rst.html |
347 | .. [#ReSTHOME] http://docutils.sourceforge.net/rst.html |
| 344 | |
348 | |
| 345 | .. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml |
349 | .. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml |
Parent Directory
| 
Revision Log
| 
Patch