| 1 | <?xml version="1.0" encoding="utf-8" ?> |
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"> |
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"> |
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 4 | <!-- |
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> |
5 | <head> |
| 10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 11 | <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" /> |
7 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
| 12 | <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title> |
8 | <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title> |
| 13 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
9 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
| 14 | </head> |
10 | </head> |
| 15 | <body bgcolor="white"> |
11 | <body bgcolor="white"> |
| 16 | <table class="navigation" cellpadding="0" cellspacing="0" |
12 | <table class="navigation" cellpadding="0" cellspacing="0" |
| … | |
… | |
| 20 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
16 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
| 21 | border="0" width="150" height="35" /></a></td> |
17 | border="0" width="150" height="35" /></a></td> |
| 22 | <td class="textlinks" align="left"> |
18 | <td class="textlinks" align="left"> |
| 23 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
19 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
| 24 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
20 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
| 25 | [<b><a href="./glep-0024.txt">GLEP Source</a></b>] |
21 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0024.txt">GLEP Source</a></b>] |
| 26 | </td></tr></table> |
22 | </td></tr></table> |
| 27 | <div class="document"> |
|
|
| 28 | <table class="rfc2822 field-list" frame="void" rules="none"> |
23 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
| 29 | <col class="field-name" /> |
24 | <col class="field-name" /> |
| 30 | <col class="field-body" /> |
25 | <col class="field-body" /> |
| 31 | <tbody valign="top"> |
26 | <tbody valign="top"> |
| 32 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td> |
27 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td> |
| 33 | </tr> |
28 | </tr> |
| 34 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td> |
29 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td> |
| 35 | </tr> |
30 | </tr> |
| 36 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td> |
31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.5</td> |
| 37 | </tr> |
32 | </tr> |
| 38 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0024.txt?cvsroot=gentoo">2004/10/25 16:53:16</a></td> |
33 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0024.txt?cvsroot=gentoo">2006/07/07 06:08:10</a></td> |
| 39 | </tr> |
34 | </tr> |
| 40 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Donnie Berkholz <spyderous at gentoo.org>,</td> |
35 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Donnie Berkholz <dberkholz at gentoo.org>,</td> |
| 41 | </tr> |
36 | </tr> |
| 42 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td> |
37 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td> |
| 43 | </tr> |
38 | </tr> |
| 44 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td> |
39 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td> |
| 45 | </tr> |
40 | </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> |
41 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> |
| 47 | </tr> |
42 | </tr> |
| 48 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td> |
43 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td> |
| 49 | </tr> |
44 | </tr> |
| 50 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004, 25-Oct-2004</td> |
45 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004, 25-Oct-2004</td> |
| 51 | </tr> |
46 | </tr> |
| 52 | </tbody> |
47 | </tbody> |
| 53 | </table> |
48 | </table> |
| 54 | <hr /> |
49 | <hr /> |
| 55 | <div class="contents topic" id="contents"> |
50 | <div class="contents topic"> |
| 56 | <p class="topic-title first"><a name="contents">Contents</a></p> |
51 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
| 57 | <ul class="simple"> |
52 | <ul class="simple"> |
| 58 | <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> |
53 | <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> |
| 59 | <li><a class="reference" href="#status-update" id="id3" name="id3">Status Update</a></li> |
54 | <li><a class="reference" href="#status-update" id="id3" name="id3">Status Update</a></li> |
| 60 | <li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li> |
55 | <li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li> |
| 61 | <li><a class="reference" href="#specification" id="id5" name="id5">Specification</a></li> |
56 | <li><a class="reference" href="#specification" id="id5" name="id5">Specification</a></li> |
| … | |
… | |
| 63 | <li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li> |
58 | <li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li> |
| 64 | <li><a class="reference" href="#reference-implementation" id="id8" name="id8">Reference Implementation</a></li> |
59 | <li><a class="reference" href="#reference-implementation" id="id8" name="id8">Reference Implementation</a></li> |
| 65 | <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li> |
60 | <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li> |
| 66 | </ul> |
61 | </ul> |
| 67 | </div> |
62 | </div> |
| 68 | <div class="section" id="abstract"> |
63 | <div class="section"> |
| 69 | <h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1> |
64 | <h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1> |
| 70 | <p>This GLEP proposes to create a more consistent, logical and usable naming |
65 | <p>This GLEP proposes to create a more consistent, logical and usable naming |
| 71 | scheme for Gentoo-specific configuration and update tools. It proposes |
66 | scheme for Gentoo-specific configuration and update tools. It proposes |
| 72 | changing the scheme to gentoo-config-<toolname> and gentoo-update-<toolname>.</p> |
67 | changing the scheme to gentoo-config-<toolname> and gentoo-update-<toolname>.</p> |
| 73 | </div> |
68 | </div> |
| 74 | <div class="section" id="status-update"> |
69 | <div class="section"> |
| 75 | <h1><a class="toc-backref" href="#id3" name="status-update">Status Update</a></h1> |
70 | <h1><a class="toc-backref" href="#id3" id="status-update" name="status-update">Status Update</a></h1> |
| 76 | <p>The author notes that this GLEP "needs significant work", which is |
71 | <p>The author notes that this GLEP "needs significant work", which is |
| 77 | unlikely to occur until either winter vacation or next summer. |
72 | unlikely to occur until either winter vacation or next summer. |
| 78 | Marking as deferred for the time being.</p> |
73 | Marking as deferred for the time being.</p> |
| 79 | </div> |
74 | </div> |
| 80 | <div class="section" id="motivation"> |
75 | <div class="section"> |
| 81 | <h1><a class="toc-backref" href="#id4" name="motivation">Motivation</a></h1> |
76 | <h1><a class="toc-backref" href="#id4" id="motivation" name="motivation">Motivation</a></h1> |
| 82 | <p>A consistent prefix on these tools will allow users to easily find them on the |
77 | <p>A consistent prefix on these tools will allow users to easily find them on the |
| 83 | system by merely entering "gentoo-<tab><tab>" for a complete listing or |
78 | system by merely entering "gentoo-<tab><tab>" for a complete listing or |
| 84 | "gentoo-config-<tab><tab>" or "gentoo-update-<tab><tab>" to get a listing of |
79 | "gentoo-config-<tab><tab>" or "gentoo-update-<tab><tab>" to get a listing of |
| 85 | the specific category.</p> |
80 | the specific category.</p> |
| 86 | <p>In the current situation, it is trivial to miss a configuration tool unless one |
81 | <p>In the current situation, it is trivial to miss a configuration tool unless one |
| 87 | reads a portage log of installed files for a package. Revamping the naming |
82 | reads a portage log of installed files for a package. Revamping the naming |
| 88 | scheme would enable users to find these tools more easily.</p> |
83 | scheme would enable users to find these tools more easily.</p> |
| 89 | </div> |
84 | </div> |
| 90 | <div class="section" id="specification"> |
85 | <div class="section"> |
| 91 | <h1><a class="toc-backref" href="#id5" name="specification">Specification</a></h1> |
86 | <h1><a class="toc-backref" href="#id5" id="specification" name="specification">Specification</a></h1> |
| 92 | <p>The following packages and tools are affected (gentoo- prefix removed for ease |
87 | <p>The following packages and tools are affected (gentoo- prefix removed for ease |
| 93 | of reading, current name follows suggested name):</p> |
88 | of reading, current name follows suggested name):</p> |
| 94 | <pre class="literal-block"> |
89 | <pre class="literal-block"> |
| 95 | config-kernel |
90 | config-kernel |
| 96 | x11-base/opengl-update -> config-opengl (opengl-update) |
91 | x11-base/opengl-update -> config-opengl (opengl-update) |
| … | |
… | |
| 107 | sys-apps/baselayout -> update-env (env-update) |
102 | sys-apps/baselayout -> update-env (env-update) |
| 108 | sys-apps/baselayout -> update-etc (etc-update) |
103 | sys-apps/baselayout -> update-etc (etc-update) |
| 109 | sys-apps/baselayout -> config-rc (rc-update) |
104 | sys-apps/baselayout -> config-rc (rc-update) |
| 110 | </pre> |
105 | </pre> |
| 111 | </div> |
106 | </div> |
| 112 | <div class="section" id="rationale"> |
107 | <div class="section"> |
| 113 | <h1><a class="toc-backref" href="#id6" name="rationale">Rationale</a></h1> |
108 | <h1><a class="toc-backref" href="#id6" id="rationale" name="rationale">Rationale</a></h1> |
| 114 | <p>Three primary options were presented for the naming scheme:</p> |
109 | <p>Three primary options were presented for the naming scheme:</p> |
| 115 | <ul class="simple"> |
110 | <ul class="simple"> |
| 116 | <li>The current scheme, *-config and *-update. This scheme makes finding a |
111 | <li>The current scheme, *-config and *-update. This scheme makes finding a |
| 117 | tool difficult, since there is no consistency in the beginning of the name. |
112 | tool difficult, since there is no consistency in the beginning of the name. |
| 118 | However, it may be easier for people who already know such a tool exists and |
113 | However, it may be easier for people who already know such a tool exists and |
| … | |
… | |
| 133 | easier-to-find tools.</p> |
128 | easier-to-find tools.</p> |
| 134 | <p>After two discussions on gentoo-dev, the majority favored this unified prefix |
129 | <p>After two discussions on gentoo-dev, the majority favored this unified prefix |
| 135 | for the tools, with a minority in objection, variously favoring one of the |
130 | for the tools, with a minority in objection, variously favoring one of the |
| 136 | first two schemes above.</p> |
131 | first two schemes above.</p> |
| 137 | </div> |
132 | </div> |
| 138 | <div class="section" id="backwards-compatibility"> |
133 | <div class="section"> |
| 139 | <h1><a class="toc-backref" href="#id7" name="backwards-compatibility">Backwards Compatibility</a></h1> |
134 | <h1><a class="toc-backref" href="#id7" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
| 140 | <p>To ensure a smooth transition, a wrapper script will be provided in the old |
135 | <p>To ensure a smooth transition, a wrapper script will be provided in the old |
| 141 | location. This wrapper will print a warning, sleep 5 seconds, then run the |
136 | location. This wrapper will print a warning, sleep 5 seconds, then run the |
| 142 | tool from its new location. The wrapper script should be provided for the next |
137 | tool from its new location. The wrapper script should be provided for the next |
| 143 | two new ebuilds for the package, whether they are revision or version bumps. |
138 | two new ebuilds for the package, whether they are revision or version bumps. |
| 144 | On the third update, the wrapper script will be removed.</p> |
139 | On the third update, the wrapper script will be removed.</p> |
| 145 | <p>In addition, einfo warnings will be added in the ebuilds for the first three |
140 | <p>In addition, einfo warnings will be added in the ebuilds for the first three |
| 146 | new ebuilds. They will run in one more ebuild beyond removal of the wrapper |
141 | new ebuilds. They will run in one more ebuild beyond removal of the wrapper |
| 147 | script.</p> |
142 | script.</p> |
| 148 | </div> |
143 | </div> |
| 149 | <div class="section" id="reference-implementation"> |
144 | <div class="section"> |
| 150 | <h1><a class="toc-backref" href="#id8" name="reference-implementation">Reference Implementation</a></h1> |
145 | <h1><a class="toc-backref" href="#id8" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1> |
| 151 | <p>not yet ..</p> |
146 | <p>not yet ..</p> |
| 152 | </div> |
147 | </div> |
| 153 | <div class="section" id="copyright"> |
148 | <div class="section"> |
| 154 | <h1><a class="toc-backref" href="#id9" name="copyright">Copyright</a></h1> |
149 | <h1><a class="toc-backref" href="#id9" id="copyright" name="copyright">Copyright</a></h1> |
| 155 | <p>This document has been placed in the public domain.</p> |
150 | <p>This document has been placed in the public domain.</p> |
| 156 | </div> |
151 | </div> |
|
|
152 | |
| 157 | </div> |
153 | </div> |
|
|
154 | <div class="footer"> |
|
|
155 | <hr class="footer" /> |
|
|
156 | <a class="reference" href="glep-0024.txt">View document source</a>. |
|
|
157 | Generated on: 2007-10-13 13:39 UTC. |
|
|
158 | 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. |
| 158 | |
159 | |
| 159 | <hr class="footer" /> |
|
|
| 160 | <div class="footer"> |
|
|
| 161 | <a class="reference" href="glep-0024.txt">View document source</a>. |
|
|
| 162 | Generated on: 2004-10-25 16:46 UTC. |
|
|
| 163 | 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. |
|
|
| 164 | </div> |
160 | </div> |
| 165 | </body> |
161 | </body> |
| 166 | </html> |
162 | </html> |
| 167 | |
163 | |
Parent Directory
| 
Revision Log
| 
Patch