/[gentoo]/xml/htdocs/proj/en/glep/glep-0055.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0055.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.2 Revision 1.5
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
5<head> 5<head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
8 <title>GLEP 55 -- Use EAPI-suffixed ebuilds (.ebuild-EAPI)</title> 8 <title>GLEP 55 -- Use EAPI-suffixed ebuilds (.ebuild-EAPI)</title>
9 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <style type="text/css">
10</head> 10
11/*
12:Author: David Goodger
13:Contact: goodger@users.sourceforge.net
14:date: $Date: 2009/05/17 20:56:53 $
15:version: $Revision: 1.5 $
16:copyright: This stylesheet has been placed in the public domain.
17
18Default cascading style sheet for the PEP HTML output of Docutils.
19*/
20
21.first {
22 margin-top: 0 }
23
24.last {
25 margin-bottom: 0 }
26
27.navigation {
28 width: 100% ;
29 background: #cc99ff ;
30 margin-top: 0px ;
31 margin-bottom: 0px }
32
33.navigation .navicon {
34 width: 150px ;
35 height: 35px }
36
37.navigation .textlinks {
38 padding-left: 1em ;
39 text-align: left }
40
41.navigation td, .navigation th {
42 padding-left: 0em ;
43 padding-right: 0em ;
44 vertical-align: middle }
45
46.rfc2822 {
47 margin-top: 0.5em ;
48 margin-left: 0.5em ;
49 margin-right: 0.5em ;
50 margin-bottom: 0em }
51
52.rfc2822 td {
53 text-align: left }
54
55.rfc2822 th.field-name {
56 text-align: right ;
57 font-family: sans-serif ;
58 padding-right: 0.5em ;
59 font-weight: bold ;
60 margin-bottom: 0em }
61
62a.toc-backref {
63 text-decoration: none ;
64 color: black }
65
66body {
67 margin: 0px ;
68 margin-bottom: 1em ;
69 padding: 0px }
70
71dd {
72 margin-bottom: 0.5em }
73
74div.section {
75 margin-left: 1em ;
76 margin-right: 1em ;
77 margin-bottom: 1.5em }
78
79div.section div.section {
80 margin-left: 0em ;
81 margin-right: 0em ;
82 margin-top: 1.5em }
83
84div.abstract {
85 margin: 2em 5em }
86
87div.abstract p.topic-title {
88 font-weight: bold ;
89 text-align: center }
90
91div.attention, div.caution, div.danger, div.error, div.hint,
92div.important, div.note, div.tip, div.warning {
93 margin: 2em ;
94 border: medium outset ;
95 padding: 1em }
96
97div.attention p.admonition-title, div.caution p.admonition-title,
98div.danger p.admonition-title, div.error p.admonition-title,
99div.warning p.admonition-title {
100 color: red ;
101 font-weight: bold ;
102 font-family: sans-serif }
103
104div.hint p.admonition-title, div.important p.admonition-title,
105div.note p.admonition-title, div.tip p.admonition-title {
106 font-weight: bold ;
107 font-family: sans-serif }
108
109div.figure {
110 margin-left: 2em }
111
112div.footer, div.header {
113 font-size: smaller }
114
115div.footer {
116 margin-left: 1em ;
117 margin-right: 1em }
118
119div.system-messages {
120 margin: 5em }
121
122div.system-messages h1 {
123 color: red }
124
125div.system-message {
126 border: medium outset ;
127 padding: 1em }
128
129div.system-message p.system-message-title {
130 color: red ;
131 font-weight: bold }
132
133div.topic {
134 margin: 2em }
135
136h1 {
137 font-family: sans-serif ;
138 font-size: large }
139
140h2 {
141 font-family: sans-serif ;
142 font-size: medium }
143
144h3 {
145 font-family: sans-serif ;
146 font-size: small }
147
148h4 {
149 font-family: sans-serif ;
150 font-style: italic ;
151 font-size: small }
152
153h5 {
154 font-family: sans-serif;
155 font-size: x-small }
156
157h6 {
158 font-family: sans-serif;
159 font-style: italic ;
160 font-size: x-small }
161
162.section hr {
163 width: 75% }
164
165ol.simple, ul.simple {
166 margin-bottom: 1em }
167
168ol.arabic {
169 list-style: decimal }
170
171ol.loweralpha {
172 list-style: lower-alpha }
173
174ol.upperalpha {
175 list-style: upper-alpha }
176
177ol.lowerroman {
178 list-style: lower-roman }
179
180ol.upperroman {
181 list-style: upper-roman }
182
183p.caption {
184 font-style: italic }
185
186p.credits {
187 font-style: italic ;
188 font-size: smaller }
189
190p.label {
191 white-space: nowrap }
192
193p.topic-title {
194 font-family: sans-serif ;
195 font-weight: bold }
196
197pre.line-block {
198 font-family: serif ;
199 font-size: 100% }
200
201pre.literal-block, pre.doctest-block {
202 margin-left: 2em ;
203 margin-right: 2em ;
204 background-color: #eeeeee }
205
206span.classifier {
207 font-family: sans-serif ;
208 font-style: oblique }
209
210span.classifier-delimiter {
211 font-family: sans-serif ;
212 font-weight: bold }
213
214span.interpreted {
215 font-family: sans-serif }
216
217span.option-argument {
218 font-style: italic }
219
220span.pre {
221 white-space: pre }
222
223span.problematic {
224 color: red }
225
226table {
227 margin-top: 0.5em ;
228 margin-bottom: 0.5em }
229
230td, th {
231 padding-left: 0.5em ;
232 padding-right: 0.5em ;
233 vertical-align: top }
234
235td.num {
236 text-align: right }
237
238th.field-name {
239 font-weight: bold ;
240 text-align: left ;
241 white-space: nowrap }
242
243h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
244 font-size: 100% }
245
246tt {
247 background-color: #eeeeee }
248
249ul.auto-toc {
250 list-style-type: none }
251
252</style></head>
11<body bgcolor="white"> 253<body bgcolor="white">
12<table class="navigation" cellpadding="0" cellspacing="0" 254<table class="navigation" cellpadding="0" cellspacing="0"
13 width="100%" border="0"> 255 width="100%" border="0">
14<tr><td class="navicon" width="150" height="35"> 256<tr><td class="navicon" width="150" height="35">
15<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 257<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
26<tbody valign="top"> 268<tbody valign="top">
27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">55</td> 269<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">55</td>
28</tr> 270</tr>
29<tr class="field"><th class="field-name">Title:</th><td class="field-body">Use EAPI-suffixed ebuilds (.ebuild-EAPI)</td> 271<tr class="field"><th class="field-name">Title:</th><td class="field-body">Use EAPI-suffixed ebuilds (.ebuild-EAPI)</td>
30</tr> 272</tr>
31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 273<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
32</tr> 274</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-0055.txt?cvsroot=gentoo">2008/01/05 02:36:35</a></td> 275<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0055.txt?cvsroot=gentoo">2009/05/17 17:00:30</a></td>
34</tr> 276</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> 277<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> 278</tr>
37<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 279<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
38</tr> 280</tr>
39<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 281<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
40</tr> 282</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> 283<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="glep-0002.html">text/x-rst</a></td>
42</tr> 284</tr>
43<tr class="field"><th class="field-name">Created:</th><td class="field-body">17-Dec-2007</td> 285<tr class="field"><th class="field-name">Created:</th><td class="field-body">17-Dec-2007</td>
44</tr> 286</tr>
45<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Dec-2007, 22-Dec-2007</td> 287<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">17-Dec-2007, 22-Dec-2007, 17-May-2009</td>
46</tr> 288</tr>
47</tbody> 289</tbody>
48</table> 290</table>
49<hr /> 291<hr />
50<div class="contents topic"> 292<div class="contents topic" id="contents">
51<p class="topic-title first"><a id="contents" name="contents">Contents</a></p> 293<p class="topic-title first">Contents</p>
52<ul class="simple"> 294<ul class="simple">
53<li><a class="reference" href="#abstract" id="id3" name="id3">Abstract</a></li> 295<li><a class="reference internal" href="#abstract" id="id3">Abstract</a></li>
54<li><a class="reference" href="#problem" id="id4" name="id4">Problem</a></li> 296<li><a class="reference internal" href="#problem" id="id4">Problem</a></li>
297<li><a class="reference internal" href="#current-behaviour" id="id5">Current behaviour</a><ul>
298<li><a class="reference internal" href="#incompatible-change-of-inherit-e-g-make-it-look-in-the-package-dir-too" id="id6">Incompatible change of inherit (e.g. make it look in the package dir too)</a></li>
299<li><a class="reference internal" href="#new-global-scope-function" id="id7">New global scope function</a></li>
300<li><a class="reference internal" href="#new-version-format" id="id8">New version format</a></li>
301<li><a class="reference internal" href="#use-newer-bash-features" id="id9">Use newer bash features</a></li>
302</ul>
303</li>
55<li><a class="reference" href="#abstract-solution" id="id5" name="id5">Abstract solution</a></li> 304<li><a class="reference internal" href="#abstract-solution" id="id10">Abstract solution</a></li>
56<li><a class="reference" href="#proposed-solution" id="id6" name="id6">Proposed solution</a></li> 305<li><a class="reference internal" href="#proposed-solution" id="id11">Proposed solution</a></li>
57<li><a class="reference" href="#specification" id="id7" name="id7">Specification</a></li> 306<li><a class="reference internal" href="#specification" id="id12">Specification</a></li>
58<li><a class="reference" href="#application" id="id8" name="id8">Application</a></li> 307<li><a class="reference internal" href="#summary-of-ideas" id="id13">Summary of ideas</a><ul>
59<li><a class="reference" href="#other-ideas" id="id9" name="id9">Other ideas</a></li> 308<li><a class="reference internal" href="#eapi-suffixed-ebuilds-proposed-solution" id="id14">EAPI-suffixed ebuilds (proposed solution)</a></li>
309<li><a class="reference internal" href="#eapi-in-the-filename-with-one-time-extension-change" id="id15">EAPI in the filename with one-time extension change</a></li>
310<li><a class="reference internal" href="#easily-fetchable-eapi-inside-the-ebuild" id="id16">Easily fetchable EAPI inside the ebuild</a></li>
311<li><a class="reference internal" href="#easily-fetchable-eapi-inside-the-ebuild-and-one-time-extension-change" id="id17">Easily fetchable EAPI inside the ebuild and one-time extension change</a></li>
312<li><a class="reference internal" href="#use-different-subdirectories-for-different-eapis-i-e-cat-pkg-eapix" id="id18">Use different subdirectories for different EAPIs, i.e. cat/pkg/eapiX/</a></li>
313</ul>
314</li>
60<li><a class="reference" href="#references" id="id10" name="id10">References</a></li> 315<li><a class="reference internal" href="#references" id="id19">References</a></li>
61<li><a class="reference" href="#copyright" id="id11" name="id11">Copyright</a></li> 316<li><a class="reference internal" href="#copyright" id="id20">Copyright</a></li>
62</ul> 317</ul>
63</div> 318</div>
64<blockquote> 319<blockquote>
65<p>&quot;A little learning is a dangerous thing; drink deep, or taste not the Pierian 320<p>&quot;A little learning is a dangerous thing; drink deep, or taste not the Pierian
66spring: there shallow draughts intoxicate the brain, and drinking largely 321spring: there shallow draughts intoxicate the brain, and drinking largely
67sobers us again.&quot;</p> 322sobers us again.&quot;</p>
68<p class="attribution">&mdash;Alexander Pope, An Essay on Criticism</p> 323<p class="attribution">&mdash;Alexander Pope, An Essay on Criticism</p>
69</blockquote> 324</blockquote>
70<div class="section"> 325<div class="section" id="abstract">
71<h1><a class="toc-backref" href="#id3" id="abstract" name="abstract">Abstract</a></h1> 326<h1><a class="toc-backref" href="#id3">Abstract</a></h1>
72<p>This GLEP proposes usage of EAPI-suffixed file extensions for ebuilds (for 327<p>This GLEP proposes usage of EAPI-suffixed file extensions for ebuilds (for
73example, foo-1.2.3.ebuild-1).</p> 328example, foo-1.2.3.ebuild-1).</p>
74</div> 329</div>
75<div class="section"> 330<div class="section" id="problem">
76<h1><a class="toc-backref" href="#id4" id="problem" name="problem">Problem</a></h1> 331<h1><a class="toc-backref" href="#id4">Problem</a></h1>
77<p>The current way of specifying the EAPI in ebuilds is flawed. In order to get the 332<p>The current way of specifying the EAPI in ebuilds is flawed. In order to get the
78EAPI the package manager needs to source the ebuild, which itself needs the EAPI 333EAPI the package manager needs to source the ebuild, which itself needs the EAPI
79in the first place. Otherwise it imposes a serious limitation, namely every ebuild, 334in the first place. Otherwise it imposes a serious limitation, namely every ebuild,
80using any of the future EAPIs, will have to be source'able by old package 335using any of the future EAPIs, will have to be source'able by old package
81managers and hence there is no way to do any of the following:</p> 336managers and hence there is no way to do any of the following:</p>
83<ul class="simple"> 338<ul class="simple">
84<li>Change the behaviour of inherit in any way (for example, to extend or change 339<li>Change the behaviour of inherit in any way (for example, to extend or change
85eclass functionality).</li> 340eclass functionality).</li>
86<li>Add new global scope functions in any sane way.</li> 341<li>Add new global scope functions in any sane way.</li>
87<li>Extend versioning rules in an EAPI - for example, addition of the scm 342<li>Extend versioning rules in an EAPI - for example, addition of the scm
88suffix - GLEP54 <a class="footnote-reference" href="#glep54" id="id1" name="id1">[1]</a>.</li> 343suffix - GLEP54 <a class="footnote-reference" href="#glep54" id="id1">[1]</a> or allowing more sensible version formats like
344<tt class="docutils literal"><span class="pre">1-rc1</span></tt>, <tt class="docutils literal"><span class="pre">1-alpha</span></tt> etc. to match upstream more closely.</li>
345<li>Use newer bash features.</li>
89</ul> 346</ul>
90</blockquote> 347</blockquote>
91</div> 348</div>
92<div class="section"> 349<div class="section" id="current-behaviour">
93<h1><a class="toc-backref" href="#id5" id="abstract-solution" name="abstract-solution">Abstract solution</a></h1> 350<h1><a class="toc-backref" href="#id5">Current behaviour</a></h1>
351<p>Following subsections show what happens if you introduce any of the mentioned
352changes in an ebuild and try to install it with portage 2.1.6.13.</p>
353<div class="section" id="incompatible-change-of-inherit-e-g-make-it-look-in-the-package-dir-too">
354<h2><a class="toc-backref" href="#id6">Incompatible change of inherit (e.g. make it look in the package dir too)</a></h2>
355<p><tt class="docutils literal"><span class="pre">sys-apps/foo-1.ebuild</span></tt>:</p>
356<pre class="literal-block">
357EAPI=&quot;5&quot;
358inherit &quot;foo&quot;
359
360DESCRIPTION=&quot;&quot;
361HOMEPAGE=&quot;&quot;
362SRC_URI=&quot;&quot;
363...
364</pre>
365<p>Result:</p>
366<pre class="literal-block">
367*
368* ERROR: sys-apps/foo-1 failed.
369* Call stack:
370* ebuild.sh, line 1879: Called _source_ebuild
371* ebuild.sh, line 1818: Called source '/var/lib/gentoo/repositories/peper/sys-apps/foo/foo-1.ebuild'
372* foo-1.ebuild, line 6: Called inherit 'foo'
373* ebuild.sh, line 1218: Called die
374* The specific snippet of code:
375* [ ! -e &quot;$location&quot; ] &amp;&amp; die &quot;${1}.eclass could not be found by inherit()&quot;
376* The die message:
377* foo.eclass could not be found by inherit()
378*
379* If you need support, post the topmost build error, and the call stack if relevant.
380* This ebuild is from an overlay: '/var/lib/gentoo/repositories/peper/'
381*
382
383!!! All ebuilds that could satisfy &quot;sys-apps/foo&quot; have been masked.
384!!! One of the following masked packages is required to complete your request:
385- sys-apps/foo-1 (masked by: corruption)
386</pre>
387<p>Current portage looks for eclasses only in the <tt class="docutils literal"><span class="pre">eclass</span></tt> directory of a
388repository. This results in a fatal error and ebuild being masked by corruption
389- might be pretty confusing to users.</p>
390</div>
391<div class="section" id="new-global-scope-function">
392<h2><a class="toc-backref" href="#id7">New global scope function</a></h2>
393<p><tt class="docutils literal"><span class="pre">sys-apps/foo-1.ebuild</span></tt>:</p>
394<pre class="literal-block">
395EAPI=&quot;5&quot;
396new_global_scope_function &quot;foo&quot;
397
398DESCRIPTION=&quot;&quot;
399HOMEPAGE=&quot;&quot;
400SRC_URI=&quot;&quot;
401...
402</pre>
403<p>Result:</p>
404<pre class="literal-block">
405/var/lib/gentoo/repositories/peper/sys-apps/foo/foo-1.ebuild: line 7: new_global_scope_function: command not found
406
407!!! All ebuilds that could satisfy &quot;sys-apps/foo&quot; have been masked.
408!!! One of the following masked packages is required to complete your request:
409- sys-apps/foo-1 (masked by: EAPI 5)
410
411The current version of portage supports EAPI '2'. You must upgrade to a
412newer version of portage before EAPI masked packages can be installed.
413</pre>
414<p>Not that bad as user is advised to upgrade portage.</p>
415</div>
416<div class="section" id="new-version-format">
417<h2><a class="toc-backref" href="#id8">New version format</a></h2>
418<p><tt class="docutils literal"><span class="pre">sys-apps/foo-2-rc1.ebuild</span></tt>:</p>
419<pre class="literal-block">
420Invalid ebuild name: /var/lib/gentoo/repositories/peper/sys-apps/foo/foo-2-rc1.ebuild
421
422emerge: there are no ebuilds to satisfy &quot;sys-apps/foo&quot;
423</pre>
424<p>Not the best error message, especially if there are lots of them.</p>
425</div>
426<div class="section" id="use-newer-bash-features">
427<h2><a class="toc-backref" href="#id9">Use newer bash features</a></h2>
428<p><tt class="docutils literal"><span class="pre">|&amp;</span></tt> is a new type of redirection added in bash-4. It cannot be used even in
429local scope as bash still parses the whole ebuild.</p>
430<p><tt class="docutils literal"><span class="pre">sys-apps/foo-1.ebuild</span></tt>:</p>
431<pre class="literal-block">
432EAPI=&quot;5&quot;
433
434foo() {
435 echo &quot;foo&quot; |&amp; cat
436}
437</pre>
438<p>Result:</p>
439<pre class="literal-block">
440/var/lib/gentoo/repositories/peper/sys-apps/foo/foo-1.ebuild: line 8: syntax error near unexpected token `&amp;'
441/var/lib/gentoo/repositories/peper/sys-apps/foo/foo-1.ebuild: line 8: ` echo &quot;foo&quot; |&amp; cat'
442*
443* ERROR: sys-apps/foo-1 failed.
444* Call stack:
445* ebuild.sh, line 1879: Called _source_ebuild
446* ebuild.sh, line 1818: Called die
447* The specific snippet of code:
448* source &quot;${EBUILD}&quot; || die &quot;error sourcing ebuild&quot;
449* The die message:
450* error sourcing ebuild
451*
452* If you need support, post the topmost build error, and the call stack if relevant.
453* This ebuild is from an overlay: '/var/lib/gentoo/repositories/peper/'
454* ... done!
455
456!!! All ebuilds that could satisfy &quot;sys-apps/foo&quot; have been masked.
457!!! One of the following masked packages is required to complete your request:
458- sys-apps/foo-1 (masked by: corruption)
459</pre>
460<p>Again, not the best error.</p>
461</div>
462</div>
463<div class="section" id="abstract-solution">
464<h1><a class="toc-backref" href="#id10">Abstract solution</a></h1>
94<p>A solution to this problem has to lift those limitations and the only way to do 465<p>A solution to this problem has to lift those limitations and the only way to do
95it is to make the EAPI of an ebuild available to the package managers in a way 466it is to make the EAPI of an ebuild available to the package managers in a way
96that doesn't require them to source the ebuild. Another important requirement is 467that doesn't require them to source the ebuild. Another important requirement is
97for the solution to be backward compatible, which has the pleasant side-effect 468for the solution to be backward compatible, which has the pleasant side-effect
98of making the solution applicable in the Gentoo tree right away. Opposed to 469of making the solution applicable in the Gentoo tree right away. Opposed to
99waiting an arbitrary amount of time, which is never long enough anyway, as the 470waiting an arbitrary amount of time, which is never long enough anyway, as the
100issues listed on the common portage problems page - <a class="footnote-reference" href="#portageproblems" id="id2" name="id2">[2]</a> - show.</p> 471issues listed on the common portage problems page - <a class="footnote-reference" href="#portageproblems" id="id2">[2]</a> - show.</p>
101</div> 472</div>
102<div class="section"> 473<div class="section" id="proposed-solution">
103<h1><a class="toc-backref" href="#id6" id="proposed-solution" name="proposed-solution">Proposed solution</a></h1> 474<h1><a class="toc-backref" href="#id11">Proposed solution</a></h1>
104<p>The proposed solution is to use EAPI-suffixed file extensions for ebuilds. This 475<p>The proposed solution is to use EAPI-suffixed file extensions for ebuilds. This
105allows package managers to trivially read the EAPI from the ebuild filename. It 476allows package managers to trivially read the EAPI from the ebuild filename. It
106is also backwards compatible, because currently ebuilds are recognised by the 477is also backwards compatible, because currently ebuilds are recognised by the
107<tt class="docutils literal"><span class="pre">.ebuild</span></tt> file extension and hence EAPI-suffixed ebuilds are simply ignored by 478<tt class="docutils literal"><span class="pre">.ebuild</span></tt> file extension and hence EAPI-suffixed ebuilds are simply ignored by
108the package managers.</p> 479the package managers.</p>
109</div> 480</div>
110<div class="section"> 481<div class="section" id="specification">
111<h1><a class="toc-backref" href="#id7" id="specification" name="specification">Specification</a></h1> 482<h1><a class="toc-backref" href="#id12">Specification</a></h1>
112<p>Ebuild filename extension syntax: <tt class="docutils literal"><span class="pre">ebuild[-&lt;EAPI&gt;]</span></tt>, where <tt class="docutils literal"><span class="pre">[]</span></tt> denotes an 483<p>Ebuild filename extension syntax: <tt class="docutils literal"><span class="pre">ebuild[-&lt;EAPI&gt;]</span></tt>, where <tt class="docutils literal"><span class="pre">[]</span></tt> denotes an
113optional part, and <tt class="docutils literal"><span class="pre">&lt;EAPI&gt;</span></tt> is the EAPI of the ebuild.</p> 484optional part, and <tt class="docutils literal"><span class="pre">&lt;EAPI&gt;</span></tt> is the EAPI of the ebuild.</p>
114<p>Let's call the EAPI included in the ebuild filename the pre-source EAPI, and the 485<p>The EAPI used by the ebuild is the EAPI included in the filename if it is set.
115EAPI set inside the ebuild the post-source EAPI. Given these two, the final EAPI 486Otherwise the EAPI set inside the ebuild is used, which defaults to 0 (this is
116used by the ebuild can be established by following these steps:</p> 487the current behaviour).</p>
117<blockquote>
118<ul class="simple">
119<li>If the pre-source EAPI is not set it defaults to 0.</li>
120<li>If the pre-source EAPI is not recognised it is returned immediately.</li>
121<li>If the post-source EAPI is not set, it defaults to the pre-source EAPI.</li>
122<li>post-source EAPI is returned.</li>
123</ul>
124</blockquote>
125<p>The above process should be only used to generate the metadata cache. Should the
126pre-source EAPI be unsupported the cache entry cannot be generated.</p>
127<p>Ebuilds with unsupported EAPIs are masked.</p> 488<p>Ebuilds with unsupported EAPIs are masked.</p>
128<p>QA tools should consider it an error for both EAPIs to be set explicitly to 489<p>It should be considered an error to set the EAPI both in the filename and in the
129different values. Package managers may warn, but must use the post-source EAPI 490ebuild.</p>
130in such cases.</p>
131<p>Examples:</p> 491<p>Examples:</p>
132<blockquote> 492<blockquote>
133<ul> 493<ul>
134<li><dl class="first docutils"> 494<li><dl class="first docutils">
135<dt><tt class="docutils literal"><span class="pre">pkg-1.ebuild</span></tt>, no EAPI set inside the ebuild</dt> 495<dt><tt class="docutils literal"><span class="pre">pkg-1.ebuild</span></tt>, no EAPI set inside the ebuild</dt>
136<dd><p class="first last">pre-source EAPI defaults to 0, post-source EAPI defaults to pre-source EAPI. 496<dd><p class="first last">EAPI defaults to 0.</p>
137EAPI 0 is used.</p>
138</dd> 497</dd>
139</dl> 498</dl>
140</li> 499</li>
141<li><dl class="first docutils"> 500<li><dl class="first docutils">
142<dt><tt class="docutils literal"><span class="pre">pkg-2.ebuild-1</span></tt>, no EAPI set inside the ebuild</dt> 501<dt><tt class="docutils literal"><span class="pre">pkg-2.ebuild-1</span></tt>, no EAPI set inside the ebuild</dt>
143<dd><p class="first last">pre-source EAPI is 1, post-source EAPI defaults to pre-source EAPI. 502<dd><p class="first last">EAPI 1 is used.</p>
144EAPI 1 is used.</p>
145</dd> 503</dd>
146</dl> 504</dl>
147</li> 505</li>
148<li><dl class="first docutils"> 506<li><dl class="first docutils">
149<dt><tt class="docutils literal"><span class="pre">pkg-3.ebuild</span></tt>, <tt class="docutils literal"><span class="pre">EAPI=&quot;1&quot;</span></tt></dt> 507<dt><tt class="docutils literal"><span class="pre">pkg-3.ebuild-1</span></tt>, <tt class="docutils literal"><span class="pre">EAPI=&quot;1&quot;</span></tt></dt>
150<dd><p class="first last">pre-source EAPI defaults to 0, post-source EAPI is 1. 508<dd><p class="first last">EAPI set in both places - error.</p>
151EAPI 1 is used.</p>
152</dd>
153</dl>
154</li>
155<li><dl class="first docutils">
156<dt><tt class="docutils literal"><span class="pre">pkg-4.ebuild-2</span></tt>, <tt class="docutils literal"><span class="pre">EAPI=&quot;1&quot;</span></tt></dt>
157<dd><p class="first last">pre-source EAPI is 2, post-source EAPI is 1.
158EAPI 1 is used, but note that one should <strong>never</strong> explicitly set both
159EAPIs to different values.</p>
160</dd>
161</dl>
162</li>
163<li><dl class="first docutils">
164<dt><tt class="docutils literal"><span class="pre">pkg-5.ebuild-2</span></tt>, no EAPI set inside the ebuild, package manager not supporting EAPI 2</dt>
165<dd><p class="first last">pre-source EAPI is 2, post-source EAPI is never checked.
166ebuild is masked because of the unsupported pre-source EAPI.</p>
167</dd>
168</dl>
169</li>
170<li><dl class="first docutils">
171<dt><tt class="docutils literal"><span class="pre">pkg-6.ebuild</span></tt>, <tt class="docutils literal"><span class="pre">EAPI=&quot;2&quot;</span></tt>, package manager not supporting EAPI 2</dt>
172<dd><p class="first last">pre-source EAPI defaults to 0, post-source EAPI is 2 (assuming the
173package manager didn't die when sourcing the ebuild thinking that EAPI 0
174is used).
175ebuild is masked because of the unsupported post-source EAPI.</p>
176</dd> 509</dd>
177</dl> 510</dl>
178</li> 511</li>
179</ul> 512</ul>
180</blockquote> 513</blockquote>
183allowing authors to provide backwards compatible ebuilds, it would introduce 516allowing authors to provide backwards compatible ebuilds, it would introduce
184problems too. The first is the requirement to have strict EAPI ordering, the 517problems too. The first is the requirement to have strict EAPI ordering, the
185second is ensuring that all the ebuilds for a single category/package-version 518second is ensuring that all the ebuilds for a single category/package-version
186are equivalent, i.e. installing any of them has exactly the same effect on a 519are equivalent, i.e. installing any of them has exactly the same effect on a
187given system.</p> 520given system.</p>
521<p>Also note that it is not a new restriction. It is already possible to illegally
522have multiple versions with different EAPIs as e.g. <tt class="docutils literal"><span class="pre">1.0</span> <span class="pre">==</span> <span class="pre">1.00</span> <span class="pre">==</span> <span class="pre">1.00-r0</span></tt>
523and hence you could have <tt class="docutils literal"><span class="pre">foo-1.0.ebuild</span></tt> with EAPI X and <tt class="docutils literal"><span class="pre">foo-1.00.ebuild</span></tt>
524with EAPI Y.</p>
188</div> 525</div>
189<div class="section"> 526<div class="section" id="summary-of-ideas">
190<h1><a class="toc-backref" href="#id8" id="application" name="application">Application</a></h1> 527<h1><a class="toc-backref" href="#id13">Summary of ideas</a></h1>
191<p>Note that the developers should only set the pre-source EAPI. The process 528<div class="section" id="eapi-suffixed-ebuilds-proposed-solution">
192described above is only necessary to avoid undefined behaviour in corner cases 529<h2><a class="toc-backref" href="#id14">EAPI-suffixed ebuilds (proposed solution)</a></h2>
193and to retain backwards compatibility.</p> 530<dl class="docutils">
194<p>QA tools may warn if the post-source EAPI is set at all, thus helping with the 531<dt>Properties:</dt>
195transition to the new format.</p> 532<dd><ul class="first last simple">
533<li>Can be used right away: yes</li>
534<li>Hurts performance: no</li>
535</ul>
536</dd>
537</dl>
538<p>Some say it is clear and simple, others that it is ugly and unintuitive.</p>
196</div> 539</div>
197<div class="section"> 540<div class="section" id="eapi-in-the-filename-with-one-time-extension-change">
198<h1><a class="toc-backref" href="#id9" id="other-ideas" name="other-ideas">Other ideas</a></h1> 541<h2><a class="toc-backref" href="#id15">EAPI in the filename with one-time extension change</a></h2>
199<p>There were some other solutions proposed on the mailing list:</p> 542<p>One of the proposed filename formats:
543<tt class="docutils literal"><span class="pre">&lt;PKG&gt;-&lt;VER&gt;.eapi-&lt;EAPI&gt;.eb</span></tt></p>
544<dl class="docutils">
545<dt>Properties:</dt>
546<dd><ul class="first last simple">
547<li>Can be used right away: yes</li>
548<li>Hurts performance: no</li>
549</ul>
550</dd>
551</dl>
552<p>This is equivalent to the proposed solution.</p>
553<p>Some say it is better because the extension is static.</p>
554</div>
555<div class="section" id="easily-fetchable-eapi-inside-the-ebuild">
556<h2><a class="toc-backref" href="#id16">Easily fetchable EAPI inside the ebuild</a></h2>
557<dl class="docutils">
558<dt>Properties:</dt>
559<dd><ul class="first last simple">
560<li>Can be used right away: no</li>
561<li>Hurts performance: yes</li>
562</ul>
563</dd>
564</dl>
565<p>Cannot be used right away as it would trigger the errors shown in Current
566behaviour section for old package managers.</p>
567<p>Performance decrease comes from the fact that with version format changes in the
568picture package managers need EAPI to parse the ebuild's version. That means that merely
569picking the best version of a package requires loading EAPI (from cache or the
570ebuild) for each available ebuild.</p>
571<p>Here is more or less how the package manager figures out the best available
572version for a package with N versions available.</p>
200<blockquote> 573<blockquote>
574<ul class="simple">
575<li>EAPI in the filename<ul>
576<li>Read the directory containing the package - readdir()</li>
577<li>For each ebuild, read its EAPI and using that parse its version - no I/O</li>
578<li>Sort the versions - no I/O</li>
579<li>Going down from the highest to the lowest version<ul>
580<li>Get the metadata from cache - 2 x stat() + read()</li>
581<li>break if the version is visible</li>
201<ul> 582</ul>
583</li>
584</ul>
585</li>
586<li>EAPI in the ebuild<ul>
587<li>Read the directory containing the package - readdir()</li>
588<li>For each ebuild load its metadata from cache to get its EAPI - N x (2 x stat() + read())</li>
589<li>Sort the versions - no I/O</li>
590<li>Going down from the highest to the lowest version<ul>
591<li>(metadata is already loaded) - no I/O</li>
592<li>break if the version is visible - no I/O</li>
593</ul>
594</li>
595</ul>
596</li>
597</ul>
598</blockquote>
599<p>The difference is in for how many versions the package manager needs to hit
600cache. With EAPI in the ebuild it needs to do that for all versions, with EAPI
601in the filename it depends on versions visibility.
602For example, package foo has versions 1, 2, 3, 4, 5 and 6. 6 is masked, 5 is
603~arch and 1,2,3 and 4 are arch. Say, the user accepts only arch for this
604package. With EAPI in the filename it will read metadata only for versions
6056, 5 and 4. With EAPI in the ebuild it needs to load metadata for all versions.</p>
606<p>It's hard to say what's the avarage case, but surely the worst case scenario
607(when only the lowest version is visible) is uncommon.</p>
608</div>
609<div class="section" id="easily-fetchable-eapi-inside-the-ebuild-and-one-time-extension-change">
610<h2><a class="toc-backref" href="#id17">Easily fetchable EAPI inside the ebuild and one-time extension change</a></h2>
202<li><dl class="first docutils"> 611<dl class="docutils">
203<dt>Set the EAPI inside the ebuild in a way that makes it easy to fetch it</dt> 612<dt>Properties:</dt>
204<dd><ul class="first last simple"> 613<dd><ul class="first last simple">
205<li>Doesn't meet the backward compatibility requirement.</li> 614<li>Can be used right away: yes</li>
206<li>Isn't forward compatible either.</li> 615<li>Hurts performance: yes</li>
207<li>Could be confusing as ebuilds are considered bash scripts and this
208would impose additional restrictions on the ebuild format.</li>
209</ul>
210</dd>
211</dl> 616</ul>
617</dd>
212</li> 618</dl>
619<p>Performance decrease as described in the previous section.</p>
620<p>Some say it is clear and simple, others that it is confusing and unintuitive,
621because of the arbitrary format restrictions in what is a bash script otherwise.</p>
622</div>
623<div class="section" id="use-different-subdirectories-for-different-eapis-i-e-cat-pkg-eapix">
624<h2><a class="toc-backref" href="#id18">Use different subdirectories for different EAPIs, i.e. cat/pkg/eapiX/</a></h2>
213<li><dl class="first docutils"> 625<dl class="docutils">
214<dt>Do the above and change the ebuild extension to <tt class="docutils literal"><span class="pre">.ebuild-ng</span></tt></dt> 626<dt>Properties:</dt>
215<dd><ul class="first last simple"> 627<dd><ul class="first last simple">
216<li>Meets the backward compatibility requirement.</li> 628<li>Can be used right away: yes</li>
217<li>Still can be confusing.</li> 629<li>Hurts performance: yes</li>
218<li>Isn't really forward compatible. What would be after <tt class="docutils literal"><span class="pre">.ebuild-ng</span></tt>?
219<tt class="docutils literal"><span class="pre">.ebuild-ng-ng</span></tt>?</li>
220</ul>
221</dd>
222</dl> 630</ul>
631</dd>
223</li> 632</dl>
224<li><dl class="first docutils"> 633<p>Performance decrease comes from the fact that it adds several more directory
225<dt>Use different subdirectories for different EAPIs, i.e. cat/pkg/eapiX/</dt> 634reads.</p>
226<dd><ul class="first last simple">
227<li>Meets both requirements.</li>
228<li>Introduces a noticeable performance hit (several more directory reads
229in an I/O bound operation).</li>
230<li>Makes it much harder for maintainers to see what they have.</li> 635<p>Some say that it makes it much harder for maintainers to see what they have.</p>
231</ul>
232</dd>
233</dl>
234</li>
235</ul>
236</blockquote>
237</div> 636</div>
238<div class="section"> 637</div>
638<div class="section" id="references">
239<h1><a class="toc-backref" href="#id10" id="references" name="references">References</a></h1> 639<h1><a class="toc-backref" href="#id19">References</a></h1>
240<table class="docutils footnote" frame="void" id="glep54" rules="none"> 640<table class="docutils footnote" frame="void" id="glep54" rules="none">
241<colgroup><col class="label" /><col /></colgroup> 641<colgroup><col class="label" /><col /></colgroup>
242<tbody valign="top"> 642<tbody valign="top">
243<tr><td class="label"><a class="fn-backref" href="#id1" name="glep54">[1]</a></td><td>GLEP 54, scm package version suffix 643<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>GLEP 54, scm package version suffix
244(<a class="reference" href="http://glep.gentoo.org/glep-0054.html">http://glep.gentoo.org/glep-0054.html</a>)</td></tr> 644(<a class="reference external" href="http://glep.gentoo.org/glep-0054.html">http://glep.gentoo.org/glep-0054.html</a>)</td></tr>
245</tbody> 645</tbody>
246</table> 646</table>
247<table class="docutils footnote" frame="void" id="portageproblems" rules="none"> 647<table class="docutils footnote" frame="void" id="portageproblems" rules="none">
248<colgroup><col class="label" /><col /></colgroup> 648<colgroup><col class="label" /><col /></colgroup>
249<tbody valign="top"> 649<tbody valign="top">
250<tr><td class="label"><a class="fn-backref" href="#id2" name="portageproblems">[2]</a></td><td>Common portage problems 650<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Common portage problems
251(<a class="reference" href="http://www.gentoo.org/proj/en/portage/doc/common-problems.xml">http://www.gentoo.org/proj/en/portage/doc/common-problems.xml</a>)</td></tr> 651(<a class="reference external" href="http://www.gentoo.org/proj/en/portage/doc/common-problems.xml">http://www.gentoo.org/proj/en/portage/doc/common-problems.xml</a>)</td></tr>
252</tbody> 652</tbody>
253</table> 653</table>
254</div> 654</div>
255<div class="section"> 655<div class="section" id="copyright">
256<h1><a class="toc-backref" href="#id11" id="copyright" name="copyright">Copyright</a></h1> 656<h1><a class="toc-backref" href="#id20">Copyright</a></h1>
257<p>This document has been placed in the public domain.</p> 657<p>This document has been placed in the public domain.</p>
258<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 658<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
259</div> 659</div>
260 660
261</div> 661</div>
262<div class="footer"> 662<div class="footer">
263<hr class="footer" /> 663<hr class="footer" />
264<a class="reference" href="glep-0055.txt">View document source</a>. 664<a class="reference external" href="glep-0055.txt">View document source</a>.
265Generated on: 2008-01-06 02:39 UTC. 665Generated on: 2009-05-17 20:42 UTC.
266Generated 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. 666Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
267 667
268</div> 668</div>
269</body> 669</body>
270</html> 670</html>
271

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.5

  ViewVC Help
Powered by ViewVC 1.1.20