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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (hide annotations) (download) (as text)
Tue Oct 10 20:25:14 2006 UTC (8 years ago) by g2boojum
Branch: MAIN
Changes since 1.3: +273 -30 lines
File MIME type: text/html
regenerate all .html files

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 g2boojum 1.4 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 g2boojum 1.1 <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title>
13 g2boojum 1.4 <style type="text/css">
14    
15     /*
16     :Author: David Goodger
17     :Contact: goodger@users.sourceforge.net
18     :date: $Date: 2003/06/02 17:03:08 $
19     :version: $Revision: 1.1 $
20     :copyright: This stylesheet has been placed in the public domain.
21    
22     Default 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    
66     a.toc-backref {
67     text-decoration: none ;
68     color: black }
69    
70     body {
71     margin: 0px ;
72     margin-bottom: 1em ;
73     padding: 0px }
74    
75     dd {
76     margin-bottom: 0.5em }
77    
78     div.section {
79     margin-left: 1em ;
80     margin-right: 1em ;
81     margin-bottom: 1.5em }
82    
83     div.section div.section {
84     margin-left: 0em ;
85     margin-right: 0em ;
86     margin-top: 1.5em }
87    
88     div.abstract {
89     margin: 2em 5em }
90    
91     div.abstract p.topic-title {
92     font-weight: bold ;
93     text-align: center }
94    
95     div.attention, div.caution, div.danger, div.error, div.hint,
96     div.important, div.note, div.tip, div.warning {
97     margin: 2em ;
98     border: medium outset ;
99     padding: 1em }
100    
101     div.attention p.admonition-title, div.caution p.admonition-title,
102     div.danger p.admonition-title, div.error p.admonition-title,
103     div.warning p.admonition-title {
104     color: red ;
105     font-weight: bold ;
106     font-family: sans-serif }
107    
108     div.hint p.admonition-title, div.important p.admonition-title,
109     div.note p.admonition-title, div.tip p.admonition-title {
110     font-weight: bold ;
111     font-family: sans-serif }
112    
113     div.figure {
114     margin-left: 2em }
115    
116     div.footer, div.header {
117     font-size: smaller }
118    
119     div.footer {
120     margin-left: 1em ;
121     margin-right: 1em }
122    
123     div.system-messages {
124     margin: 5em }
125    
126     div.system-messages h1 {
127     color: red }
128    
129     div.system-message {
130     border: medium outset ;
131     padding: 1em }
132    
133     div.system-message p.system-message-title {
134     color: red ;
135     font-weight: bold }
136    
137     div.topic {
138     margin: 2em }
139    
140     h1 {
141     font-family: sans-serif ;
142     font-size: large }
143    
144     h2 {
145     font-family: sans-serif ;
146     font-size: medium }
147    
148     h3 {
149     font-family: sans-serif ;
150     font-size: small }
151    
152     h4 {
153     font-family: sans-serif ;
154     font-style: italic ;
155     font-size: small }
156    
157     h5 {
158     font-family: sans-serif;
159     font-size: x-small }
160    
161     h6 {
162     font-family: sans-serif;
163     font-style: italic ;
164     font-size: x-small }
165    
166     .section hr {
167     width: 75% }
168    
169     ol.simple, ul.simple {
170     margin-bottom: 1em }
171    
172     ol.arabic {
173     list-style: decimal }
174    
175     ol.loweralpha {
176     list-style: lower-alpha }
177    
178     ol.upperalpha {
179     list-style: upper-alpha }
180    
181     ol.lowerroman {
182     list-style: lower-roman }
183    
184     ol.upperroman {
185     list-style: upper-roman }
186    
187     p.caption {
188     font-style: italic }
189    
190     p.credits {
191     font-style: italic ;
192     font-size: smaller }
193    
194     p.label {
195     white-space: nowrap }
196    
197     p.topic-title {
198     font-family: sans-serif ;
199     font-weight: bold }
200    
201     pre.line-block {
202     font-family: serif ;
203     font-size: 100% }
204    
205     pre.literal-block, pre.doctest-block {
206     margin-left: 2em ;
207     margin-right: 2em ;
208     background-color: #eeeeee }
209    
210     span.classifier {
211     font-family: sans-serif ;
212     font-style: oblique }
213    
214     span.classifier-delimiter {
215     font-family: sans-serif ;
216     font-weight: bold }
217    
218     span.interpreted {
219     font-family: sans-serif }
220    
221     span.option-argument {
222     font-style: italic }
223    
224     span.pre {
225     white-space: pre }
226    
227     span.problematic {
228     color: red }
229    
230     table {
231     margin-top: 0.5em ;
232     margin-bottom: 0.5em }
233    
234     td, th {
235     padding-left: 0.5em ;
236     padding-right: 0.5em ;
237     vertical-align: top }
238    
239     td.num {
240     text-align: right }
241    
242     th.field-name {
243     font-weight: bold ;
244     text-align: left ;
245     white-space: nowrap }
246    
247     h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248     font-size: 100% }
249    
250     tt {
251     background-color: #eeeeee }
252    
253     ul.auto-toc {
254     list-style-type: none }
255    
256     </style>
257 g2boojum 1.1 </head>
258     <body bgcolor="white">
259     <table class="navigation" cellpadding="0" cellspacing="0"
260     width="100%" border="0">
261     <tr><td class="navicon" width="150" height="35">
262     <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
263     <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
264     border="0" width="150" height="35" /></a></td>
265     <td class="textlinks" align="left">
266     [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
267 g2boojum 1.4 [<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
268     [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0024.txt">GLEP Source</a></b>]
269 g2boojum 1.1 </td></tr></table>
270 g2boojum 1.4 <table class="rfc2822 docutils field-list" frame="void" rules="none">
271 g2boojum 1.1 <col class="field-name" />
272     <col class="field-body" />
273     <tbody valign="top">
274     <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td>
275     </tr>
276     <tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td>
277     </tr>
278 g2boojum 1.4 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.5</td>
279 g2boojum 1.1 </tr>
280 g2boojum 1.4 <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>
281 g2boojum 1.1 </tr>
282 dberkholz 1.3 <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>
283 g2boojum 1.1 </tr>
284 g2boojum 1.2 <tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
285 g2boojum 1.1 </tr>
286     <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td>
287     </tr>
288 g2boojum 1.4 <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>
289 g2boojum 1.1 </tr>
290     <tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td>
291     </tr>
292 g2boojum 1.2 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004, 25-Oct-2004</td>
293 g2boojum 1.1 </tr>
294     </tbody>
295     </table>
296     <hr />
297 g2boojum 1.4 <div class="contents topic">
298     <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
299 g2boojum 1.1 <ul class="simple">
300     <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
301 g2boojum 1.2 <li><a class="reference" href="#status-update" id="id3" name="id3">Status Update</a></li>
302     <li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li>
303     <li><a class="reference" href="#specification" id="id5" name="id5">Specification</a></li>
304     <li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
305     <li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
306     <li><a class="reference" href="#reference-implementation" id="id8" name="id8">Reference Implementation</a></li>
307     <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
308 g2boojum 1.1 </ul>
309     </div>
310 g2boojum 1.4 <div class="section">
311     <h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1>
312 g2boojum 1.1 <p>This GLEP proposes to create a more consistent, logical and usable naming
313     scheme for Gentoo-specific configuration and update tools. It proposes
314     changing the scheme to gentoo-config-&lt;toolname&gt; and gentoo-update-&lt;toolname&gt;.</p>
315     </div>
316 g2boojum 1.4 <div class="section">
317     <h1><a class="toc-backref" href="#id3" id="status-update" name="status-update">Status Update</a></h1>
318 g2boojum 1.2 <p>The author notes that this GLEP &quot;needs significant work&quot;, which is
319     unlikely to occur until either winter vacation or next summer.
320     Marking as deferred for the time being.</p>
321     </div>
322 g2boojum 1.4 <div class="section">
323     <h1><a class="toc-backref" href="#id4" id="motivation" name="motivation">Motivation</a></h1>
324 g2boojum 1.1 <p>A consistent prefix on these tools will allow users to easily find them on the
325     system by merely entering &quot;gentoo-&lt;tab&gt;&lt;tab&gt;&quot; for a complete listing or
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
327     the specific category.</p>
328     <p>In the current situation, it is trivial to miss a configuration tool unless one
329     reads a portage log of installed files for a package. Revamping the naming
330     scheme would enable users to find these tools more easily.</p>
331     </div>
332 g2boojum 1.4 <div class="section">
333     <h1><a class="toc-backref" href="#id5" id="specification" name="specification">Specification</a></h1>
334 g2boojum 1.1 <p>The following packages and tools are affected (gentoo- prefix removed for ease
335     of reading, current name follows suggested name):</p>
336     <pre class="literal-block">
337     config-kernel
338     x11-base/opengl-update -&gt; config-opengl (opengl-update)
339     sys-devel/distcc -&gt; config-distcc (distcc-config)
340     app-admin/zope-config -&gt; config-zope (zope-config)
341     app-sci/blas-config -&gt; config-blas (blas-config)
342     dev-java/java-config -&gt; config-java (java-config)
343     dev-ruby/ruby-config -&gt; config-ruby (ruby-config)
344     net-www/webapp-config -&gt; config-webapp (webapp-config)
345     sys-devel/cc-config -&gt; config-cc (cc-config)
346     sys-devel/gcc-config -&gt; config-gcc (gcc-config)
347     dev-lang/python -&gt; update-python (python-updater)
348     sys-apps/baselayout -&gt; update-modules (modules-update)
349     sys-apps/baselayout -&gt; update-env (env-update)
350     sys-apps/baselayout -&gt; update-etc (etc-update)
351     sys-apps/baselayout -&gt; config-rc (rc-update)
352     </pre>
353     </div>
354 g2boojum 1.4 <div class="section">
355     <h1><a class="toc-backref" href="#id6" id="rationale" name="rationale">Rationale</a></h1>
356 g2boojum 1.1 <p>Three primary options were presented for the naming scheme:</p>
357     <ul class="simple">
358     <li>The current scheme, *-config and *-update. This scheme makes finding a
359     tool difficult, since there is no consistency in the beginning of the name.
360     However, it may be easier for people who already know such a tool exists and
361     remember that its name correlates with the package to be configured (except
362     in the case of many of the *-update tools).</li>
363     <li>A slightly modified version of the proposed scheme, with an abbreviated
364     prefix, shorter than gentoo-*. For example, the current gcc-config would
365     become gen-config-gcc or g-config-gcc. Although this is shorter to type, the
366     availability of tab completion renders that point largely moot. It may also
367     contribute to confusion through inexact specification of what it is.</li>
368     <li>The proposed scheme, gentoo-{config,update}-*. It provides a streamlined way
369     to discover and use various Gentoo-specific tools, even if one does not
370     remember the exact name. A minor downside is the length of the names, but
371     again this caveat is largely moot because of tab completion.</li>
372     </ul>
373     <p>In an example of another distribution, Red Hat moved to a redhat-config-*
374     scheme within the past couple of years to provide more consistent and
375     easier-to-find tools.</p>
376     <p>After two discussions on gentoo-dev, the majority favored this unified prefix
377     for the tools, with a minority in objection, variously favoring one of the
378     first two schemes above.</p>
379     </div>
380 g2boojum 1.4 <div class="section">
381     <h1><a class="toc-backref" href="#id7" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
382 g2boojum 1.1 <p>To ensure a smooth transition, a wrapper script will be provided in the old
383     location. This wrapper will print a warning, sleep 5 seconds, then run the
384     tool from its new location. The wrapper script should be provided for the next
385     two new ebuilds for the package, whether they are revision or version bumps.
386     On the third update, the wrapper script will be removed.</p>
387     <p>In addition, einfo warnings will be added in the ebuilds for the first three
388     new ebuilds. They will run in one more ebuild beyond removal of the wrapper
389     script.</p>
390     </div>
391 g2boojum 1.4 <div class="section">
392     <h1><a class="toc-backref" href="#id8" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
393 g2boojum 1.1 <p>not yet ..</p>
394     </div>
395 g2boojum 1.4 <div class="section">
396     <h1><a class="toc-backref" href="#id9" id="copyright" name="copyright">Copyright</a></h1>
397 g2boojum 1.1 <p>This document has been placed in the public domain.</p>
398     </div>
399 g2boojum 1.4
400 g2boojum 1.1 </div>
401 g2boojum 1.4 <div class="footer">
402 g2boojum 1.2 <hr class="footer" />
403 g2boojum 1.1 <a class="reference" href="glep-0024.txt">View document source</a>.
404 g2boojum 1.4 Generated on: 2006-10-10 20:23 UTC.
405 g2boojum 1.1 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.
406 g2boojum 1.4
407 g2boojum 1.1 </div>
408     </body>
409     </html>

  ViewVC Help
Powered by ViewVC 1.1.20