/[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.6
1<?xml version="1.0" encoding="utf-8" ?> 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"> 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"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- 4
5This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
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!
8-->
9<head> 5<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title> 8 <title>GLEP 24 -- Consistent Gentoo tool naming scheme</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 10</head>
15<body bgcolor="white"> 11<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 12<table class="navigation" cellpadding="0" cellspacing="0"
22<td class="textlinks" align="left"> 18<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 19[<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>] 20[<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>] 21[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0024.txt">GLEP Source</a></b>]
26</td></tr></table> 22</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 23<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 24<col class="field-name" />
30<col class="field-body" /> 25<col class="field-body" />
31<tbody valign="top"> 26<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td> 27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">24</td>
33</tr> 28</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td> 29<tr class="field"><th class="field-name">Title:</th><td class="field-body">Consistent Gentoo tool naming scheme</td>
35</tr> 30</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.5</td>
37</tr> 32</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> 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>
39</tr> 34</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> 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>
41</tr> 36</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 37<tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
43</tr> 38</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td> 39<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards</td>
45</tr> 40</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> 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>
47</tr> 42</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td> 43<tr class="field"><th class="field-name">Created:</th><td class="field-body">16 March 2004</td>
49</tr> 44</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004</td> 45<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Mar-2004, 25-Oct-2004</td>
51</tr> 46</tr>
52</tbody> 47</tbody>
53</table> 48</table>
54<hr /> 49<hr />
55<div class="contents topic" id="contents"> 50<div class="contents topic">
56<p class="topic-title"><a name="contents">Contents</a></p> 51<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
57<ul class="simple"> 52<ul class="simple">
58<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> 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>
59<li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li> 55<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> 56<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> 57<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> 58<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> 59<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> 60<li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
65</ul> 61</ul>
66</div> 62</div>
67<div class="section" id="abstract"> 63<div class="section">
68<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1> 64<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 65<p>This GLEP proposes to create a more consistent, logical and usable naming
70scheme for Gentoo-specific configuration and update tools. It proposes 66scheme 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> 67changing the scheme to gentoo-config-&lt;toolname&gt; and gentoo-update-&lt;toolname&gt;.</p>
72</div> 68</div>
73<div class="section" id="motivation"> 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
72unlikely to occur until either winter vacation or next summer.
73Marking as deferred for the time being.</p>
74</div>
75<div class="section">
74<h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1> 76<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 77<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 78system 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 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
78the specific category.</p> 80the specific category.</p>
79<p>In the current situation, it is trivial to miss a configuration tool unless one 81<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 82reads a portage log of installed files for a package. Revamping the naming
81scheme would enable users to find these tools more easily.</p> 83scheme would enable users to find these tools more easily.</p>
82</div> 84</div>
83<div class="section" id="specification"> 85<div class="section">
84<h1><a class="toc-backref" href="#id4" name="specification">Specification</a></h1> 86<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 87<p>The following packages and tools are affected (gentoo- prefix removed for ease
86of reading, current name follows suggested name):</p> 88of reading, current name follows suggested name):</p>
87<pre class="literal-block"> 89<pre class="literal-block">
88config-kernel 90config-kernel
89x11-base/opengl-update -&gt; config-opengl (opengl-update) 91x11-base/opengl-update -&gt; config-opengl (opengl-update)
100sys-apps/baselayout -&gt; update-env (env-update) 102sys-apps/baselayout -&gt; update-env (env-update)
101sys-apps/baselayout -&gt; update-etc (etc-update) 103sys-apps/baselayout -&gt; update-etc (etc-update)
102sys-apps/baselayout -&gt; config-rc (rc-update) 104sys-apps/baselayout -&gt; config-rc (rc-update)
103</pre> 105</pre>
104</div> 106</div>
105<div class="section" id="rationale"> 107<div class="section">
106<h1><a class="toc-backref" href="#id5" name="rationale">Rationale</a></h1> 108<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> 109<p>Three primary options were presented for the naming scheme:</p>
108<ul class="simple"> 110<ul class="simple">
109<li>The current scheme, *-config and *-update. This scheme makes finding a 111<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. 112tool 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 113However, it may be easier for people who already know such a tool exists and
126easier-to-find tools.</p> 128easier-to-find tools.</p>
127<p>After two discussions on gentoo-dev, the majority favored this unified prefix 129<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 130for the tools, with a minority in objection, variously favoring one of the
129first two schemes above.</p> 131first two schemes above.</p>
130</div> 132</div>
131<div class="section" id="backwards-compatibility"> 133<div class="section">
132<h1><a class="toc-backref" href="#id6" name="backwards-compatibility">Backwards Compatibility</a></h1> 134<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 135<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 136location. 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 137tool 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. 138two new ebuilds for the package, whether they are revision or version bumps.
137On the third update, the wrapper script will be removed.</p> 139On 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 140<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 141new ebuilds. They will run in one more ebuild beyond removal of the wrapper
140script.</p> 142script.</p>
141</div> 143</div>
142<div class="section" id="reference-implementation"> 144<div class="section">
143<h1><a class="toc-backref" href="#id7" name="reference-implementation">Reference Implementation</a></h1> 145<h1><a class="toc-backref" href="#id8" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
144<p>not yet ..</p> 146<p>not yet ..</p>
145</div> 147</div>
146<div class="section" id="copyright"> 148<div class="section">
147<h1><a class="toc-backref" href="#id8" name="copyright">Copyright</a></h1> 149<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> 150<p>This document has been placed in the public domain.</p>
149</div> 151</div>
152
150</div> 153</div>
154<div class="footer">
155<hr class="footer" />
156<a class="reference" href="glep-0024.txt">View document source</a>.
157Generated on: 2007-10-13 13:39 UTC.
158Generated 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.
151 159
152<hr class="footer"/>
153<div class="footer">
154<a class="reference" href="glep-0024.txt">View document source</a>.
155Generated on: 2004-03-17 14:24 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.
157</div> 160</div>
158</body> 161</body>
159</html> 162</html>
160 163

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.6

  ViewVC Help
Powered by ViewVC 1.1.20