--- xml/htdocs/proj/en/glep/glep-0001.html 2003/06/10 17:33:02 1.3 +++ xml/htdocs/proj/en/glep/glep-0001.html 2003/07/02 20:05:42 1.4 @@ -33,9 +33,9 @@ Title:GLEP Purpose and Guidelines -Version:1.3 +Version:1.4 -Last-Modified:2003/06/04 19:57:10 +Last-Modified:2003/06/10 17:33:02 Author:Grant Goodyear <g2boojum at gentoo.org> @@ -47,7 +47,7 @@ Created:31-May-2003 -Post-History:1-Jun-2003 +Post-History:1-Jun-2003, 2-Jul-2003 @@ -55,28 +55,28 @@

Contents

-

Credits

+

Credits

The GLEP concept, and, in fact, much of the text of this document, is liberally stolen from Python's [1] PEPs [2], especially PEP-0001 [3] by Barry A. Warsaw, Jeremy Hylton, and David Goodger.

-

What is a GLEP?

+

What is a GLEP?

GLEP stands for "Gentoo Linux Enhancement Proposal". A GLEP is a design document providing information to the Gentoo Linux community, or describing a new feature for Gentoo Linux. The GLEP should provide a concise technical @@ -91,7 +91,7 @@ [4].

-

Kinds of GLEPs

+

Kinds of GLEPs

There are two kinds of GLEPs. A Standards Track GLEP describes a new feature or implementation for Gentoo Linux. An Informational GLEP describes provides general guidelines or information to the Gentoo Linux community, but does not @@ -100,9 +100,9 @@ are free to ignore Informational GLEPs or follow their advice.

-

GLEP Work Flow

+

GLEP Work Flow

The GLEP editors assign GLEP numbers and change their status. The current -GLEP editors are Grant Goodyear and hopefully somebody else. Please send all +GLEP editors are Grant Goodyear and Alastair Tse. Please send all GLEP-related email to <glep@gentoo.org>.

The GLEP process begins with a new idea for Gentoo Linux. It is highly recommended that a single GLEP contain a single key proposal or new idea. The @@ -116,7 +116,7 @@ GLEP-able. Small enhancements or patches often don't need a GLEP and can be injected into the Gentoo Linux development work flow with an enhancement "bug" submitted to the Gentoo Linux bugzilla [6].

-

The GLEP champion then emails the GLEP editor <glep@gentoo.org> with a +

The GLEP champion then emails the GLEP editors <glep@gentoo.org> with a proposed title and a rough, but fleshed out, draft of the GLEP. This draft must be written in GLEP style as described below.

If the GLEP editor approves, he will assign the GLEP a number, label it @@ -149,11 +149,11 @@ author accept private comments in the early design phases, etc. GLEP authors should use their discretion here.

Once the authors have completed a GLEP, they must inform the GLEP editors that -it is ready for review. GLEPs are reviewed by the Gentoo Linux Chief -Architect or Development Manager, who may accept or reject a GLEP outright, or +it is ready for review. GLEPs are reviewed by the appropriate Gentoo +Manager [8], who may accept or reject a GLEP outright, or send it back to the author(s) for revision. For a GLEP that is pre-determined to be acceptable (e.g., it is an obvious win as-is and/or its implementation -has already been checked in) the Chief Architect or the Development Manager +has already been checked in) the appropriate Gentoo Manager [8] may also initiate a GLEP review, first notifying the GLEP author(s) and giving them a chance to make revisions.

For a GLEP to be accepted it must meet certain minimum criteria. It must be a @@ -183,7 +183,7 @@ meant to be completed. E.g. GLEP 1 (this GLEP).

-

What belongs in a successful GLEP?

+

What belongs in a successful GLEP?

Each GLEP should have the following parts:

  1. Preamble -- RFC 822 style headers containing meta-data about the @@ -195,7 +195,7 @@ being addressed.

  2. Motivation -- The motivation is critical for GLEPs that want to -change the Gentoo Linux functionality. It should clearly explain why the +modify Gentoo Linux functionality. It should clearly explain why the existing functionality or policy is inadequate to address the problem that the GLEP solves. GLEP submissions without sufficient motivation may be rejected outright.

    @@ -232,17 +232,18 @@
