Gentoo Archives: gentoo-project

From: "Michał Górny" <mgorny@g.o>
To: gentoo-project@l.g.o
Cc: "Michał Górny" <mgorny@g.o>
Subject: [gentoo-project] [PATCH 01/18] glep-0001: Update for the git workflow
Date: Thu, 14 Sep 2017 19:03:40
Message-Id: 20170914190326.12168-2-mgorny@gentoo.org
In Reply to: [gentoo-project] [RFC] GLEP 1/2 updates for the new old-school GLEP workflow by "Michał Górny"
1 ---
2 glep-0001.txt | 42 ++++++++++++++++++++----------------------
3 1 file changed, 20 insertions(+), 22 deletions(-)
4
5 diff --git a/glep-0001.txt b/glep-0001.txt
6 index 67bfd0c..452d5ba 100644
7 --- a/glep-0001.txt
8 +++ b/glep-0001.txt
9 @@ -32,9 +32,11 @@ documenting the design decisions that have gone into Gentoo Linux. The GLEP
10 author is responsible for building consensus within the community and
11 documenting dissenting opinions.
12
13 -Because the GLEPs are maintained as Wiki pages, their edit history is
14 -publicly viewable. For the older GLEPs which started out in CVS, their
15 -revision history is the historical record of the feature proposal [#CVS]_.
16 +Because the GLEPs are maintained as text files in a VCS, their revision
17 +history is the historical record of the feature proposal [#VCS]_. For older
18 +GLEPs, the base repository may provide an approximate history of the changes.
19 +The original changes can still be found in [#CVS]_ for changes up to June 2013
20 +and/or [#WIKI]_ for changes onwards up to September 2017.
21
22
23 Kinds of GLEPs
24 @@ -69,14 +71,15 @@ injected into the Gentoo Linux development work flow with an enhancement "bug"
25 submitted to the Gentoo Linux bugzilla [#BUGS]_.
26
27 The GLEP champion then files a bug on Bugzilla in the GLEP product, under
28 -the "New GLEP submissions" component of the "Documentation" product with
29 -a proposed title and a rough, but fleshed out, draft of the GLEP. This
30 +the "New GLEP submissions" component of the "Documentation" product
31 +and prepares a rough, but fleshed out, draft of the GLEP on a dedicated
32 +branch of the GLEP repository or a private fork of that repository. This
33 draft must be written in GLEP style as described below and in GLEP 2.
34
35 If the GLEP editors accept the GLEP, they will assign the GLEP a number, label
36 it as Standards Track (a better name would be nice here -- suggestions?) or
37 -Informational, give it status "Draft", and create and check-in the initial
38 -draft of the GLEP on the Wiki in the GLEP namespace. The GLEP editors will
39 +Informational, give it status "Draft", and merge the initial draft of the GLEP
40 +to the master branch of the repository. The GLEP editors will
41 not unreasonably deny a GLEP. Reasons for denying GLEP status include
42 duplication of effort, being technically unsound, not providing proper
43 motivation or addressing backwards compatibility, or not in keeping with
44 @@ -92,7 +95,7 @@ The author of the GLEP is then responsible for posting the GLEP to
45 the gentoo-dev or gentoo-project mailing list (and additionally to
46 the Gentoo Linux forums [#FORUMS]_ if they so desire), and marshaling community
47 support for it. As updates are necessary, the GLEP author should request
48 -changes to the Wiki page from a GLEP editor.
49 +merging changes to the master branch from a GLEP editor.
50
51 Standards Track GLEPs consist of two parts, a design document and a reference
52 implementation. The GLEP should be reviewed and accepted before a reference
53 @@ -200,7 +203,7 @@ Each GLEP should have the following parts:
54 8. Copyright -- Every new GLEP must be explicitly labelled
55 as licensed under the Creative Commons Attribution-ShareAlike (CC-BY-SA)
56 license, version 3.0 [#CC-BY-SA3.0]_. Older GLEPs in the public domain
57 - should be relicensed to CC-BY-SA 3.0 when they are moved to the Wiki.
58 + should be relicensed to CC-BY-SA 3.0 when they are updated.
59 GLEPs released under the Open Publication License (OPL) may remain
60 as-is, but are strongly encouraged to be relicensed under CC-BY-SA
61 3.0 with the consent of all authors.
62 @@ -258,11 +261,6 @@ A GLEP may have a Replaces header, which indicates that this GLEP supersedes
63 a previous one. This header should contain the number of the GLEP that this
64 one renders obsolete.
65
66 -When the GLEP editor enters the GLEP into the Wiki, they will be automatically
67 -prompted for the contents of these fields, which will then be associated with
68 -the GLEP as metadata. The version of the GLEP stored on the Wiki should
69 -not contain the RFC 2822 headers as part of the body of the GLEP.
70 -
71
72 Reporting GLEP Bugs, or Submitting GLEP Updates
73 ===============================================
74 @@ -278,13 +276,13 @@ lost. Be sure to CC the GLEP author on the bug. When in doubt about where
75 to send your changes, please check first with the GLEP author and/or GLEP
76 editors.
77
78 -GLEP authors must have a GLEP editor commit their changes to the Wiki,
79 -as the GLEP namespace is restricted to GLEP editors in order to protect
80 +GLEP authors must have a GLEP editor merge their changes to the master branch,
81 +as the write access is restricted to GLEP editors in order to protect
82 the integrity of the GLEPs.
83
84 Any major updates to GLEPs (that is, those that change the content of
85 the GLEP rather than just fixing typos or adding small clarifications)
86 -should be approved by the Gentoo Council before being committed.
87 +should be approved by the Gentoo Council before being merged.
88
89
90 Transferring GLEP Ownership
91 @@ -316,11 +314,11 @@ References and Footnotes
92
93 .. [#PEP1] http://www.python.org/peps/pep-0001.html
94
95 -.. [#CVS] This historical record is available by the normal CVS commands
96 - for retrieving older revisions. For those without direct access to the CVS
97 - tree, you can browse the current and past GLEP revisions via the Gentoo
98 - Linux viewcvs web site at
99 - http://www.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/
100 +.. [#VCS] https://gitweb.gentoo.org/proj/glep.git
101 +
102 +.. [#CVS] https://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo/xml/htdocs/proj/en/glep/
103 +
104 +.. [#WIKI] https://wiki.gentoo.org/index.php?title=Special%3AAllPages&from=&to=&namespace=550
105
106 .. [#BUGS] http://bugs.gentoo.org
107
108 --
109 2.14.1