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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations) (download) (as text)
Fri Jul 7 06:08:10 2006 UTC (7 years, 9 months ago) by dberkholz
Branch: MAIN
Changes since 1.2: +1 -1 lines
File MIME type: text/html
Update my email address: spyderous -> dberkholz.

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
8 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" />
12 <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14 </head>
15 <body bgcolor="white">
16 <table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0">
18 <tr><td class="navicon" width="150" height="35">
19 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td>
22 <td class="textlinks" align="left">
23 [<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>]
25 [<b><a href="./glep-0024.txt">GLEP Source</a></b>]
26 </td></tr></table>
27 <div class="document">
28 <table class="rfc2822 field-list" frame="void" rules="none">
29 <col class="field-name" />
30 <col class="field-body" />
31 <tbody valign="top">
32 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td>
33 </tr>
34 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td>
35 </tr>
36 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td>
37 </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>
39 </tr>
40 <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>
42 <tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
43 </tr>
44 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td>
45 </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>
47 </tr>
48 <tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td>
49 </tr>
50 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004, 25-Oct-2004</td>
51 </tr>
52 </tbody>
53 </table>
54 <hr />
55 <div class="contents topic" id="contents">
56 <p class="topic-title first"><a name="contents">Contents</a></p>
57 <ul class="simple">
58 <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>
60 <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>
62 <li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
63 <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>
65 <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
66 </ul>
67 </div>
68 <div class="section" id="abstract">
69 <h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
70 <p>This GLEP proposes to create a more consistent, logical and usable naming
71 scheme for Gentoo-specific configuration and update tools. It proposes
72 changing the scheme to gentoo-config-&lt;toolname&gt; and gentoo-update-&lt;toolname&gt;.</p>
73 </div>
74 <div class="section" id="status-update">
75 <h1><a class="toc-backref" href="#id3" name="status-update">Status Update</a></h1>
76 <p>The author notes that this GLEP &quot;needs significant work&quot;, which is
77 unlikely to occur until either winter vacation or next summer.
78 Marking as deferred for the time being.</p>
79 </div>
80 <div class="section" id="motivation">
81 <h1><a class="toc-backref" href="#id4" name="motivation">Motivation</a></h1>
82 <p>A consistent prefix on these tools will allow users to easily find them on the
83 system by merely entering &quot;gentoo-&lt;tab&gt;&lt;tab&gt;&quot; for a complete listing or
84 &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
85 the specific category.</p>
86 <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
88 scheme would enable users to find these tools more easily.</p>
89 </div>
90 <div class="section" id="specification">
91 <h1><a class="toc-backref" href="#id5" name="specification">Specification</a></h1>
92 <p>The following packages and tools are affected (gentoo- prefix removed for ease
93 of reading, current name follows suggested name):</p>
94 <pre class="literal-block">
95 config-kernel
96 x11-base/opengl-update -&gt; config-opengl (opengl-update)
97 sys-devel/distcc -&gt; config-distcc (distcc-config)
98 app-admin/zope-config -&gt; config-zope (zope-config)
99 app-sci/blas-config -&gt; config-blas (blas-config)
100 dev-java/java-config -&gt; config-java (java-config)
101 dev-ruby/ruby-config -&gt; config-ruby (ruby-config)
102 net-www/webapp-config -&gt; config-webapp (webapp-config)
103 sys-devel/cc-config -&gt; config-cc (cc-config)
104 sys-devel/gcc-config -&gt; config-gcc (gcc-config)
105 dev-lang/python -&gt; update-python (python-updater)
106 sys-apps/baselayout -&gt; update-modules (modules-update)
107 sys-apps/baselayout -&gt; update-env (env-update)
108 sys-apps/baselayout -&gt; update-etc (etc-update)
109 sys-apps/baselayout -&gt; config-rc (rc-update)
110 </pre>
111 </div>
112 <div class="section" id="rationale">
113 <h1><a class="toc-backref" href="#id6" name="rationale">Rationale</a></h1>
114 <p>Three primary options were presented for the naming scheme:</p>
115 <ul class="simple">
116 <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.
118 However, it may be easier for people who already know such a tool exists and
119 remember that its name correlates with the package to be configured (except
120 in the case of many of the *-update tools).</li>
121 <li>A slightly modified version of the proposed scheme, with an abbreviated
122 prefix, shorter than gentoo-*. For example, the current gcc-config would
123 become gen-config-gcc or g-config-gcc. Although this is shorter to type, the
124 availability of tab completion renders that point largely moot. It may also
125 contribute to confusion through inexact specification of what it is.</li>
126 <li>The proposed scheme, gentoo-{config,update}-*. It provides a streamlined way
127 to discover and use various Gentoo-specific tools, even if one does not
128 remember the exact name. A minor downside is the length of the names, but
129 again this caveat is largely moot because of tab completion.</li>
130 </ul>
131 <p>In an example of another distribution, Red Hat moved to a redhat-config-*
132 scheme within the past couple of years to provide more consistent and
133 easier-to-find tools.</p>
134 <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
136 first two schemes above.</p>
137 </div>
138 <div class="section" id="backwards-compatibility">
139 <h1><a class="toc-backref" href="#id7" name="backwards-compatibility">Backwards Compatibility</a></h1>
140 <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
142 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.
144 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
146 new ebuilds. They will run in one more ebuild beyond removal of the wrapper
147 script.</p>
148 </div>
149 <div class="section" id="reference-implementation">
150 <h1><a class="toc-backref" href="#id8" name="reference-implementation">Reference Implementation</a></h1>
151 <p>not yet ..</p>
152 </div>
153 <div class="section" id="copyright">
154 <h1><a class="toc-backref" href="#id9" name="copyright">Copyright</a></h1>
155 <p>This document has been placed in the public domain.</p>
156 </div>
157 </div>
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>
165 </body>
166 </html>

  ViewVC Help
Powered by ViewVC 1.1.20