--- xml/htdocs/proj/en/glep/glep-0001.html 2008/06/05 06:06:05 1.13 +++ xml/htdocs/proj/en/glep/glep-0001.html 2011/03/10 20:53:02 1.14 @@ -4,10 +4,9 @@ - + GLEP 1 -- GLEP Purpose and Guidelines - - + @@ -30,7 +29,7 @@ - + @@ -38,40 +37,40 @@ - + - +
-
-

Contents

+
+

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.

+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 @@ -83,10 +82,10 @@ documenting dissenting opinions.

Because the GLEPs are maintained as text files under CVS control, their revision history is the historical record of the feature proposal -[4].

+[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 @@ -94,11 +93,11 @@ Gentoo Linux community consensus or recommendation, so users and implementors 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 Alastair Tse. Please send all -GLEP-related email to <glep@gentoo.org>.

+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 more focussed the GLEP, the more successful it tends to be. The GLEP editors @@ -110,8 +109,8 @@ champion (a.k.a. Author) should first attempt to ascertain whether the idea is 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 editors <glep@gentoo.org> with a +submitted to the Gentoo Linux bugzilla [6].

+

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 accepts the GLEP, he will assign the GLEP a number, label @@ -122,13 +121,13 @@ technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with Gentoo Linux philosophy.

If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the -gentoo-dev@gentoo.org mailing list to help flesh it out, gain feedback and +gentoo-dev@gentoo.org mailing list to help flesh it out, gain feedback and consensus from the community at large, and improve the GLEP for re-submission.

The author of the GLEP is then responsible for posting the GLEP to the -gentoo-dev mailing list and to the Gentoo Linux forums [7], and -marshaling community support for it. As updates are necessary, the GLEP -author can check in new versions if they have CVS commit permissions, or can -email new GLEP versions to the GLEP editors for committing.

+gentoo-dev mailing list (and additionally to the Gentoo Linux forums [7] +if they so desire), and marshaling community support for it. As updates are +necessary, the GLEP author may check in new versions directly, or forward to +a Gentoo developer with commit access.

Standards Track GLEPs consist of two parts, a design document and a reference implementation. The GLEP should be reviewed and accepted before a reference implementation is begun, unless a reference implementation will aid people in @@ -136,20 +135,19 @@ the form of code, patch, or URL to same -- before it can be considered Final.

GLEP authors are responsible for collecting community feedback on a GLEP before submitting it for review. A GLEP that has not been discussed on -gentoo-dev@gentoo.org and/or the Gentoo Linux forums [7] will not be +gentoo-dev@gentoo.org and the Gentoo Linux forums [7] will not be accepted. However, wherever possible, long open-ended discussions on public mailing lists should be avoided. Strategies to keep the discussions efficient include setting up a specific forums thread for the topic, having the GLEP 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 appropriate Gentoo -Manager [8], who may approve or reject a GLEP outright, or -send it back to the author(s) for revision. For a GLEP that is pre-determined -to be approvable (e.g., it is an obvious win as-is and/or its implementation -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.

+

Once the authors have completed a GLEP, they must inform the Gentoo Council +[8] that it is ready for review by way of the gentoo-dev mailing +list. GLEPs are then reviewed at a Council meeting where the may be approved +or rejected outright, or sent back to the author(s) for revision. This +generally should be done a few weeks in advance of the actual review so as to +avoid the appearance of "slipping" a GLEP in without proper public review +by the Gentoo developer community.

For a GLEP to be approved it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, @@ -176,11 +174,11 @@

Some Informational GLEPs may also have a status of "Active" if they are never 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 +

  2. Preamble -- RFC 822 style headers containing meta-data about the GLEP, including the GLEP number, a short descriptive title (limited to a maximum of 44 characters), the names, and optionally the contact info for each author, etc.

    @@ -225,20 +223,20 @@
-
-

GLEP Formating and Template

-

GLEPs are written either in Gentoo Linux Guide-XML [11] or in +

+

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 +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 [11] 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

-

Each GLEP must begin with an RFC 2822 style header preamble. The headers +

+

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.

@@ -262,13 +260,13 @@
 of all the authors/owners of the GLEP.  The format of the Author header
 value must be

-Random J. User <address@dom.ain>
+Random J. User <address@dom.ain>

if the email address is included, and just

Random J. User

if the address is not given.

If there are multiple authors, each should be on a separate line -following RFC 2822 continuation line conventions. Note that personal +following RFC 2822 continuation line conventions. Note that personal email addresses in GLEPs will be obscured as a defense against spam harvesters.

While a GLEP is in private discussions (usually during the initial Draft @@ -282,7 +280,7 @@

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]).

+[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. @@ -294,14 +292,14 @@ that replaces the current document. The newer GLEP must have a Replaces 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 @@ -309,8 +307,8 @@

GLEP authors who are also Gentoo Linux developers can update the GLEPs 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 @@ -322,103 +320,102 @@ that's not possible, you can always submit a competing GLEP.

If you are interested in assuming ownership of a GLEP, send a message asking to take over, addressed to both the original author and the GLEP editors -<glep@gentoo.org>. If the original author doesn't respond to email in a +<glep@gentoo.org>. If the original author doesn't respond to email in a timely manner, the GLEP editors will make a unilateral decision (it's not like such decisions can't be reversed :).

-
-

References and Footnotes

+
+

References and Footnotes

- +
[1]http://www.python.org
[1]http://www.python.org
- +
[2]http://www.python.org/peps
[2]http://www.python.org/peps
- +
[3]http://www.python.org/peps/pep-0001.html
[3]http://www.python.org/peps/pep-0001.html
- +http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/
[4]This historical record is available by the normal CVS commands +
[4]This historical record is available by the normal CVS commands for retrieving older revisions. For those without direct access to the CVS tree, you can browse the current and past GLEP revisions via the Gentoo Linux viewcvs web site at -http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/
- +
[5](1, 2) GLEP 2, Sample ReStructuredText GLEP Template, -(http://glep.gentoo.org/glep-0002.html)
[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
- +
[7](1, 2) http://forums.gentoo.org
[7](1, 2) http://forums.gentoo.org
- +
- +
[8](1, 2) http://www.gentoo.org/doc/en/management-structure.xml
[8]http://www.gentoo.org/proj/en/glep/glep-0039.html
- +
[9]http://www.opencontent.org/openpub/
[9]http://www.opencontent.org/openpub/
- +
[10]http://docutils.sourceforge.net/rst.html
[10]http://docutils.sourceforge.net/rst.html
- +
[11](1, 2) http://www.gentoo.org/doc/en/xml-guide.xml
[11](1, 2) http://www.gentoo.org/doc/en/xml-guide.xml
- +
[12]http://docutils.sourceforge.net/
[12]http://docutils.sourceforge.net/
-
-

Copyright

+
-