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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.6 - (show annotations) (download) (as text)
Sun Oct 14 17:00:15 2007 UTC (11 years, 6 months ago) by antarus
Branch: MAIN
Changes since 1.5: +4 -251 lines
File MIME type: text/html
the canary on 53 went well, changing the rest

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

  ViewVC Help
Powered by ViewVC 1.1.20