1 |
g2boojum |
1.1 |
<?xml version="1.0" encoding="utf-8" ?> |
2 |
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
4 |
|
|
<!-- |
5 |
|
|
This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new |
6 |
|
|
PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
7 |
|
|
to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
8 |
|
|
--> |
9 |
|
|
<head> |
10 |
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
11 |
|
|
<meta name="generator" content="Docutils 0.2.8: http://docutils.sourceforge.net/" /> |
12 |
|
|
<title>GLEP 1 -- GLEP Purpose and Guidelines</title> |
13 |
|
|
<link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
14 |
|
|
</head> |
15 |
|
|
<body bgcolor="white"> |
16 |
|
|
<table class="navigation" cellpadding="0" cellspacing="0" |
17 |
|
|
width="100%" border="0"> |
18 |
|
|
<tr><td class="navicon" width="150" height="35"> |
19 |
|
|
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
20 |
|
|
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
21 |
|
|
border="0" width="150" height="35" /></a></td> |
22 |
|
|
<td class="textlinks" align="left"> |
23 |
|
|
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
24 |
|
|
[<b><a href="http://glep.gentoo.org">GLEP Index</a></b>] |
25 |
|
|
[<b><a href="http://glep.gentoo.org/glep-0001.txt">GLEP Source</a></b>] |
26 |
|
|
</td></tr></table> |
27 |
|
|
<div class="document"> |
28 |
|
|
<table class="rfc2822 field-list" frame="void" rules="none"> |
29 |
|
|
<col class="field-name" /> |
30 |
|
|
<col class="field-body" /> |
31 |
|
|
<tbody valign="top"> |
32 |
|
|
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">1</td> |
33 |
|
|
</tr> |
34 |
|
|
<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP Purpose and Guidelines</td> |
35 |
|
|
</tr> |
36 |
|
|
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> |
37 |
|
|
</tr> |
38 |
|
|
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/python/python/nondist/peps/pep-0001.txt">2003/06/02 17:03:08</a></td> |
39 |
|
|
</tr> |
40 |
|
|
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear</td> |
41 |
|
|
</tr> |
42 |
|
|
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
43 |
|
|
</tr> |
44 |
|
|
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td> |
45 |
|
|
</tr> |
46 |
|
|
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> |
47 |
|
|
</tr> |
48 |
|
|
<tr class="field"><th class="field-name">Created:</th><td class="field-body">31 May 2003</td> |
49 |
|
|
</tr> |
50 |
|
|
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body"></td> |
51 |
|
|
</tr> |
52 |
|
|
</tbody> |
53 |
|
|
</table> |
54 |
|
|
<hr /> |
55 |
|
|
<div class="contents topic" id="contents"> |
56 |
|
|
<p class="topic-title"><a name="contents">Contents</a></p> |
57 |
|
|
<ul class="simple"> |
58 |
|
|
<li><a class="reference" href="#credits" id="id14" name="id14">Credits</a></li> |
59 |
|
|
<li><a class="reference" href="#what-is-a-glep" id="id15" name="id15">What is a GLEP?</a></li> |
60 |
|
|
<li><a class="reference" href="#kinds-of-gleps" id="id16" name="id16">Kinds of GLEPs</a></li> |
61 |
|
|
<li><a class="reference" href="#glep-work-flow" id="id17" name="id17">GLEP Work Flow</a></li> |
62 |
|
|
<li><a class="reference" href="#what-belongs-in-a-successful-glep" id="id18" name="id18">What belongs in a successful GLEP?</a></li> |
63 |
|
|
<li><a class="reference" href="#glep-formating-and-template" id="id19" name="id19">GLEP Formating and Template</a></li> |
64 |
|
|
<li><a class="reference" href="#glep-header-preamble" id="id20" name="id20">GLEP Header Preamble</a></li> |
65 |
|
|
<li><a class="reference" href="#reporting-glep-bugs-or-submitting-glep-updates" id="id21" name="id21">Reporting GLEP Bugs, or Submitting GLEP Updates</a></li> |
66 |
|
|
<li><a class="reference" href="#transferring-glep-ownership" id="id22" name="id22">Transferring GLEP Ownership</a></li> |
67 |
|
|
<li><a class="reference" href="#references-and-footnotes" id="id23" name="id23">References and Footnotes</a></li> |
68 |
|
|
<li><a class="reference" href="#copyright" id="id24" name="id24">Copyright</a></li> |
69 |
|
|
</ul> |
70 |
|
|
</div> |
71 |
|
|
<div class="section" id="credits"> |
72 |
|
|
<h1><a class="toc-backref" href="#id14" name="credits">Credits</a></h1> |
73 |
|
|
<p>The GLEP concept, and, in fact, much of the text of this document, |
74 |
|
|
is liberally stolen from Python's <a class="footnote-reference" href="#python" id="id1" name="id1">[1]</a> PEPs |
75 |
|
|
<a class="footnote-reference" href="#peps" id="id2" name="id2">[2]</a>, especially |
76 |
|
|
PEP-0001 <a class="footnote-reference" href="#pep1" id="id3" name="id3">[3]</a> by Barry A. Warsaw, Jeremy Hylton, and David Goodger.</p> |
77 |
|
|
</div> |
78 |
|
|
<div class="section" id="what-is-a-glep"> |
79 |
|
|
<h1><a class="toc-backref" href="#id15" name="what-is-a-glep">What is a GLEP?</a></h1> |
80 |
|
|
<p>GLEP stands for "Gentoo Linux Enhancement Proposal". A GLEP is a design |
81 |
|
|
document providing information to the Gentoo Linux community, or describing |
82 |
|
|
a new feature for Gentoo Linux. The GLEP should provide a concise technical |
83 |
|
|
specification of the feature and rationale for the feature.</p> |
84 |
|
|
<p>We intend GLEPs to be the primary mechanisms for proposing <em>significant</em> new |
85 |
|
|
features, for collecting community input on an issue, and for |
86 |
|
|
documenting the design decisions that have gone into Gentoo Linux. The GLEP |
87 |
|
|
author is responsible for building consensus within the community and |
88 |
|
|
documenting dissenting opinions.</p> |
89 |
|
|
<p>Because the GLEPs are maintained as text files under CVS control, their |
90 |
|
|
revision history is the historical record of the feature proposal |
91 |
|
|
<a class="footnote-reference" href="#cvs" id="id4" name="id4">[4]</a>.</p> |
92 |
|
|
</div> |
93 |
|
|
<div class="section" id="kinds-of-gleps"> |
94 |
|
|
<h1><a class="toc-backref" href="#id16" name="kinds-of-gleps">Kinds of GLEPs</a></h1> |
95 |
|
|
<p>There are two kinds of GLEPs. A Standards Track GLEP describes a new feature |
96 |
|
|
or implementation for Gentoo Linux. An Informational GLEP describes provides |
97 |
|
|
general guidelines or information to the Gentoo Linux community, but does not |
98 |
|
|
propose a new feature. Informational GLEPs do not necessarily represent a |
99 |
|
|
Gentoo Linux community consensus or recommendation, so users and implementors |
100 |
|
|
are free to ignore Informational GLEPs or follow their advice.</p> |
101 |
|
|
</div> |
102 |
|
|
<div class="section" id="glep-work-flow"> |
103 |
|
|
<h1><a class="toc-backref" href="#id17" name="glep-work-flow">GLEP Work Flow</a></h1> |
104 |
|
|
<p>The GLEP editors assign GLEP numbers and change their status. The current |
105 |
|
|
GLEP editors are Grant Goodyear and hopefully somebody else. Please send all |
106 |
|
|
GLEP-related email to <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>.</p> |
107 |
|
|
<p>The GLEP process begins with a new idea for Gentoo Linux. It is highly |
108 |
|
|
recommended that a single GLEP contain a single key proposal or new idea. The |
109 |
|
|
more focussed the GLEP, the more successful it tends to be. The GLEP editors |
110 |
|
|
reserve the right to reject GLEP proposals if they appear too unfocussed or |
111 |
|
|
too broad. If in doubt, split your GLEP into several well-focussed ones.</p> |
112 |
|
|
<p>Each GLEP must have a champion -- someone who writes the GLEP using the style |
113 |
|
|
and format described below, shepherds the discussions in the appropriate |
114 |
|
|
forums, and attempts to build community consensus around the idea. The GLEP |
115 |
|
|
champion (a.k.a. Author) should first attempt to ascertain whether the idea is |
116 |
|
|
GLEP-able. Small enhancements or patches often don't need a GLEP and can be |
117 |
|
|
injected into the Gentoo Linux development work flow with an enhancement "bug" |
118 |
|
|
submitted to the Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id5" name="id5">[6]</a>.</p> |
119 |
|
|
<p>The GLEP champion then emails the GLEP editor <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>> with a |
120 |
|
|
proposed title and a rough, but fleshed out, draft of the GLEP. This draft |
121 |
|
|
must be written in GLEP style as described below.</p> |
122 |
|
|
<p>If the GLEP editor approves, he will assign the GLEP a number, label it |
123 |
|
|
as Standards Track (a better name would be nice here -- suggestions?) |
124 |
|
|
or Informational, give it status "Draft", and |
125 |
|
|
create and check-in the initial draft of the GLEP. The GLEP editors will |
126 |
|
|
not unreasonably deny a GLEP. Reasons for denying GLEP status include |
127 |
|
|
duplication of effort, being technically unsound, not providing proper |
128 |
|
|
motivation or addressing backwards compatibility, or not in keeping |
129 |
|
|
with Gentoo Linux philosophy.</p> |
130 |
|
|
<p>If a pre-GLEP is rejected, the author may elect to take the pre-GLEP to the |
131 |
|
|
<a class="reference" href="mailto:gentoo-dev@gentoo.org">gentoo-dev@gentoo.org</a> mailing list to help flesh it out, gain feedback and |
132 |
|
|
consensus from the community at large, and improve the GLEP for re-submission.</p> |
133 |
|
|
<p>The author of the GLEP is then responsible for posting the GLEP to the |
134 |
|
|
gentoo-dev mailing list and to the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id6" name="id6">[7]</a>, and |
135 |
|
|
marshaling community support for it. As updates are necessary, the GLEP |
136 |
|
|
author can check in new versions if they have CVS commit permissions, or can |
137 |
|
|
email new GLEP versions to the GLEP editors for committing.</p> |
138 |
|
|
<p>Standards Track GLEPs consist of two parts, a design document and a reference |
139 |
|
|
implementation. The GLEP should be reviewed and accepted before a reference |
140 |
|
|
implementation is begun, unless a reference implementation will aid people in |
141 |
|
|
studying the GLEP. Standards Track GLEPs must include an implementation -- in |
142 |
|
|
the form of code, patch, or URL to same -- before it can be considered Final.</p> |
143 |
|
|
<p>GLEP authors are responsible for collecting community feedback on a GLEP |
144 |
|
|
before submitting it for review. A GLEP that has not been discussed on |
145 |
|
|
<a class="reference" href="mailto:gentoo-dev@gentoo.org">gentoo-dev@gentoo.org</a> and/or the Gentoo Linux forums <a class="footnote-reference" href="#forums" id="id7" name="id7">[7]</a> will not be |
146 |
|
|
accepted. However, wherever possible, long open-ended discussions on public |
147 |
|
|
mailing lists should be avoided. Strategies to keep the discussions efficient |
148 |
|
|
include setting up a specific forums thread for the topic, having the GLEP |
149 |
|
|
author accept private comments in the early design phases, etc. GLEP authors |
150 |
|
|
should use their discretion here.</p> |
151 |
|
|
<p>Once the authors have completed a GLEP, they must inform the GLEP editors that |
152 |
|
|
it is ready for review. GLEPs are reviewed by the Gentoo Linux Chief |
153 |
|
|
Architect or Development Manager, who may accept or reject a GLEP outright, or |
154 |
|
|
send it back to the author(s) for revision. For a GLEP that is pre-determined |
155 |
|
|
to be acceptable (e.g., it is an obvious win as-is and/or its implementation |
156 |
|
|
has already been checked in) the Chief Architect or the Development Manager |
157 |
|
|
may also initiate a GLEP review, first notifying the GLEP author(s) and giving |
158 |
|
|
them a chance to make revisions.</p> |
159 |
|
|
<p>For a GLEP to be accepted it must meet certain minimum criteria. It must be a |
160 |
|
|
clear and complete description of the proposed enhancement. The enhancement |
161 |
|
|
must represent a net improvement. The proposed implementation, if applicable, |
162 |
|
|
must be solid and must not complicate the distribution unduly. Finally, a |
163 |
|
|
proposed enhancement must satisfy the philosophy of Gentoo Linux.</p> |
164 |
|
|
<p>Once a GLEP has been accepted, the reference implementation must be completed. |
165 |
|
|
When the reference implementation is complete and accepted, the status will be |
166 |
|
|
changed to "Final".</p> |
167 |
|
|
<p>A GLEP can also be assigned status "Deferred". The GLEP author or editor can |
168 |
|
|
assign the GLEP this status when no progress is being made on the GLEP. Once |
169 |
|
|
a GLEP is deferred, the GLEP editor can re-assign it to draft status.</p> |
170 |
|
|
<p>A GLEP can also be "Rejected". Perhaps after all is said and done it was not |
171 |
|
|
a good idea. It is still important to have a record of this fact.</p> |
172 |
|
|
<p>GLEPs can also be replaced by a different GLEP, rendering the original |
173 |
|
|
obsolete (where version 2 of a policy, for example, might replace version 1).</p> |
174 |
|
|
<p>GLEP work flow is as follows:</p> |
175 |
|
|
<pre class="literal-block"> |
176 |
|
|
Draft -> Accepted -> Final -> Replaced |
177 |
|
|
^ |
178 |
|
|
+----> Rejected |
179 |
|
|
v |
180 |
|
|
Deferred |
181 |
|
|
</pre> |
182 |
|
|
<p>Some Informational GLEPs may also have a status of "Active" if they are never |
183 |
|
|
meant to be completed. E.g. GLEP 1 (this GLEP).</p> |
184 |
|
|
</div> |
185 |
|
|
<div class="section" id="what-belongs-in-a-successful-glep"> |
186 |
|
|
<h1><a class="toc-backref" href="#id18" name="what-belongs-in-a-successful-glep">What belongs in a successful GLEP?</a></h1> |
187 |
|
|
<p>Each GLEP should have the following parts:</p> |
188 |
|
|
<ol class="arabic"> |
189 |
|
|
<li><p class="first">Preamble -- <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style headers containing meta-data about the |
190 |
|
|
GLEP, including the GLEP number, a short descriptive title (limited |
191 |
|
|
to a maximum of 44 characters), the names, and optionally the |
192 |
|
|
contact info for each author, etc.</p> |
193 |
|
|
</li> |
194 |
|
|
<li><p class="first">Abstract -- a short (~200 word) description of the technical issue |
195 |
|
|
being addressed.</p> |
196 |
|
|
</li> |
197 |
|
|
<li><p class="first">Motivation -- The motivation is critical for GLEPs that want to |
198 |
|
|
change the Gentoo Linux functionality. It should clearly explain why the |
199 |
|
|
existing functionality or policy is inadequate to address the problem that |
200 |
|
|
the GLEP solves. GLEP submissions without sufficient motivation may be |
201 |
|
|
rejected outright.</p> |
202 |
|
|
</li> |
203 |
|
|
<li><p class="first">Specification -- The technical specification should describe the |
204 |
|
|
specific areas of Gentoo Linux that would be touched by this GLEP. If new |
205 |
|
|
functionality is being introduced, what packages will that functionality |
206 |
|
|
affect? If new policy, who will be affected?</p> |
207 |
|
|
</li> |
208 |
|
|
<li><p class="first">Rationale -- The rationale fleshes out the specification by |
209 |
|
|
describing what motivated the design and why particular design decisions |
210 |
|
|
were made. It should describe alternate designs that were considered and |
211 |
|
|
related work, e.g. how the feature is supported in other distributions.</p> |
212 |
|
|
<p>The rationale should provide evidence of consensus within the community and |
213 |
|
|
discuss important objections or concerns raised during discussion.</p> |
214 |
|
|
</li> |
215 |
|
|
<li><p class="first">Backwards Compatibility -- All GLEPs |
216 |
|
|
must include a section describing any issues of backwards incompatibilities |
217 |
|
|
and their severity. The GLEP must explain how the author proposes to deal |
218 |
|
|
with these incompatibilities. (Even if there are none, this section should |
219 |
|
|
be included to clearly state that fact.) GLEP submissions without a |
220 |
|
|
sufficient backwards compatibility treatise may be rejected outright.</p> |
221 |
|
|
</li> |
222 |
|
|
<li><p class="first">Reference Implementation -- The reference implementation must be |
223 |
|
|
completed before any GLEP is given status "Final", but it need not be |
224 |
|
|
completed before the GLEP is accepted. It is better to finish the |
225 |
|
|
specification and rationale first and reach consensus on it before writing |
226 |
|
|
code or significantly modifying ebuilds.</p> |
227 |
|
|
</li> |
228 |
|
|
<li><p class="first">Copyright/public domain -- Each GLEP must either be explicitly |
229 |
|
|
labelled as placed in the public domain (see this GLEP as an example) or |
230 |
|
|
licensed under the Open Publication License [#OPL].</p> |
231 |
|
|
</li> |
232 |
|
|
</ol> |
233 |
|
|
</div> |
234 |
|
|
<div class="section" id="glep-formating-and-template"> |
235 |
|
|
<h1><a class="toc-backref" href="#id19" name="glep-formating-and-template">GLEP Formating and Template</a></h1> |
236 |
|
|
<p>GLEPs are written in a just-barely-marked-up version of plain ASCII text |
237 |
|
|
called ReStructuredText <a class="footnote-reference" href="#resthome" id="id8" name="id8">[9]</a> that is then converted to HTML using |
238 |
|
|
Docutils <a class="footnote-reference" href="#docutils" id="id9" name="id9">[11]</a>. Using ReStructuredText GLEPs allows for rich markup |
239 |
|
|
that is still quite easy to read, but results in much better-looking and more |
240 |
|
|
functional HTML. Moreover, it should be straightforward to convert GLEPs to |
241 |
|
|
Gentoo Linux guide xml <a class="footnote-reference" href="#guidexml" id="id10" name="id10">[10]</a> if needed. GLEP 2 contains a boilerplate |
242 |
|
|
template <a class="footnote-reference" href="#rest" id="id11" name="id11">[5]</a> for use with ReStructuredText GLEPs.</p> |
243 |
|
|
</div> |
244 |
|
|
<div class="section" id="glep-header-preamble"> |
245 |
|
|
<h1><a class="toc-backref" href="#id20" name="glep-header-preamble">GLEP Header Preamble</a></h1> |
246 |
|
|
<p>Each GLEP must begin with an <a class="reference" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> style header preamble. The headers |
247 |
|
|
must appear in the following order. Headers marked with "*" are |
248 |
|
|
optional and are described below. All other headers are required.</p> |
249 |
|
|
<pre class="literal-block"> |
250 |
|
|
GLEP: <glep number> |
251 |
|
|
Title: <glep title> |
252 |
|
|
Version: <cvs version string> |
253 |
|
|
Last-Modified: <cvs date string> |
254 |
|
|
Author: <list of authors' real names and optionally, email addrs> |
255 |
|
|
* Discussions-To: <email address> |
256 |
|
|
Status: <Draft | Active | Accepted | Deferred | Rejected | |
257 |
|
|
Final | Replaced> |
258 |
|
|
Type: <Informational | Standards Track> |
259 |
|
|
* Content-Type: <text/plain | text/x-rst> |
260 |
|
|
* Requires: <glep numbers> |
261 |
|
|
Created: <date created on, in dd-mmm-yyyy format> |
262 |
|
|
Post-History: <dates of postings to gentoo-dev> |
263 |
|
|
* Replaces: <glep number> |
264 |
|
|
* Replaced-By: <glep number> |
265 |
|
|
</pre> |
266 |
|
|
<p>The Author header lists the names, and optionally the email addresses |
267 |
|
|
of all the authors/owners of the GLEP. The format of the Author header |
268 |
|
|
value must be</p> |
269 |
|
|
<blockquote> |
270 |
|
|
Random J. User <<a class="reference" href="mailto:address@dom.ain">address@dom.ain</a>></blockquote> |
271 |
|
|
<p>if the email address is included, and just</p> |
272 |
|
|
<blockquote> |
273 |
|
|
Random J. User</blockquote> |
274 |
|
|
<p>if the address is not given.</p> |
275 |
|
|
<p>If there are multiple authors, each should be on a separate line |
276 |
|
|
following <a class="reference" href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> continuation line conventions. Note that personal |
277 |
|
|
email addresses in GLEPs will be obscured as a defense against spam |
278 |
|
|
harvesters.</p> |
279 |
|
|
<p>While a GLEP is in private discussions (usually during the initial Draft |
280 |
|
|
phase), a Discussions-To header will indicate the mailing list or URL where |
281 |
|
|
the GLEP is being discussed. No Discussions-To header is necessary if the |
282 |
|
|
GLEP is being discussed privately with the author, or on the gentoo-dev |
283 |
|
|
mailing list. Note that email addresses in the Discussions-To header will not |
284 |
|
|
be obscured.</p> |
285 |
|
|
<p>The Type header specifies the type of GLEP: Informational or Standards |
286 |
|
|
Track.</p> |
287 |
|
|
<p>The format of a GLEP is specified with a Content-Type header, which for now |
288 |
|
|
should always read "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 |
289 |
|
|
<a class="footnote-reference" href="#rest" id="id12" name="id12">[5]</a>).</p> |
290 |
|
|
<p>The Created header records the date that the GLEP was assigned a number, while |
291 |
|
|
Post-History is used to record the dates of when new versions of the GLEP are |
292 |
|
|
posted to gentoo-dev. Both headers should be in dd-mmm-yyyy format, e.g. |
293 |
|
|
14-Aug-2001.</p> |
294 |
|
|
<p>GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP |
295 |
|
|
depends on.</p> |
296 |
|
|
<p>GLEPs may also have a Replaced-By header indicating that a GLEP has been |
297 |
|
|
rendered obsolete by a later document; the value is the number of the GLEP |
298 |
|
|
that replaces the current document. The newer GLEP must have a Replaces |
299 |
|
|
header containing the number of the GLEP that it rendered obsolete.</p> |
300 |
|
|
</div> |
301 |
|
|
<div class="section" id="reporting-glep-bugs-or-submitting-glep-updates"> |
302 |
|
|
<h1><a class="toc-backref" href="#id21" name="reporting-glep-bugs-or-submitting-glep-updates">Reporting GLEP Bugs, or Submitting GLEP Updates</a></h1> |
303 |
|
|
<p>How you report a bug, or submit a GLEP update depends on several factors, such |
304 |
|
|
as the maturity of the GLEP, the preferences of the GLEP author, and the |
305 |
|
|
nature of your comments. For the early draft stages of the GLEP, it's |
306 |
|
|
probably best to send your comments and changes directly to the GLEP author. |
307 |
|
|
For more mature, or finished GLEPs you may want to submit corrections to the |
308 |
|
|
Gentoo Linux bugzilla <a class="footnote-reference" href="#bugs" id="id13" name="id13">[6]</a> so that your changes don't get lost. If the GLEP |
309 |
|
|
author is a Gentoo Linux developer, assign the bug/patch to him, otherwise |
310 |
|
|
assign it to the GLEP editors.</p> |
311 |
|
|
<p>When in doubt about where to send your changes, please check first with the |
312 |
|
|
GLEP author and/or GLEP editors.</p> |
313 |
|
|
<p>GLEP authors who are also Gentoo Linux developers can update the GLEPs |
314 |
|
|
themselves by using "cvs commit" to commit their changes.</p> |
315 |
|
|
</div> |
316 |
|
|
<div class="section" id="transferring-glep-ownership"> |
317 |
|
|
<h1><a class="toc-backref" href="#id22" name="transferring-glep-ownership">Transferring GLEP Ownership</a></h1> |
318 |
|
|
<p>It occasionally becomes necessary to transfer ownership of GLEPs to a new |
319 |
|
|
champion. In general, we'd like to retain the original author as a co-author |
320 |
|
|
of the transferred GLEP, but that's really up to the original author. A good |
321 |
|
|
reason to transfer ownership is because the original author no longer has the |
322 |
|
|
time or interest in updating it or following through with the GLEP process, or |
323 |
|
|
has fallen off the face of the 'net (i.e. is unreachable or not responding to |
324 |
|
|
email). A bad reason to transfer ownership is because you don't agree with |
325 |
|
|
the direction of the GLEP. We try to build consensus around a GLEP, but if |
326 |
|
|
that's not possible, you can always submit a competing GLEP.</p> |
327 |
|
|
<p>If you are interested in assuming ownership of a GLEP, send a message asking |
328 |
|
|
to take over, addressed to both the original author and the GLEP editors |
329 |
|
|
<<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>. If the original author doesn't respond to email in a |
330 |
|
|
timely manner, the GLEP editors will make a unilateral decision (it's not like |
331 |
|
|
such decisions can't be reversed :).</p> |
332 |
|
|
</div> |
333 |
|
|
<div class="section" id="references-and-footnotes"> |
334 |
|
|
<h1><a class="toc-backref" href="#id23" name="references-and-footnotes">References and Footnotes</a></h1> |
335 |
|
|
<table class="footnote" frame="void" id="python" rules="none"> |
336 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
337 |
|
|
<tbody valign="top"> |
338 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id1" name="python">[1]</a></td><td><a class="reference" href="http://www.python.org">http://www.python.org</a></td></tr> |
339 |
|
|
</tbody> |
340 |
|
|
</table> |
341 |
|
|
<table class="footnote" frame="void" id="peps" rules="none"> |
342 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
343 |
|
|
<tbody valign="top"> |
344 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id2" name="peps">[2]</a></td><td><a class="reference" href="http://www.python.org/peps">http://www.python.org/peps</a></td></tr> |
345 |
|
|
</tbody> |
346 |
|
|
</table> |
347 |
|
|
<table class="footnote" frame="void" id="pep1" rules="none"> |
348 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
349 |
|
|
<tbody valign="top"> |
350 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id3" name="pep1">[3]</a></td><td><a class="reference" href="http://www.python.org/peps/pep-0001.html">http://www.python.org/peps/pep-0001.html</a></td></tr> |
351 |
|
|
</tbody> |
352 |
|
|
</table> |
353 |
|
|
<table class="footnote" frame="void" id="cvs" rules="none"> |
354 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
355 |
|
|
<tbody valign="top"> |
356 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id4" name="cvs">[4]</a></td><td>This historical record is available by the normal CVS commands |
357 |
|
|
for retrieving older revisions. For those without direct access to the CVS |
358 |
|
|
tree, you can browse the current and past GLEP revisions via the Gentoo |
359 |
|
|
Linux viewcvs web site at |
360 |
|
|
<a class="reference" href="http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/">http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/</a></td></tr> |
361 |
|
|
</tbody> |
362 |
|
|
</table> |
363 |
|
|
<table class="footnote" frame="void" id="rest" rules="none"> |
364 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
365 |
|
|
<tbody valign="top"> |
366 |
|
|
<tr><td class="label"><a name="rest">[5]</a></td><td><em>(<a class="fn-backref" href="#id11">1</a>, <a class="fn-backref" href="#id12">2</a>)</em> GLEP 2, Sample ReStructuredText GLEP Template, |
367 |
|
|
(<a class="reference" href="http://glep.gentoo.org/glep-0002.html">http://glep.gentoo.org/glep-0002.html</a>)</td></tr> |
368 |
|
|
</tbody> |
369 |
|
|
</table> |
370 |
|
|
<table class="footnote" frame="void" id="bugs" rules="none"> |
371 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
372 |
|
|
<tbody valign="top"> |
373 |
|
|
<tr><td class="label"><a name="bugs">[6]</a></td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id13">2</a>)</em> <a class="reference" href="http://bugs.gentoo.org">http://bugs.gentoo.org</a></td></tr> |
374 |
|
|
</tbody> |
375 |
|
|
</table> |
376 |
|
|
<table class="footnote" frame="void" id="forums" rules="none"> |
377 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
378 |
|
|
<tbody valign="top"> |
379 |
|
|
<tr><td class="label"><a name="forums">[7]</a></td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference" href="http://forums.gentoo.org">http://forums.gentoo.org</a></td></tr> |
380 |
|
|
</tbody> |
381 |
|
|
</table> |
382 |
|
|
<table class="footnote" frame="void" id="opl" rules="none"> |
383 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
384 |
|
|
<tbody valign="top"> |
385 |
|
|
<tr><td class="label"><a name="opl">[8]</a></td><td><a class="reference" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr> |
386 |
|
|
</tbody> |
387 |
|
|
</table> |
388 |
|
|
<table class="footnote" frame="void" id="resthome" rules="none"> |
389 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
390 |
|
|
<tbody valign="top"> |
391 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id8" name="resthome">[9]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/rst.html">http://docutils.sourceforge.net/rst.html</a></td></tr> |
392 |
|
|
</tbody> |
393 |
|
|
</table> |
394 |
|
|
<table class="footnote" frame="void" id="guidexml" rules="none"> |
395 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
396 |
|
|
<tbody valign="top"> |
397 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id10" name="guidexml">[10]</a></td><td><a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr> |
398 |
|
|
</tbody> |
399 |
|
|
</table> |
400 |
|
|
<table class="footnote" frame="void" id="docutils" rules="none"> |
401 |
|
|
<colgroup><col class="label" /><col /></colgroup> |
402 |
|
|
<tbody valign="top"> |
403 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id9" name="docutils">[11]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr> |
404 |
|
|
</tbody> |
405 |
|
|
</table> |
406 |
|
|
</div> |
407 |
|
|
<div class="section" id="copyright"> |
408 |
|
|
<h1><a class="toc-backref" href="#id24" name="copyright">Copyright</a></h1> |
409 |
|
|
<p>This document has been placed in the public domain.</p> |
410 |
|
|
</div> |
411 |
|
|
</div> |
412 |
|
|
|
413 |
|
|
<hr class="footer"/> |
414 |
|
|
<div class="footer"> |
415 |
|
|
<a class="reference" href="glep-0001.txt">View document source</a>. |
416 |
|
|
Generated on: 2003-06-02 17:37 UTC. |
417 |
|
|
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
418 |
|
|
</div> |
419 |
|
|
</body> |
420 |
|
|
</html> |
421 |
|
|
|