-

GLEP Formating and Template

-

GLEPs are written in a just-barely-marked-up version of plain ASCII text -called ReStructuredText [9] that is then converted to HTML using -Docutils [11]. Using ReStructuredText GLEPs allows for rich markup +

GLEP Formating and Template

+

GLEPs are written either in Gentoo Linux Guide-XML [11] or in +a just-barely-marked-up version of plain ASCII text +called ReStructuredText [10] that is then converted to HTML using +Docutils [12]. Using ReStructuredText GLEPs allows for rich markup that is still quite easy to read, but results in much better-looking and more functional HTML. Moreover, it should be straightforward to convert GLEPs to -Gentoo Linux guide xml [10] if needed. GLEP 2 contains a boilerplate -template [5] for use with ReStructuredText GLEPs.

+Gentoo Linux guide xml [11] if needed. GLEP 2 contains a boilerplate +template [5] for use with ReStructuredText GLEPs.

-

GLEP Header Preamble

+

GLEP Header Preamble

Each GLEP must begin with an RFC 2822 style header preamble. The headers must appear in the following order. Headers marked with "*" are optional and are described below. All other headers are required.

@@ -284,9 +285,10 @@ be obscured.

The Type header specifies the type of GLEP: Informational or Standards Track.

-

The format of a GLEP is specified with a Content-Type header, which for now -should always read "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 -[5]).

+

The format of a GLEP is specified with a Content-Type header, which +should read "text/xml" for Gentoo Guide XML or +"text/x-rst" for ReStructuredText GLEPs (see GLEP 2 +[5]).

The Created header records the date that the GLEP was assigned a number, while Post-History is used to record the dates of when new versions of the GLEP are posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. @@ -299,13 +301,13 @@ header containing the number of the GLEP that it rendered obsolete.

-

Reporting GLEP Bugs, or Submitting GLEP Updates

+

Reporting GLEP Bugs, or Submitting GLEP Updates

How you report a bug, or submit a GLEP update depends on several factors, such as the maturity of the GLEP, the preferences of the GLEP author, and the nature of your comments. For the early draft stages of the GLEP, it's probably best to send your comments and changes directly to the GLEP author. For more mature, or finished GLEPs you may want to submit corrections to the -Gentoo Linux bugzilla [6] so that your changes don't get lost. If the GLEP +Gentoo Linux bugzilla [6] so that your changes don't get lost. If the GLEP author is a Gentoo Linux developer, assign the bug/patch to him, otherwise assign it to the GLEP editors.

When in doubt about where to send your changes, please check first with the @@ -314,7 +316,7 @@ themselves by using "cvs commit" to commit their changes.

-

Transferring GLEP Ownership

+

Transferring GLEP Ownership

It occasionally becomes necessary to transfer ownership of GLEPs to a new champion. In general, we'd like to retain the original author as a co-author of the transferred GLEP, but that's really up to the original author. A good @@ -331,7 +333,7 @@ such decisions can't be reversed :).

-

References and Footnotes

+

References and Footnotes

@@ -363,14 +365,14 @@
-
[5](1, 2) GLEP 2, Sample ReStructuredText GLEP Template, +
[5](1, 2) GLEP 2, Sample ReStructuredText GLEP Template, (http://glep.gentoo.org/glep-0002.html)
- +
[6](1, 2) http://bugs.gentoo.org
[6](1, 2) http://bugs.gentoo.org
@@ -379,33 +381,39 @@
[7](1, 2) http://forums.gentoo.org
+ + + + + +
[8](1, 2) http://www.gentoo.org/doc/en/management-structure.xml
- +
[8]http://www.opencontent.org/openpub/
[9]http://www.opencontent.org/openpub/
- +
[9]http://docutils.sourceforge.net/rst.html
[10]http://docutils.sourceforge.net/rst.html
- +
[10]http://www.gentoo.org/doc/en/xml-guide.xml
[11](1, 2) http://www.gentoo.org/doc/en/xml-guide.xml
- +
[11]http://docutils.sourceforge.net/
[12]http://docutils.sourceforge.net/
@@ -413,7 +421,7 @@