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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations) (download) (as text)
Wed Mar 17 14:26:41 2004 UTC (15 years ago) by g2boojum
Branch: MAIN
File MIME type: text/html
new glep

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.0: 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="http://www.gentoo.org/proj/en/glep/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.1</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.cgi/xml/htdocs/proj/en/glep/glep-0024.txt?cvsroot=gentoo">2004/03/17 14:17:26</a></td>
39 </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>
41 </tr>
42 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</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-0002.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</td>
51 </tr>
52 </tbody>
53 </table>
54 <hr />
55 <div class="contents topic" id="contents">
56 <p class="topic-title"><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="#motivation" id="id3" name="id3">Motivation</a></li>
60 <li><a class="reference" href="#specification" id="id4" name="id4">Specification</a></li>
61 <li><a class="reference" href="#rationale" id="id5" name="id5">Rationale</a></li>
62 <li><a class="reference" href="#backwards-compatibility" id="id6" name="id6">Backwards Compatibility</a></li>
63 <li><a class="reference" href="#reference-implementation" id="id7" name="id7">Reference Implementation</a></li>
64 <li><a class="reference" href="#copyright" id="id8" name="id8">Copyright</a></li>
65 </ul>
66 </div>
67 <div class="section" id="abstract">
68 <h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
69 <p>This GLEP proposes to create a more consistent, logical and usable naming
70 scheme for Gentoo-specific configuration and update tools. It proposes
71 changing the scheme to gentoo-config-&lt;toolname&gt; and gentoo-update-&lt;toolname&gt;.</p>
72 </div>
73 <div class="section" id="motivation">
74 <h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1>
75 <p>A consistent prefix on these tools will allow users to easily find them on the
76 system 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
78 the specific category.</p>
79 <p>In the current situation, it is trivial to miss a configuration tool unless one
80 reads a portage log of installed files for a package. Revamping the naming
81 scheme would enable users to find these tools more easily.</p>
82 </div>
83 <div class="section" id="specification">
84 <h1><a class="toc-backref" href="#id4" name="specification">Specification</a></h1>
85 <p>The following packages and tools are affected (gentoo- prefix removed for ease
86 of reading, current name follows suggested name):</p>
87 <pre class="literal-block">
88 config-kernel
89 x11-base/opengl-update -&gt; config-opengl (opengl-update)
90 sys-devel/distcc -&gt; config-distcc (distcc-config)
91 app-admin/zope-config -&gt; config-zope (zope-config)
92 app-sci/blas-config -&gt; config-blas (blas-config)
93 dev-java/java-config -&gt; config-java (java-config)
94 dev-ruby/ruby-config -&gt; config-ruby (ruby-config)
95 net-www/webapp-config -&gt; config-webapp (webapp-config)
96 sys-devel/cc-config -&gt; config-cc (cc-config)
97 sys-devel/gcc-config -&gt; config-gcc (gcc-config)
98 dev-lang/python -&gt; update-python (python-updater)
99 sys-apps/baselayout -&gt; update-modules (modules-update)
100 sys-apps/baselayout -&gt; update-env (env-update)
101 sys-apps/baselayout -&gt; update-etc (etc-update)
102 sys-apps/baselayout -&gt; config-rc (rc-update)
103 </pre>
104 </div>
105 <div class="section" id="rationale">
106 <h1><a class="toc-backref" href="#id5" name="rationale">Rationale</a></h1>
107 <p>Three primary options were presented for the naming scheme:</p>
108 <ul class="simple">
109 <li>The current scheme, *-config and *-update. This scheme makes finding a
110 tool difficult, since there is no consistency in the beginning of the name.
111 However, it may be easier for people who already know such a tool exists and
112 remember that its name correlates with the package to be configured (except
113 in the case of many of the *-update tools).</li>
114 <li>A slightly modified version of the proposed scheme, with an abbreviated
115 prefix, shorter than gentoo-*. For example, the current gcc-config would
116 become gen-config-gcc or g-config-gcc. Although this is shorter to type, the
117 availability of tab completion renders that point largely moot. It may also
118 contribute to confusion through inexact specification of what it is.</li>
119 <li>The proposed scheme, gentoo-{config,update}-*. It provides a streamlined way
120 to discover and use various Gentoo-specific tools, even if one does not
121 remember the exact name. A minor downside is the length of the names, but
122 again this caveat is largely moot because of tab completion.</li>
123 </ul>
124 <p>In an example of another distribution, Red Hat moved to a redhat-config-*
125 scheme within the past couple of years to provide more consistent and
126 easier-to-find tools.</p>
127 <p>After two discussions on gentoo-dev, the majority favored this unified prefix
128 for the tools, with a minority in objection, variously favoring one of the
129 first two schemes above.</p>
130 </div>
131 <div class="section" id="backwards-compatibility">
132 <h1><a class="toc-backref" href="#id6" name="backwards-compatibility">Backwards Compatibility</a></h1>
133 <p>To ensure a smooth transition, a wrapper script will be provided in the old
134 location. This wrapper will print a warning, sleep 5 seconds, then run the
135 tool from its new location. The wrapper script should be provided for the next
136 two new ebuilds for the package, whether they are revision or version bumps.
137 On 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
139 new ebuilds. They will run in one more ebuild beyond removal of the wrapper
140 script.</p>
141 </div>
142 <div class="section" id="reference-implementation">
143 <h1><a class="toc-backref" href="#id7" name="reference-implementation">Reference Implementation</a></h1>
144 <p>not yet ..</p>
145 </div>
146 <div class="section" id="copyright">
147 <h1><a class="toc-backref" href="#id8" name="copyright">Copyright</a></h1>
148 <p>This document has been placed in the public domain.</p>
149 </div>
150 </div>
152 <hr class="footer"/>
153 <div class="footer">
154 <a class="reference" href="glep-0024.txt">View document source</a>.
155 Generated on: 2004-03-17 14:24 UTC.
156 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.
157 </div>
158 </body>
159 </html>

  ViewVC Help
Powered by ViewVC 1.1.20