/[gentoo]/xml/htdocs/proj/en/glep/glep-0024.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0024.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.4
… …
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title> 12 <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <style type="text/css">
14
15/*
16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2006/10/10 20:25:14 $
19:version: $Revision: 1.4 $
20:copyright: This stylesheet has been placed in the public domain.
21
22Default cascading style sheet for the PEP HTML output of Docutils.
23*/
24
25.first {
26 margin-top: 0 }
27
28.last {
29 margin-bottom: 0 }
30
31.navigation {
32 width: 100% ;
33 background: #cc99ff ;
34 margin-top: 0px ;
35 margin-bottom: 0px }
36
37.navigation .navicon {
38 width: 150px ;
39 height: 35px }
40
41.navigation .textlinks {
42 padding-left: 1em ;
43 text-align: left }
44
45.navigation td, .navigation th {
46 padding-left: 0em ;
47 padding-right: 0em ;
48 vertical-align: middle }
49
50.rfc2822 {
51 margin-top: 0.5em ;
52 margin-left: 0.5em ;
53 margin-right: 0.5em ;
54 margin-bottom: 0em }
55
56.rfc2822 td {
57 text-align: left }
58
59.rfc2822 th.field-name {
60 text-align: right ;
61 font-family: sans-serif ;
62 padding-right: 0.5em ;
63 font-weight: bold ;
64 margin-bottom: 0em }
65
66a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75dd {
76 margin-bottom: 0.5em }
77
78div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88div.abstract {
89 margin: 2em 5em }
90
91div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95div.attention, div.caution, div.danger, div.error, div.hint,
96div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101div.attention p.admonition-title, div.caution p.admonition-title,
102div.danger p.admonition-title, div.error p.admonition-title,
103div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108div.hint p.admonition-title, div.important p.admonition-title,
109div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113div.figure {
114 margin-left: 2em }
115
116div.footer, div.header {
117 font-size: smaller }
118
119div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123div.system-messages {
124 margin: 5em }
125
126div.system-messages h1 {
127 color: red }
128
129div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137div.topic {
138 margin: 2em }
139
140h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166.section hr {
167 width: 75% }
168
169ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172ol.arabic {
173 list-style: decimal }
174
175ol.loweralpha {
176 list-style: lower-alpha }
177
178ol.upperalpha {
179 list-style: upper-alpha }
180
181ol.lowerroman {
182 list-style: lower-roman }
183
184ol.upperroman {
185 list-style: upper-roman }
186
187p.caption {
188 font-style: italic }
189
190p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194p.label {
195 white-space: nowrap }
196
197p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218span.interpreted {
219 font-family: sans-serif }
220
221span.option-argument {
222 font-style: italic }
223
224span.pre {
225 white-space: pre }
226
227span.problematic {
228 color: red }
229
230table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239td.num {
240 text-align: right }
241
242th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250tt {
251 background-color: #eeeeee }
252
253ul.auto-toc {
254 list-style-type: none }
255
256</style>
14</head> 257</head>
15<body bgcolor="white"> 258<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 259<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 260 width="100%" border="0">
18<tr><td class="navicon" width="150" height="35"> 261<tr><td class="navicon" width="150" height="35">
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 262<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 263<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 264 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 265<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 266[<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>] 267[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
25[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0024.txt">GLEP Source</a></b>] 268[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0024.txt">GLEP Source</a></b>]
26</td></tr></table> 269</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 270<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 271<col class="field-name" />
30<col class="field-body" /> 272<col class="field-body" />
31<tbody valign="top"> 273<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td>
33</tr> 275</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td>
35</tr> 277</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.5</td>
37</tr> 279</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.cgi/xml/htdocs/proj/en/glep/glep-0024.txt?cvsroot=gentoo">2004/03/17 14:17:26</a></td> 280<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> 281</tr>
40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Donnie Berkholz &lt;spyderous&#32;&#97;t&#32;gentoo.org&gt;,</td> 282<tr class="field"><th class="field-name">Author:</th><td class="field-body">Donnie Berkholz &lt;dberkholz&#32;&#97;t&#32;gentoo.org&gt;,</td>
41</tr> 283</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 284<tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
43</tr> 285</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td> 286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td>
45</tr> 287</tr>
46<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> 288<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> 289</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td> 290<tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td>
49</tr> 291</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004</td> 292<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004, 25-Oct-2004</td>
51</tr> 293</tr>
52</tbody> 294</tbody>
53</table> 295</table>
54<hr /> 296<hr />
55<div class="contents topic" id="contents"> 297<div class="contents topic">
56<p class="topic-title"><a name="contents">Contents</a></p> 298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
57<ul class="simple"> 299<ul class="simple">
58<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> 300<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
301<li><a class="reference" href="#status-update" id="id3" name="id3">Status Update</a></li>
59<li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li> 302<li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li>
60<li><a class="reference" href="#specification" id="id4" name="id4">Specification</a></li> 303<li><a class="reference" href="#specification" id="id5" name="id5">Specification</a></li>
61<li><a class="reference" href="#rationale" id="id5" name="id5">Rationale</a></li> 304<li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
62<li><a class="reference" href="#backwards-compatibility" id="id6" name="id6">Backwards Compatibility</a></li> 305<li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
63<li><a class="reference" href="#reference-implementation" id="id7" name="id7">Reference Implementation</a></li> 306<li><a class="reference" href="#reference-implementation" id="id8" name="id8">Reference Implementation</a></li>
64<li><a class="reference" href="#copyright" id="id8" name="id8">Copyright</a></li> 307<li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
65</ul> 308</ul>
66</div> 309</div>
67<div class="section" id="abstract"> 310<div class="section">
68<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1> 311<h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1>
69<p>This GLEP proposes to create a more consistent, logical and usable naming 312<p>This GLEP proposes to create a more consistent, logical and usable naming
70scheme for Gentoo-specific configuration and update tools. It proposes 313scheme for Gentoo-specific configuration and update tools. It proposes
71changing the scheme to gentoo-config-&lt;toolname&gt; and gentoo-update-&lt;toolname&gt;.</p> 314changing the scheme to gentoo-config-&lt;toolname&gt; and gentoo-update-&lt;toolname&gt;.</p>
72</div> 315</div>
73<div class="section" id="motivation"> 316<div class="section">
317<h1><a class="toc-backref" href="#id3" id="status-update" name="status-update">Status Update</a></h1>
318<p>The author notes that this GLEP &quot;needs significant work&quot;, which is
319unlikely to occur until either winter vacation or next summer.
320Marking as deferred for the time being.</p>
321</div>
322<div class="section">
74<h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1> 323<h1><a class="toc-backref" href="#id4" id="motivation" name="motivation">Motivation</a></h1>
75<p>A consistent prefix on these tools will allow users to easily find them on the 324<p>A consistent prefix on these tools will allow users to easily find them on the
76system by merely entering &quot;gentoo-&lt;tab&gt;&lt;tab&gt;&quot; for a complete listing or 325system by merely entering &quot;gentoo-&lt;tab&gt;&lt;tab&gt;&quot; for a complete listing or
77&quot;gentoo-config-&lt;tab&gt;&lt;tab&gt;&quot; or &quot;gentoo-update-&lt;tab&gt;&lt;tab&gt;&quot; to get a listing of 326&quot;gentoo-config-&lt;tab&gt;&lt;tab&gt;&quot; or &quot;gentoo-update-&lt;tab&gt;&lt;tab&gt;&quot; to get a listing of
78the specific category.</p> 327the specific category.</p>
79<p>In the current situation, it is trivial to miss a configuration tool unless one 328<p>In the current situation, it is trivial to miss a configuration tool unless one
80reads a portage log of installed files for a package. Revamping the naming 329reads a portage log of installed files for a package. Revamping the naming
81scheme would enable users to find these tools more easily.</p> 330scheme would enable users to find these tools more easily.</p>
82</div> 331</div>
83<div class="section" id="specification"> 332<div class="section">
84<h1><a class="toc-backref" href="#id4" name="specification">Specification</a></h1> 333<h1><a class="toc-backref" href="#id5" id="specification" name="specification">Specification</a></h1>
85<p>The following packages and tools are affected (gentoo- prefix removed for ease 334<p>The following packages and tools are affected (gentoo- prefix removed for ease
86of reading, current name follows suggested name):</p> 335of reading, current name follows suggested name):</p>
87<pre class="literal-block"> 336<pre class="literal-block">
88config-kernel 337config-kernel
89x11-base/opengl-update -&gt; config-opengl (opengl-update) 338x11-base/opengl-update -&gt; config-opengl (opengl-update)
… …
100sys-apps/baselayout -&gt; update-env (env-update) 349sys-apps/baselayout -&gt; update-env (env-update)
101sys-apps/baselayout -&gt; update-etc (etc-update) 350sys-apps/baselayout -&gt; update-etc (etc-update)
102sys-apps/baselayout -&gt; config-rc (rc-update) 351sys-apps/baselayout -&gt; config-rc (rc-update)
103</pre> 352</pre>
104</div> 353</div>
105<div class="section" id="rationale"> 354<div class="section">
106<h1><a class="toc-backref" href="#id5" name="rationale">Rationale</a></h1> 355<h1><a class="toc-backref" href="#id6" id="rationale" name="rationale">Rationale</a></h1>
107<p>Three primary options were presented for the naming scheme:</p> 356<p>Three primary options were presented for the naming scheme:</p>
108<ul class="simple"> 357<ul class="simple">
109<li>The current scheme, *-config and *-update. This scheme makes finding a 358<li>The current scheme, *-config and *-update. This scheme makes finding a
110tool difficult, since there is no consistency in the beginning of the name. 359tool difficult, since there is no consistency in the beginning of the name.
111However, it may be easier for people who already know such a tool exists and 360However, it may be easier for people who already know such a tool exists and
… …
126easier-to-find tools.</p> 375easier-to-find tools.</p>
127<p>After two discussions on gentoo-dev, the majority favored this unified prefix 376<p>After two discussions on gentoo-dev, the majority favored this unified prefix
128for the tools, with a minority in objection, variously favoring one of the 377for the tools, with a minority in objection, variously favoring one of the
129first two schemes above.</p> 378first two schemes above.</p>
130</div> 379</div>
131<div class="section" id="backwards-compatibility"> 380<div class="section">
132<h1><a class="toc-backref" href="#id6" name="backwards-compatibility">Backwards Compatibility</a></h1> 381<h1><a class="toc-backref" href="#id7" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
133<p>To ensure a smooth transition, a wrapper script will be provided in the old 382<p>To ensure a smooth transition, a wrapper script will be provided in the old
134location. This wrapper will print a warning, sleep 5 seconds, then run the 383location. This wrapper will print a warning, sleep 5 seconds, then run the
135tool from its new location. The wrapper script should be provided for the next 384tool from its new location. The wrapper script should be provided for the next
136two new ebuilds for the package, whether they are revision or version bumps. 385two new ebuilds for the package, whether they are revision or version bumps.
137On the third update, the wrapper script will be removed.</p> 386On the third update, the wrapper script will be removed.</p>
138<p>In addition, einfo warnings will be added in the ebuilds for the first three 387<p>In addition, einfo warnings will be added in the ebuilds for the first three
139new ebuilds. They will run in one more ebuild beyond removal of the wrapper 388new ebuilds. They will run in one more ebuild beyond removal of the wrapper
140script.</p> 389script.</p>
141</div> 390</div>
142<div class="section" id="reference-implementation"> 391<div class="section">
143<h1><a class="toc-backref" href="#id7" name="reference-implementation">Reference Implementation</a></h1> 392<h1><a class="toc-backref" href="#id8" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
144<p>not yet ..</p> 393<p>not yet ..</p>
145</div> 394</div>
146<div class="section" id="copyright"> 395<div class="section">
147<h1><a class="toc-backref" href="#id8" name="copyright">Copyright</a></h1> 396<h1><a class="toc-backref" href="#id9" id="copyright" name="copyright">Copyright</a></h1>
148<p>This document has been placed in the public domain.</p> 397<p>This document has been placed in the public domain.</p>
149</div> 398</div>
150</div>
151 399
152<hr class="footer"/> 400</div>
153<div class="footer"> 401<div class="footer">
402<hr class="footer" />
154<a class="reference" href="glep-0024.txt">View document source</a>. 403<a class="reference" href="glep-0024.txt">View document source</a>.
155Generated on: 2004-03-17 14:24 UTC. 404Generated on: 2006-10-10 20:23 UTC.
156Generated 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. 405Generated 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.
406
157</div> 407</div>
158</body> 408</body>
159</html> 409</html>
160 410
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4
  ViewVC Help
Powered by ViewVC 1.1.20