From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id D4D4C138247 for ; Sat, 4 Jan 2014 20:07:52 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id D3F78E09DA; Sat, 4 Jan 2014 20:07:50 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id ED1DCE09B7 for ; Sat, 4 Jan 2014 20:07:49 +0000 (UTC) Received: from [192.168.1.5] (unknown [184.53.2.97]) (using TLSv1 with cipher ECDHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: creffett) by smtp.gentoo.org (Postfix) with ESMTPSA id 2BE1033F5C8 for ; Sat, 4 Jan 2014 20:07:44 +0000 (UTC) Message-ID: <52C869FC.2060905@gentoo.org> Date: Sat, 04 Jan 2014 15:07:24 -0500 From: Chris Reffett User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.2.0 Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Project discussion list X-BeenThere: gentoo-project@lists.gentoo.org Reply-To: gentoo-project@lists.gentoo.org MIME-Version: 1.0 To: gentoo-project@lists.gentoo.org Subject: Re: [gentoo-project] Re: Call for agenda items - Council meeting 2014-01-14 References: <21192.25853.372116.249167@a1i15.kph.uni-mainz.de> In-Reply-To: <21192.25853.372116.249167@a1i15.kph.uni-mainz.de> X-Enigmail-Version: 1.6 Content-Type: multipart/mixed; boundary="------------000401040602000603000307" X-Archives-Salt: 46b2d06f-05f5-485a-bd2e-b5a5da039e34 X-Archives-Hash: bd7d764266483eeea40e46e9e2b266be This is a multi-part message in MIME format. --------------000401040602000603000307 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On 01/04/2014 02:46 PM, Ulrich Mueller wrote: > In less than two weeks from now, the council will meet again. This > is the time to raise and prepare items that the council should put > on the agenda to discuss or vote on. > > Please respond to this message with agenda items. Do not hesitate > to repeat your agenda item here with a pointer if you previously > suggested one (since the last meeting). > > The agenda for the next meeting will be sent out on Tuesday > 2014-01-07. > > Please respond to the gentoo-project list, if possible. > > Ulrich > I ask that the council vote on my proposed changes to GLEP 1 and 2, discussion is at http://article.gmane.org/gmane.linux.gentoo.project/3211 and http://thread.gmane.org/gmane.linux.gentoo.project/3213. I have re-attached the patches here for convenience; the long rationales for each patch can be found in the first link, but here's a quick summary of each: 1. Remove the names of "Current GLEP Editors" 2. Allow non-technical GLEP discussion to be on gentoo-project (since we do that anyway) 3. Workflow change: move GLEP submission and modification to bugzilla instead of emailing only to glep@. 4. Clarification of what changes should go to Council (this wording has any changes which affect the meaning of the GLEP go through council, nobody objected to that) 5. Remove GuideXML as a GLEP format. None use it right now. 6. Workflow change: move GLEP storage to the Wiki, significantly changing the formatting and headers of GLEPs. If this is approved, please also consider and approve the changes to GLEP 2 found at https://wiki.gentoo.org/wiki/User:Creffett/GLEP2 (see below). 7. Change the copyright from OPL/public domain to CC-BY-SA 3.0 to be compatible with the wiki. Allows the few existing OPL GLEPs to stay as-is but strongly encourages a relicense with author consent. Going with item 6, I also have a couple of drafts of how the Wiki-format GLEPs would look. https://wiki.gentoo.org/wiki/User:Creffett/GLEP2 is a full conversion of GLEP 2 to Wiki markup and changes the GLEP's formatting explanations to reflect Wiki markup instead of ReST. a3li has also added a demonstration of the GLEP namespace at https://wiki.gentoo.org/wiki/GLEP:1. Chris Reffett -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.22 (GNU/Linux) Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iKYEARECAGYFAlLIafxfFIAAAAAALgAoaXNzdWVyLWZwckBub3RhdGlvbnMub3Bl bnBncC5maWZ0aGhvcnNlbWFuLm5ldEM2NzU5RjUyMDczREJDQkVDQTBDRkE1NERC Nzk1QThBNDI2MTgzNTQACgkQ23laikJhg1RvQwCfQ8nOi/dulinBCCDQ9CAwZHU0 AlsAoKVaxhlc/KvKtF8NxfN5e9/CcJQV =/t3Q -----END PGP SIGNATURE----- --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt" GLEP: 1 Title: GLEP Purpose and Guidelines Version: $Revision: 1.14 $ Last-Modified: $Date: 2013/06/12 00:40:24 $ Author: Grant Goodyear Status: Active Type: Informational Content-Type: text/x-rst Created: 31-May-2003 Post-History: 1-Jun-2003, 2-Jul-2003, 19-Jan-2008, 05-Jun-2008, 09-Mar-2011 Credits ======= The GLEP concept, and, in fact, much of the text of this document, is liberally stolen from Python's [#Python]_ PEPs [#PEPS]_, especially PEP-0001 [#PEP1]_ by Barry A. Warsaw, Jeremy Hylton, and David Goodger. 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 specification of the feature and rationale for the feature. We intend GLEPs to be the primary mechanisms for proposing *significant* new features, for collecting community input on an issue, and for documenting the design decisions that have gone into Gentoo Linux. The GLEP author is responsible for building consensus within the community and 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 [#CVS]_. 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 propose a new feature. Informational GLEPs do not necessarily represent a Gentoo Linux community consensus or recommendation, so users and implementors are free to ignore Informational GLEPs or follow their advice. 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 . 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 focused the GLEP, the more successful it tends to be. The GLEP editors reserve the right to reject GLEP proposals if they appear too unfocused or too broad. If in doubt, split your GLEP into several well-focused ones. Each GLEP must have a champion -- someone who writes the GLEP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The GLEP 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 [#BUGS]_. The GLEP champion then emails the GLEP editors 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 it as Standards Track (a better name would be nice here -- suggestions?) or Informational, give it status "Draft", and create and check-in the initial draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP. Reasons for denying GLEP status include duplication of effort, being 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 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 additionally to the Gentoo Linux forums [#FORUMS]_ 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 studying the GLEP. Standards Track GLEPs must include an implementation -- in 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 the Gentoo Linux forums [#FORUMS]_ 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 Gentoo Council [#COUNCIL]_ 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, must be solid and must not complicate the distribution unduly. Finally, a proposed enhancement must satisfy the philosophy of Gentoo Linux. Once a GLEP has been accepted, the reference implementation must be completed. When the reference implementation is complete and accepted, the status will be changed to "Final". A GLEP can also be assigned status "Deferred". The GLEP author or editor can assign the GLEP this status when no progress is being made on the GLEP. Once a GLEP is deferred, the GLEP editor can re-assign it to draft status. A GLEP can also be "Rejected". Perhaps after all is said and done it was not a good idea. It is still important to have a record of this fact. GLEPs can also be replaced by a different GLEP, rendering the original obsolete (where version 2 of a policy, for example, might replace version 1). GLEP work flow is as follows:: Draft -> Accepted -> Final -> Replaced ^ +----> Rejected v Deferred 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? ================================== Each GLEP should have the following parts: 1. 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. 2. Abstract -- a short (~200 word) description of the technical issue being addressed. 3. Motivation -- The motivation is critical for GLEPs that want to 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. 4. Specification -- The technical specification should describe the specific areas of Gentoo Linux that would be touched by this GLEP. If new functionality is being introduced, what packages will that functionality affect? If new policy, who will be affected? 5. Rationale -- The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other distributions. The rationale should provide evidence of consensus within the community and discuss important objections or concerns raised during discussion. 6. 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 be included to clearly state that fact.) GLEP submissions without a sufficient backwards compatibility treatise may be rejected outright. 7. Reference Implementation -- The reference implementation must be completed before any GLEP is given status "Final", but it need not be completed before the GLEP is accepted. It is better to finish the specification and rationale first and reach consensus on it before writing code or significantly modifying ebuilds. 8. Copyright/public domain -- Each GLEP must either be explicitly labelled as placed in the public domain (see this GLEP as an example) or licensed under the Open Publication License [#OPL]. GLEP Formating and Template =========================== GLEPs are written either in Gentoo Linux Guide-XML [#GUIDEXML]_ or in a just-barely-marked-up version of plain ASCII text called ReStructuredText [#ReSTHOME]_ that is then converted to HTML using Docutils [#DOCUTILS]_. 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 [#GUIDEXML]_ if needed. GLEP 2 contains a boilerplate template [#ReST]_ for use with ReStructuredText GLEPs. 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. :: GLEP: Title: Version: Last-Modified: Author: * Discussions-To: Status: Type: * Content-Type: * Requires: Created: Post-History: * Replaces: * Replaced-By: The Author header lists the names, and optionally the email addresses of all the authors/owners of the GLEP. The format of the Author header value must be Random J. User 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 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 phase), a Discussions-To header will indicate the mailing list or URL where the GLEP is being discussed. No Discussions-To header is necessary if the GLEP is being discussed privately with the author, or on the gentoo-dev mailing list. Note that email addresses in the Discussions-To header will not 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 "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 [#ReST]_). 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. 14-Aug-2001. GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP depends on. GLEPs may also have a Replaced-By header indicating that a GLEP has been rendered obsolete by a later document; the value is the number of the GLEP 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 =============================================== 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 [#BUGS]_ 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 GLEP author and/or GLEP editors. GLEP authors who are also Gentoo Linux developers can update the GLEPs themselves by using "cvs commit" to commit their changes. 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 reason to transfer ownership is because the original author no longer has the time or interest in updating it or following through with the GLEP process, or has fallen off the face of the 'net (i.e. is unreachable or not responding to email). A bad reason to transfer ownership is because you don't agree with the direction of the GLEP. We try to build consensus around a GLEP, but if 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 . 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 ======================== .. [#PYTHON] http://www.python.org .. [#PEPS] http://www.python.org/peps .. [#PEP1] http://www.python.org/peps/pep-0001.html .. [#CVS] 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/ .. [#ReST] GLEP 2, Sample ReStructuredText GLEP Template, (http://glep.gentoo.org/glep-0002.html) .. [#BUGS] http://bugs.gentoo.org .. [#FORUMS] http://forums.gentoo.org .. [#COUNCIL] http://www.gentoo.org/proj/en/glep/glep-0039.html .. [#OPL] http://www.opencontent.org/openpub/ .. [#ReSTHOME] http://docutils.sourceforge.net/rst.html .. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml .. [#DOCUTILS] http://docutils.sourceforge.net/ Copyright ========= This document has been placed in the public domain. --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt.1.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt.1.diff" --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.1 2013-12-13 23:23:27.188164895 -0500 @@ -50,8 +50,7 @@ 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 +The GLEP editors assign GLEP numbers and change their status. Please send all GLEP-related email to . The GLEP process begins with a new idea for Gentoo Linux. It is highly --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt.2.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt.2.diff" --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.2 2013-12-13 23:32:53.190162835 -0500 @@ -81,14 +81,16 @@ 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 -consensus from the community at large, and improve the GLEP for re-submission. +gentoo-dev@gentoo.org mailing list (for Standards Track GLEPs) or the +gentoo-project@gentoo.org mailing list (for Informational GLEPs) 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 additionally to the Gentoo Linux forums [#FORUMS]_ -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. +gentoo-dev or gentoo-project mailing list (and additionally to the Gentoo Linux +forums [#FORUMS]_ 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 @@ -98,7 +100,7 @@ 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 the Gentoo Linux forums [#FORUMS]_ will not be +the mailing lists and the Gentoo Linux forums [#FORUMS]_ 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 @@ -106,7 +108,7 @@ should use their discretion here. Once the authors have completed a GLEP, they must inform the Gentoo Council -[#COUNCIL]_ that it is ready for review by way of the gentoo-dev mailing +[#COUNCIL]_ that it is ready for review by way of the appropriate 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 @@ -227,7 +229,7 @@ * Content-Type: * Requires: Created: - Post-History: + Post-History: * Replaces: * Replaced-By: @@ -251,7 +253,7 @@ While a GLEP is in private discussions (usually during the initial Draft phase), a Discussions-To header will indicate the mailing list or URL where the GLEP is being discussed. No Discussions-To header is necessary if the -GLEP is being discussed privately with the author, or on the gentoo-dev +GLEP is being discussed privately with the author, or on the appropriate mailing list. Note that email addresses in the Discussions-To header will not be obscured. @@ -265,8 +267,8 @@ 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. -14-Aug-2001. +posted to gentoo-dev or gentoo-project. Both headers should be in dd-mmm-yyyy +format, e.g. 14-Aug-2001. GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP depends on. --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt.3.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt.3.diff" --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.3 2013-12-13 23:45:14.254160138 -0500 @@ -68,9 +68,9 @@ injected into the Gentoo Linux development work flow with an enhancement "bug" submitted to the Gentoo Linux bugzilla [#BUGS]_. -The GLEP champion then emails the GLEP editors 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. +The GLEP champion then files a bug on bugzilla in the GLEP product, under the +"New GLEP" component 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 it as Standards Track (a better name would be nice here -- suggestions?) or @@ -111,7 +111,8 @@ 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. +by the Gentoo developer community. Any revisions should be added to the bugzilla +bug. 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 @@ -283,11 +284,11 @@ 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 [#BUGS]_ 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. +probably best to send your comments and changes directly to the GLEP author or +comment on the GLEP bug. For more mature, or finished GLEPs you may want to +submit corrections to the Gentoo Linux bugzilla [#BUGS]_ under the "GLEP Updates" +component of the GLEP product so that your changes don't get lost. Be sure to +CC the GLEP author on the bug. When in doubt about where to send your changes, please check first with the GLEP author and/or GLEP editors. @@ -310,9 +311,9 @@ 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 -. 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 :). +, or comment on the GLEP bug. 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 --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.3 2013-12-14 00:18:49.786152802 -0500 @@ -68,9 +68,9 @@ injected into the Gentoo Linux development work flow with an enhancement "bug" submitted to the Gentoo Linux bugzilla [#BUGS]_. -The GLEP champion then emails the GLEP editors 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. +The GLEP champion then files a bug on bugzilla in the GLEP product, under the +"New GLEP" component 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 it as Standards Track (a better name would be nice here -- suggestions?) or @@ -111,7 +111,8 @@ 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. +by the Gentoo developer community. Any revisions should be added to the bugzilla +bug. 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 @@ -230,6 +231,7 @@ Post-History: * Replaces: * Replaced-By: + * Bug-Number: The Author header lists the names, and optionally the email addresses of all the authors/owners of the GLEP. The format of the Author header @@ -276,6 +278,8 @@ that replaces the current document. The newer GLEP must have a Replaces header containing the number of the GLEP that it rendered obsolete. +New GLEPs should have their bugzilla bug ID in the Bug-Number field. Older +GLEPs which did not go through bugzilla may omit this field Reporting GLEP Bugs, or Submitting GLEP Updates =============================================== @@ -283,11 +287,11 @@ 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 [#BUGS]_ 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. +probably best to send your comments and changes directly to the GLEP author or +comment on the GLEP bug. For more mature, or finished GLEPs you may want to +submit corrections to the Gentoo Linux bugzilla [#BUGS]_ under the "GLEP Updates" +component of the GLEP product so that your changes don't get lost. Be sure to +CC the GLEP author on the bug. When in doubt about where to send your changes, please check first with the GLEP author and/or GLEP editors. @@ -310,9 +314,9 @@ 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 -. 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 :). +, or comment on the GLEP bug. 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 --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt.4.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt.4.diff" --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.4 2013-12-13 23:57:19.756157497 -0500 @@ -293,7 +293,11 @@ GLEP author and/or GLEP editors. GLEP authors who are also Gentoo Linux developers can update the GLEPs -themselves by using "cvs commit" to commit their changes. +themselves by using "cvs commit" to commit their changes. + +Any major updates to GLEPs (that is, those that change the content of the GLEP +rather than just fixing typos or adding small clarifications) should be +approved by the Gentoo Council before being committed. Transferring GLEP Ownership =========================== --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt.5.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt.5.diff" --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.5 2013-12-13 23:58:35.608157221 -0500 @@ -198,13 +198,11 @@ GLEP Formating and Template =========================== -GLEPs are written either in Gentoo Linux Guide-XML [#GUIDEXML]_ or in -a just-barely-marked-up version of plain ASCII text +GLEPs are written in a just-barely-marked-up version of plain ASCII text called ReStructuredText [#ReSTHOME]_ that is then converted to HTML using Docutils [#DOCUTILS]_. 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 [#GUIDEXML]_ if needed. GLEP 2 contains a boilerplate +functional HTML. GLEP 2 contains a boilerplate template [#ReST]_ for use with ReStructuredText GLEPs. @@ -259,8 +257,7 @@ Track. 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 +should read "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 [#ReST]_). The Created header records the date that the GLEP was assigned a number, while @@ -343,8 +340,6 @@ .. [#ReSTHOME] http://docutils.sourceforge.net/rst.html -.. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml - .. [#DOCUTILS] http://docutils.sourceforge.net/ --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt.6.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt.6.diff" --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.6 2013-12-26 21:27:55.221844124 -0500 @@ -31,7 +31,8 @@ author is responsible for building consensus within the community and documenting dissenting opinions. -Because the GLEPs are maintained as text files under CVS control, their +Because the GLEPs are maintained as Wiki pages, their edit history is publicly +viewable. For the older GLEPs which started out in CVS, their revision history is the historical record of the feature proposal [#CVS]_. @@ -75,10 +76,11 @@ If the GLEP editor accepts the GLEP, he will assign the GLEP a number, label it as Standards Track (a better name would be nice here -- suggestions?) or Informational, give it status "Draft", and create and check-in the initial -draft of the GLEP. The GLEP editors will not unreasonably deny a GLEP. -Reasons for denying GLEP status include duplication of effort, being -technically unsound, not providing proper motivation or addressing backwards -compatibility, or not in keeping with Gentoo Linux philosophy. +draft of the GLEP on the Wiki in the GLEP namespace. The GLEP editors will +not unreasonably deny a GLEP. Reasons for denying GLEP status include +duplication of effort, being 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 @@ -87,8 +89,8 @@ The author of the GLEP is then responsible for posting the GLEP to the gentoo-dev mailing list (and additionally to the Gentoo Linux forums [#FORUMS]_ 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. +necessary, the GLEP author should request changes to the Wiki page from a GLEP +editor. Standards Track GLEPs consist of two parts, a design document and a reference implementation. The GLEP should be reviewed and accepted before a reference @@ -198,38 +200,28 @@ GLEP Formating and Template =========================== -GLEPs are written either in Gentoo Linux Guide-XML [#GUIDEXML]_ or in -a just-barely-marked-up version of plain ASCII text -called ReStructuredText [#ReSTHOME]_ that is then converted to HTML using -Docutils [#DOCUTILS]_. 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 [#GUIDEXML]_ if needed. GLEP 2 contains a boilerplate -template [#ReST]_ for use with ReStructuredText GLEPs. +GLEPs are written in Wiki markup [#WIKIMARKUP]_, which is a markup language +compatible with MediaWiki. This format is both human-readable and displays +well on the Gentoo Wiki. GLEP 2 contains a boilerplate template +[#WIKITEMPL]_ for use with Wiki markup GLEPs. - -GLEP Header Preamble +GLEP Header ==================== -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. :: +Every GLEP has certain attributes associated with it. When a GLEP is sent +to the mailing lists for discussion, it should 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. :: GLEP: Title: - Version: - Last-Modified: Author: - * Discussions-To: Status: Type: - * Content-Type: * Requires: - Created: - Post-History: * Replaces: - * Replaced-By: The Author header lists the names, and optionally the email addresses of all the authors/owners of the GLEP. The format of the Author header @@ -248,33 +240,21 @@ 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 -phase), a Discussions-To header will indicate the mailing list or URL where -the GLEP is being discussed. No Discussions-To header is necessary if the -GLEP is being discussed privately with the author, or on the gentoo-dev -mailing list. Note that email addresses in the Discussions-To header will not -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 -"text/x-rst" for ReStructuredText GLEPs (see GLEP 2 -[#ReST]_). - -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. -14-Aug-2001. - GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP depends on. -GLEPs may also have a Replaced-By header indicating that a GLEP has been -rendered obsolete by a later document; the value is the number of the GLEP -that replaces the current document. The newer GLEP must have a Replaces -header containing the number of the GLEP that it rendered obsolete. + +A GLEP may have a Replaces header, which indicates that this GLEP supersedes +a previous one. This header should contain the number of the GLEP that this +one renders obsolete. + +When the GLEP editor enters the GLEP into the Wiki, they will be automatically +prompted for the contents of these fields, which will then be associated with +the GLEP as metadata. The version of the GLEP stored on the Wiki should not +contain the RFC 2822 headers as part of the body of the GLEP. Reporting GLEP Bugs, or Submitting GLEP Updates @@ -292,8 +272,8 @@ When in doubt about where to send your changes, please check first with the GLEP author and/or GLEP editors. -GLEP authors who are also Gentoo Linux developers can update the GLEPs -themselves by using "cvs commit" to commit their changes. +GLEP authors must have a GLEP editor commit their changes to the Wiki, as the +GLEP namespace is restricted to GLEP editors. Transferring GLEP Ownership =========================== @@ -330,7 +310,7 @@ Linux viewcvs web site at http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/ -.. [#ReST] GLEP 2, Sample ReStructuredText GLEP Template, +.. [#GLEP2] GLEP 2, Sample ReStructuredText GLEP Template, (http://glep.gentoo.org/glep-0002.html) .. [#BUGS] http://bugs.gentoo.org @@ -341,9 +321,7 @@ .. [#OPL] http://www.opencontent.org/openpub/ -.. [#ReSTHOME] http://docutils.sourceforge.net/rst.html - -.. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml +.. [#WIKIMARKUP] http://en.wikipedia.org/wiki/Help:Wiki_markup .. [#DOCUTILS] http://docutils.sourceforge.net/ --------------000401040602000603000307 Content-Type: text/plain; charset=UTF-8; name="glep-0001.txt.7.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="glep-0001.txt.7.diff" --- glep-0001.txt 2013-12-13 23:13:04.421167161 -0500 +++ glep-0001.txt.7 2013-12-27 12:28:19.161563324 -0500 @@ -190,9 +190,12 @@ specification and rationale first and reach consensus on it before writing code or significantly modifying ebuilds. -8. Copyright/public domain -- Each GLEP must either be explicitly - labelled as placed in the public domain (see this GLEP as an example) or - licensed under the Open Publication License [#OPL]. +8. Copyright -- Every new GLEP must be explicitly labelled as licensed under + the Creative Commons Attribution-ShareAlike (CC-BY-SA) license, version 3.0. + Older GLEPs in the public domain should be relicensed to CC-BY-SA 3.0 when + they are moved to the Wiki. GLEPs released under the Open Publication + License (OPL) may remain as-is, but are strongly encouraged to be relicensed + under CC-BY-SA 3.0 with the consent of all authors. GLEP Formating and Template @@ -339,8 +342,6 @@ .. [#COUNCIL] http://www.gentoo.org/proj/en/glep/glep-0039.html -.. [#OPL] http://www.opencontent.org/openpub/ - .. [#ReSTHOME] http://docutils.sourceforge.net/rst.html .. [#GUIDEXML] http://www.gentoo.org/doc/en/xml-guide.xml @@ -351,4 +352,4 @@ Copyright ========= -This document has been placed in the public domain. +This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/. --------------000401040602000603000307--