--- xml/htdocs/proj/en/glep/glep-0001.html 2004/04/04 23:05:35 1.8 +++ xml/htdocs/proj/en/glep/glep-0001.html 2006/10/10 20:25:14 1.9 @@ -8,9 +8,252 @@ --> - + GLEP 1 -- GLEP Purpose and Guidelines - + -
- +
@@ -33,9 +275,9 @@ - + - + @@ -52,8 +294,8 @@
Title:GLEP Purpose and Guidelines
Version:1.7
Version:1.8
Last-Modified:2003/07/19 12:09:20
Last-Modified:2004/04/04 23:05:35
Author:Grant Goodyear <g2boojum at gentoo.org>

-
-

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.

-
-

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 @@ -90,8 +332,8 @@ revision history is the historical record of the feature proposal [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 @@ -99,8 +341,8 @@ 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>.

@@ -181,8 +423,8 @@

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 @@ -211,7 +453,7 @@

    The rationale should provide evidence of consensus within the community and discuss important objections or concerns raised during discussion.

  2. -
  3. Backwards Compatibility -- All GLEPs +

  4. Backwards Compatibility -- All GLEPs must include a section describing any issues of backwards incompatibilities and their severity. The GLEP must explain how the author proposes to deal with these incompatibilities. (Even if there are none, this section should @@ -230,8 +472,8 @@

-
-

GLEP Formating and Template

+
+

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 @@ -241,8 +483,8 @@ 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,8 +526,8 @@ 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 -should read "text/xml" for Gentoo Guide XML or +

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 @@ -299,8 +541,8 @@ 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 @@ -314,8 +556,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 @@ -331,27 +573,27 @@ timely manner, the GLEP editors will make a unilateral decision (it's not like such decisions can't be reversed :).

- - - +