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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.7 - (show annotations) (download) (as text)
Sun Jan 6 02:08:59 2008 UTC (11 years ago) by antarus
Branch: MAIN
Changes since 1.6: +18 -17 lines
File MIME type: text/html
Editor Stamp of Coolness on glep54, redid HTML with minor changes which were sent to the author prior being commited.

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 54 -- scm package version suffix</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-0054.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">54</td>
28 </tr>
29 <tr class="field"><th class="field-name">Title:</th><td class="field-body">scm package version suffix</td>
30 </tr>
31 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</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-0054.txt?cvsroot=gentoo">2007/12/17 18:42:33</a></td>
34 </tr>
35 <tr class="field"><th class="field-name">Author:</th><td class="field-body">Piotr JaroszyƄski &lt;peper&#32;&#97;t&#32;gentoo.org&gt;</td>
36 </tr>
37 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
38 </tr>
39 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</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">09-Dec-2007</td>
44 </tr>
45 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">09-Dec-2007</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="#motivation" id="id3" name="id3">Motivation</a></li>
55 <li><a class="reference" href="#specification" id="id4" name="id4">Specification</a></li>
56 <li><a class="reference" href="#version-comparison" id="id5" name="id5">Version Comparison</a></li>
57 <li><a class="reference" href="#backwards-compatibility" id="id6" name="id6">Backwards Compatibility</a></li>
58 <li><a class="reference" href="#copyright" id="id7" name="id7">Copyright</a></li>
59 </ul>
60 </div>
61 <div class="section">
62 <h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1>
63 <p>This GLEP proposes addition of a new special package version suffix - <tt class="docutils literal"><span class="pre">scm</span></tt> -
64 for ebuilds checking out source directly from a source code management system.</p>
65 </div>
66 <div class="section">
67 <h1><a class="toc-backref" href="#id3" id="motivation" name="motivation">Motivation</a></h1>
68 <p>Currently there is no standard way of identifying SCM ebuilds. Using 9999 as the
69 version is pretty common, but it is handled like any other ebuild and hence
70 portage cannot provide any additional features for packages with such a version.
71 Another way is adding a separate package with a -cvs suffix in its name, but
72 that forces the author to use <tt class="docutils literal"><span class="pre">||</span> <span class="pre">(</span> <span class="pre">cat/pkg</span> <span class="pre">cat/pkg-cvs</span> <span class="pre">)</span></tt> dependencies. The
73 closest to what is proposed in this GLEP is the <tt class="docutils literal"><span class="pre">cvs</span></tt> version part, but its
74 implementation is of very limited use. It has strange comparison rules, no
75 documentation, has been used sparingly (if ever) and has a misleading name.</p>
76 <p>The possibility for package managers to recognise SCM ebuilds would allow them
77 to add features dedicated specially to said ebuilds. One such feature could be
78 automatic re-installation of SCM packages once a day or week. Any
79 specifications for such features are beyond the scope of this GLEP.</p>
80 </div>
81 <div class="section">
82 <h1><a class="toc-backref" href="#id4" id="specification" name="specification">Specification</a></h1>
83 <p><tt class="docutils literal"><span class="pre">scm</span></tt> is a special suffix. It can be used on its own, but also in any other
84 valid version spec, just before the place where revision would go. And just like
85 revision it can be used only once in a version spec, e.g.:</p>
86 <blockquote>
87 <ul class="simple">
88 <li><tt class="docutils literal"><span class="pre">cat/pkg-1.0_alpha0-scm</span></tt></li>
89 <li><tt class="docutils literal"><span class="pre">cat/pkg-1.0_alpha-scm</span></tt></li>
90 <li><tt class="docutils literal"><span class="pre">cat/pkg-1.0-scm-r3</span></tt></li>
91 <li><tt class="docutils literal"><span class="pre">cat/pkg-1-scm</span></tt></li>
92 <li><tt class="docutils literal"><span class="pre">cat/pkg-1-scm-r2</span></tt></li>
93 <li><tt class="docutils literal"><span class="pre">cat/pkg-scm</span></tt></li>
94 </ul>
95 </blockquote>
96 <p>These package atoms are sorted in ascending order (see <a class="reference" href="#version-comparison">Version Comparison</a>).</p>
97 </div>
98 <div class="section">
99 <h1><a class="toc-backref" href="#id5" id="version-comparison" name="version-comparison">Version Comparison</a></h1>
100 <p>The addition of the scm suffix yields changes in version comparison:</p>
101 <blockquote>
102 <ul class="simple">
103 <li>When comparing version components from left to right the scm component has the
104 highest priority over other version components. Hence
105 <tt class="docutils literal"><span class="pre">pkg-1_alpha-r3</span> <span class="pre">&lt;</span> <span class="pre">pkg-1-scm</span></tt>, 'scm' is greater than 'alpha-r3'.</li>
106 <li>Current suffixes with no number part no longer default to zero if they are
107 followed by an scm suffix. If that's the case the number part is considered
108 to be of a maximum value. Hence <tt class="docutils literal"><span class="pre">1_alpha2-scm</span> <span class="pre">&lt;</span> <span class="pre">1_alpha-scm</span></tt>, but still
109 <tt class="docutils literal"><span class="pre">1_alpha</span> <span class="pre">==</span> <span class="pre">1_alpha0</span></tt>. The rationale behind this choice is to allow
110 multiple branches. For instance imagine a package with an alpha branch
111 and multiple scm releases, as the following: <tt class="docutils literal"><span class="pre">alpha-scm</span></tt>,
112 <tt class="docutils literal"><span class="pre">alpha2-scm</span></tt>, <tt class="docutils literal"><span class="pre">alpha3-scm</span></tt> and so forth. The desired outcome is
113 for <tt class="docutils literal"><span class="pre">alpha-scm</span></tt> to be greater than all other branches of the same tree.</li>
114 </ul>
115 </blockquote>
116 <p>Example parsing:</p>
117 <blockquote>
118 <ul>
119 <li><dl class="first docutils">
120 <dt><tt class="docutils literal"><span class="pre">cat/pkg-scm</span> <span class="pre">&gt;</span> <span class="pre">cat/pkg-1</span></tt></dt>
121 <dd><p class="first last">When parsing from left to right the first difference is <tt class="docutils literal"><span class="pre">scm</span></tt> and
122 <tt class="docutils literal"><span class="pre">1</span></tt>. <tt class="docutils literal"><span class="pre">cat/pkg-scm</span></tt> wins.</p>
123 </dd>
124 </dl>
125 </li>
126 <li><dl class="first docutils">
127 <dt><tt class="docutils literal"><span class="pre">cat/pkg-1-scm</span> <span class="pre">&gt;</span> <span class="pre">cat/pkg-1.0-scm</span></tt></dt>
128 <dd><p class="first last">When parsing from left to right the first difference is <tt class="docutils literal"><span class="pre">scm</span></tt> and
129 <tt class="docutils literal"><span class="pre">0</span></tt>. <tt class="docutils literal"><span class="pre">cat/pkg-1-scm</span></tt> wins.</p>
130 </dd>
131 </dl>
132 </li>
133 <li><dl class="first docutils">
134 <dt><tt class="docutils literal"><span class="pre">cat/pkg-1_alpha-scm</span> <span class="pre">&gt;</span> <span class="pre">cat/pkg-1_alpha1-scm</span></tt></dt>
135 <dd><p class="first last">In the first package version <tt class="docutils literal"><span class="pre">alpha</span></tt> doesn't have a number part <em>and</em>
136 is followed by an <tt class="docutils literal"><span class="pre">scm</span></tt> suffix, hence it is considered to have a maximum
137 value as the number part. When parsing from left to right the first
138 difference is the number part of the <tt class="docutils literal"><span class="pre">alpha</span></tt> suffix. Maximum value
139 yielded by the following <tt class="docutils literal"><span class="pre">scm</span></tt> suffix wins with <tt class="docutils literal"><span class="pre">1</span></tt>.</p>
140 </dd>
141 </dl>
142 </li>
143 </ul>
144 </blockquote>
145 <p>List of version specs in ascending order:</p>
146 <blockquote>
147 <ul class="simple">
148 <li><tt class="docutils literal"><span class="pre">1</span></tt></li>
149 <li><tt class="docutils literal"><span class="pre">1.1-scm</span></tt></li>
150 <li><tt class="docutils literal"><span class="pre">1.2_alpha-scm</span></tt></li>
151 <li><tt class="docutils literal"><span class="pre">1.2_beta_p</span></tt></li>
152 <li><tt class="docutils literal"><span class="pre">1.2_beta_p0-scm</span></tt></li>
153 <li><tt class="docutils literal"><span class="pre">1.2_beta_p1-scm</span></tt></li>
154 <li><tt class="docutils literal"><span class="pre">1.2_beta_p-scm</span></tt></li>
155 <li><tt class="docutils literal"><span class="pre">1.2_beta1_p-scm</span></tt></li>
156 <li><tt class="docutils literal"><span class="pre">1.2_beta10</span></tt></li>
157 <li><tt class="docutils literal"><span class="pre">1.2_beta10_p1-scm</span></tt></li>
158 <li><tt class="docutils literal"><span class="pre">1.2_beta10-scm</span></tt></li>
159 <li><tt class="docutils literal"><span class="pre">1.2_beta-scm</span></tt></li>
160 <li><tt class="docutils literal"><span class="pre">1.2</span></tt></li>
161 <li><tt class="docutils literal"><span class="pre">1.2-scm</span></tt></li>
162 <li><tt class="docutils literal"><span class="pre">1.2-scm-r1</span></tt></li>
163 <li><tt class="docutils literal"><span class="pre">1-scm</span></tt></li>
164 <li><tt class="docutils literal"><span class="pre">10</span></tt></li>
165 <li><tt class="docutils literal"><span class="pre">scm</span></tt></li>
166 <li><tt class="docutils literal"><span class="pre">scm-r3</span></tt></li>
167 </ul>
168 </blockquote>
169 </div>
170 <div class="section">
171 <h1><a class="toc-backref" href="#id6" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
172 <p>Portage versions prior to (included in 2007.0) don't handle arbitrary
173 version suffixes and die during various tasks making portage hard or impossible
174 to use. Later versions just ignore them displaying warnings. Hence use of
175 <tt class="docutils literal"><span class="pre">scm</span></tt> suffixes in gentoo-x86 tree will probably have to wait till 2008.0
176 release or later.</p>
177 </div>
178 <div class="section">
179 <h1><a class="toc-backref" href="#id7" id="copyright" name="copyright">Copyright</a></h1>
180 <p>This document has been placed in the public domain.</p>
181 <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
182 </div>
184 </div>
185 <div class="footer">
186 <hr class="footer" />
187 <a class="reference" href="glep-0054.txt">View document source</a>.
188 Generated on: 2008-01-06 02:08 UTC.
189 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.
191 </div>
192 </body>
193 </html>

  ViewVC Help
Powered by ViewVC 1.1.20