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

Diff of /xml/htdocs/proj/en/glep/glep-0001.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.3 Revision 1.10
1GLEP: 1 1GLEP: 1
2Title: GLEP Purpose and Guidelines 2Title: GLEP Purpose and Guidelines
3Version: $Revision: 1.3 $ 3Version: $Revision: 1.10 $
4Last-Modified: $Date: 2003/06/04 19:57:10 $ 4Last-Modified: $Date: 2008/01/05 03:05:07 $
5Author: Grant Goodyear <g2boojum@gentoo.org> 5Author: Grant Goodyear <g2boojum@gentoo.org>
6Status: Draft 6Status: Active
7Type: Informational 7Type: Informational
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 31 May 2003 9Created: 31-May-2003
10Post-History: 10Post-History: 1-Jun-2003, 2-Jul-2003
11 11
12 12
13Credits 13Credits
14======= 14=======
15 15
50 50
51GLEP Work Flow 51GLEP Work Flow
52============== 52==============
53 53
54The GLEP editors assign GLEP numbers and change their status. The current 54The GLEP editors assign GLEP numbers and change their status. The current
55GLEP editors are Grant Goodyear and hopefully somebody else. Please send all 55GLEP editors are Grant Goodyear and Alastair Tse. Please send all
56GLEP-related email to <glep@gentoo.org>. 56GLEP-related email to <glep@gentoo.org>.
57 57
58The GLEP process begins with a new idea for Gentoo Linux. It is highly 58The GLEP process begins with a new idea for Gentoo Linux. It is highly
59recommended that a single GLEP contain a single key proposal or new idea. The 59recommended that a single GLEP contain a single key proposal or new idea. The
60more focussed the GLEP, the more successful it tends to be. The GLEP editors 60more focussed the GLEP, the more successful it tends to be. The GLEP editors
67champion (a.k.a. Author) should first attempt to ascertain whether the idea is 67champion (a.k.a. Author) should first attempt to ascertain whether the idea is
68GLEP-able. Small enhancements or patches often don't need a GLEP and can be 68GLEP-able. Small enhancements or patches often don't need a GLEP and can be
69injected into the Gentoo Linux development work flow with an enhancement "bug" 69injected into the Gentoo Linux development work flow with an enhancement "bug"
70submitted to the Gentoo Linux bugzilla [#BUGS]_. 70submitted to the Gentoo Linux bugzilla [#BUGS]_.
71 71
72The GLEP champion then emails the GLEP editor <glep@gentoo.org> with a 72The GLEP champion then emails the GLEP editors <glep@gentoo.org> with a
73proposed title and a rough, but fleshed out, draft of the GLEP. This draft 73proposed title and a rough, but fleshed out, draft of the GLEP. This draft
74must be written in GLEP style as described below. 74must be written in GLEP style as described below.
75 75
76If the GLEP editor approves, he will assign the GLEP a number, label it 76If the GLEP editor accepts the GLEP, he will assign the GLEP a number, label
77as Standards Track (a better name would be nice here -- suggestions?) 77it as Standards Track (a better name would be nice here -- suggestions?) or
78or Informational, give it status "Draft", and 78Informational, give it status "Draft", and create and check-in the initial
79create and check-in the initial draft of the GLEP. The GLEP editors will 79draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP.
80not unreasonably deny a GLEP. Reasons for denying GLEP status include 80Reasons for denying GLEP status include duplication of effort, being
81duplication of effort, being technically unsound, not providing proper 81technically unsound, not providing proper motivation or addressing backwards
82motivation or addressing backwards compatibility, or not in keeping 82compatibility, or not in keeping with Gentoo Linux philosophy.
83with Gentoo Linux philosophy.
84 83
85If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the 84If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the
86gentoo-dev@gentoo.org mailing list to help flesh it out, gain feedback and 85gentoo-dev@gentoo.org mailing list to help flesh it out, gain feedback and
87consensus from the community at large, and improve the GLEP for re-submission. 86consensus from the community at large, and improve the GLEP for re-submission.
88 87
106include setting up a specific forums thread for the topic, having the GLEP 105include setting up a specific forums thread for the topic, having the GLEP
107author accept private comments in the early design phases, etc. GLEP authors 106author accept private comments in the early design phases, etc. GLEP authors
108should use their discretion here. 107should use their discretion here.
109 108
110Once the authors have completed a GLEP, they must inform the GLEP editors that 109Once the authors have completed a GLEP, they must inform the GLEP editors that
111it is ready for review. GLEPs are reviewed by the Gentoo Linux Chief 110it is ready for review. GLEPs are reviewed by the appropriate Gentoo
112Architect or Development Manager, who may accept or reject a GLEP outright, or 111Manager [#MANAGER]_, who may approve or reject a GLEP outright, or
113send it back to the author(s) for revision. For a GLEP that is pre-determined 112send it back to the author(s) for revision. For a GLEP that is pre-determined
114to be acceptable (e.g., it is an obvious win as-is and/or its implementation 113to be approvable (e.g., it is an obvious win as-is and/or its implementation
115has already been checked in) the Chief Architect or the Development Manager 114has already been checked in) the appropriate Gentoo Manager [#MANAGER]_
116may also initiate a GLEP review, first notifying the GLEP author(s) and giving 115may also initiate a GLEP review, first notifying the GLEP author(s) and giving
117them a chance to make revisions. 116them a chance to make revisions.
118 117
119For a GLEP to be accepted it must meet certain minimum criteria. It must be a 118For a GLEP to be approved it must meet certain minimum criteria. It must be a
120clear and complete description of the proposed enhancement. The enhancement 119clear and complete description of the proposed enhancement. The enhancement
121must represent a net improvement. The proposed implementation, if applicable, 120must represent a net improvement. The proposed implementation, if applicable,
122must be solid and must not complicate the distribution unduly. Finally, a 121must be solid and must not complicate the distribution unduly. Finally, a
123proposed enhancement must satisfy the philosophy of Gentoo Linux. 122proposed enhancement must satisfy the philosophy of Gentoo Linux.
124 123
160 159
1612. Abstract -- a short (~200 word) description of the technical issue 1602. Abstract -- a short (~200 word) description of the technical issue
162 being addressed. 161 being addressed.
163 162
1643. Motivation -- The motivation is critical for GLEPs that want to 1633. Motivation -- The motivation is critical for GLEPs that want to
165 change the Gentoo Linux functionality. It should clearly explain why the 164 modify Gentoo Linux functionality. It should clearly explain why the
166 existing functionality or policy is inadequate to address the problem that 165 existing functionality or policy is inadequate to address the problem that
167 the GLEP solves. GLEP submissions without sufficient motivation may be 166 the GLEP solves. GLEP submissions without sufficient motivation may be
168 rejected outright. 167 rejected outright.
169 168
1704. Specification -- The technical specification should describe the 1694. Specification -- The technical specification should describe the
199 198
200 199
201GLEP Formating and Template 200GLEP Formating and Template
202=========================== 201===========================
203 202
203GLEPs are written either in Gentoo Linux Guide-XML [#GUIDEXML]_ or in
204GLEPs are written in a just-barely-marked-up version of plain ASCII text 204a just-barely-marked-up version of plain ASCII text
205called ReStructuredText [#ReSTHOME]_ that is then converted to HTML using 205called ReStructuredText [#ReSTHOME]_ that is then converted to HTML using
206Docutils [#DOCUTILS]_. Using ReStructuredText GLEPs allows for rich markup 206Docutils [#DOCUTILS]_. Using ReStructuredText GLEPs allows for rich markup
207that is still quite easy to read, but results in much better-looking and more 207that is still quite easy to read, but results in much better-looking and more
208functional HTML. Moreover, it should be straightforward to convert GLEPs to 208functional HTML. Moreover, it should be straightforward to convert GLEPs to
209Gentoo Linux guide xml [#GUIDEXML]_ if needed. GLEP 2 contains a boilerplate 209Gentoo Linux guide xml [#GUIDEXML]_ if needed. GLEP 2 contains a boilerplate
258be obscured. 258be obscured.
259 259
260The Type header specifies the type of GLEP: Informational or Standards 260The Type header specifies the type of GLEP: Informational or Standards
261Track. 261Track.
262 262
263The format of a GLEP is specified with a Content-Type header, which for now 263The format of a GLEP is specified with a Content-Type header, which
264should read "text/xml" for Gentoo Guide XML or
264should always read "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 265"text/x-rst" for ReStructuredText GLEPs (see GLEP 2
265[#ReST]_). 266[#ReST]_).
266 267
267The Created header records the date that the GLEP was assigned a number, while 268The Created header records the date that the GLEP was assigned a number, while
268Post-History is used to record the dates of when new versions of the GLEP are 269Post-History is used to record the dates of when new versions of the GLEP are
269posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. 270posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g.
327 328
328.. [#CVS] This historical record is available by the normal CVS commands 329.. [#CVS] This historical record is available by the normal CVS commands
329 for retrieving older revisions. For those without direct access to the CVS 330 for retrieving older revisions. For those without direct access to the CVS
330 tree, you can browse the current and past GLEP revisions via the Gentoo 331 tree, you can browse the current and past GLEP revisions via the Gentoo
331 Linux viewcvs web site at 332 Linux viewcvs web site at
332 http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/ 333 http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/
333 334
334.. [#ReST] GLEP 2, Sample ReStructuredText GLEP Template, 335.. [#ReST] GLEP 2, Sample ReStructuredText GLEP Template,
335 (http://glep.gentoo.org/glep-0002.html) 336 (http://glep.gentoo.org/glep-0002.html)
336 337
337.. [#BUGS] http://bugs.gentoo.org 338.. [#BUGS] http://bugs.gentoo.org
338 339
339.. [#FORUMS] http://forums.gentoo.org 340.. [#FORUMS] http://forums.gentoo.org
340 341
342.. [#MANAGER] http://www.gentoo.org/doc/en/management-structure.xml
343
341.. [#OPL] http://www.opencontent.org/openpub/ 344.. [#OPL] http://www.opencontent.org/openpub/
342 345
343.. [#ReSTHOME] http://docutils.sourceforge.net/rst.html 346.. [#ReSTHOME] http://docutils.sourceforge.net/rst.html
344 347
345.. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml 348.. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.10

  ViewVC Help
Powered by ViewVC 1.1.20