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

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

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

Revision 1.3 Revision 1.9
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.9: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 33 -- Eclass Restructure/Redesign</title> 8 <title>GLEP 33 -- Eclass Restructure/Redesign</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"
… …
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 16<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 17 border="0" width="150" height="35" /></a></td>
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="./glep-0033.txt">GLEP Source</a></b>] 21[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0033.txt">GLEP Source</a></b>]
26</td></tr></table> 22</td></tr></table>
27<table class="rfc2822 docutils field-list" frame="void" rules="none"> 23<table class="rfc2822 docutils field-list" frame="void" rules="none">
28<col class="field-name" /> 24<col class="field-name" />
29<col class="field-body" /> 25<col class="field-body" />
30<tbody valign="top"> 26<tbody valign="top">
31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">33</td> 27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">33</td>
32</tr> 28</tr>
33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Eclass Restructure/Redesign</td> 29<tr class="field"><th class="field-name">Title:</th><td class="field-body">Eclass Restructure/Redesign</td>
34</tr> 30</tr>
35<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.6</td>
36</tr> 32</tr>
37<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/xml/htdocs/proj/en/glep/glep-0033.txt?cvsroot=gentoo">2005/03/06 20:39:19</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-0033.txt?cvsroot=gentoo">2006/09/05 20:54:30</a></td>
38</tr> 34</tr>
39<tr class="field"><th class="field-name">Author:</th><td class="field-body">Brian Harring &lt;ferringb&#32;&#97;t&#32;gentoo.org&gt;, John Mylchreest &lt;johnm&#32;&#97;t&#32;gentoo.org&gt;</td> 35<tr class="field"><th class="field-name">Author:</th><td class="field-body">Brian Harring &lt;ferringb&#32;&#97;t&#32;gentoo.org&gt;, John Mylchreest &lt;johnm&#32;&#97;t&#32;gentoo.org&gt;</td>
40</tr> 36</tr>
41<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">Moribound</td>
42</tr> 38</tr>
43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 39<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44</tr> 40</tr>
45<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="http://www.python.org/peps/glep-0012.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>
46</tr> 42</tr>
47<tr class="field"><th class="field-name">Created:</th><td class="field-body">29-Jan-2005</td> 43<tr class="field"><th class="field-name">Created:</th><td class="field-body">29-Jan-2005</td>
48</tr> 44</tr>
49<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">29-Jan-2005 6-Mar-2005</td> 45<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">29-Jan-2005 6-Mar-2005 15-Sep-2005 5-Sep-2006</td>
50</tr> 46</tr>
51</tbody> 47</tbody>
52</table> 48</table>
53<hr /> 49<hr />
54<div class="contents topic" id="contents"> 50<div class="contents topic">
55<p class="topic-title first"><a name="contents">Contents</a></p> 51<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
56<ul class="simple"> 52<ul class="simple">
53<li><a class="reference" href="#status" id="id2" name="id2">Status</a></li>
57<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> 54<li><a class="reference" href="#abstract" id="id3" name="id3">Abstract</a></li>
58<li><a class="reference" href="#terminology" id="id3" name="id3">Terminology</a></li> 55<li><a class="reference" href="#terminology" id="id4" name="id4">Terminology</a></li>
59<li><a class="reference" href="#motivation-and-rationale" id="id4" name="id4">Motivation and Rationale</a></li> 56<li><a class="reference" href="#motivation-and-rationale" id="id5" name="id5">Motivation and Rationale</a></li>
60<li><a class="reference" href="#specification" id="id5" name="id5">Specification</a><ul> 57<li><a class="reference" href="#specification" id="id6" name="id6">Specification</a><ul>
61<li><a class="reference" href="#ebuild-libraries-elibs-for-short" id="id6" name="id6">Ebuild Libraries (elibs for short)</a></li> 58<li><a class="reference" href="#ebuild-libraries-elibs-for-short" id="id7" name="id7">Ebuild Libraries (elibs for short)</a></li>
62<li><a class="reference" href="#the-reduced-role-of-eclasses-and-a-clarification-of-existing-eclass-requirements" id="id7" name="id7">The reduced role of Eclasses, and a clarification of existing Eclass requirements</a></li> 59<li><a class="reference" href="#the-reduced-role-of-eclasses-and-a-clarification-of-existing-eclass-requirements" id="id8" name="id8">The reduced role of Eclasses, and a clarification of existing Eclass requirements</a></li>
63<li><a class="reference" href="#the-end-of-backwards-compatibility" id="id8" name="id8">The end of backwards compatibility...</a></li> 60<li><a class="reference" href="#the-end-of-backwards-compatibility" id="id9" name="id9">The end of backwards compatibility...</a></li>
64<li><a class="reference" href="#tree-restructuring" id="id9" name="id9">Tree restructuring</a></li> 61<li><a class="reference" href="#tree-restructuring" id="id10" name="id10">Tree restructuring</a></li>
65<li><a class="reference" href="#the-start-of-a-different-phase-of-backwards-compatibility" id="id10" name="id10">The start of a different phase of backwards compatibility</a></li> 62<li><a class="reference" href="#the-start-of-a-different-phase-of-backwards-compatibility" id="id11" name="id11">The start of a different phase of backwards compatibility</a></li>
66<li><a class="reference" href="#migrating-to-the-new-setup" id="id11" name="id11">Migrating to the new setup</a></li> 63<li><a class="reference" href="#migrating-to-the-new-setup" id="id12" name="id12">Migrating to the new setup</a></li>
67</ul> 64</ul>
68</li> 65</li>
69<li><a class="reference" href="#backwards-compatibility" id="id12" name="id12">Backwards Compatibility</a></li> 66<li><a class="reference" href="#backwards-compatibility" id="id13" name="id13">Backwards Compatibility</a></li>
70<li><a class="reference" href="#copyright" id="id13" name="id13">Copyright</a></li> 67<li><a class="reference" href="#copyright" id="id14" name="id14">Copyright</a></li>
71</ul> 68</ul>
72</div> 69</div>
73<div class="section" id="abstract"> 70<div class="section">
71<h1><a class="toc-backref" href="#id2" id="status" name="status">Status</a></h1>
72<p>Approved by the Gentoo Council on 15 September 2005. As of Sept. 2006
73this GLEP is on hold, pending future revisions.</p>
74</div>
75<div class="section">
74<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1> 76<h1><a class="toc-backref" href="#id3" id="abstract" name="abstract">Abstract</a></h1>
75<p>For any design, the transition from theoretical to applied exposes inadequacies 77<p>For any design, the transition from theoretical to applied exposes inadequacies
76in the original design. This document is intended to document, and propose a 78in the original design. This document is intended to document, and propose a
77revision of the current eclass setup to address current eclass inadequacies.</p> 79revision of the current eclass setup to address current eclass inadequacies.</p>
78<p>This document proposes several things- the creation of ebuild libraries, 'elibs', 80<p>This document proposes several things- the creation of ebuild libraries, 'elibs',
79a narrowing of the focus of eclasses, a move of eclasses w/in the tree, the 81a narrowing of the focus of eclasses, a move of eclasses w/in the tree, the
80addition of changelogs, and a way to allow for simple eclass gpg signing. 82addition of changelogs, and a way to allow for simple eclass gpg signing.
81In general, a large scale restructuring of what eclasses are and how they're 83In general, a large scale restructuring of what eclasses are and how they're
82implemented. Essentially version two of the eclass setup.</p> 84implemented. Essentially version two of the eclass setup.</p>
83</div> 85</div>
84<div class="section" id="terminology"> 86<div class="section">
85<h1><a class="toc-backref" href="#id3" name="terminology">Terminology</a></h1> 87<h1><a class="toc-backref" href="#id4" id="terminology" name="terminology">Terminology</a></h1>
86<p>From this point on, the proposed eclass setup will be called 'new eclasses', the 88<p>From this point on, the proposed eclass setup will be called 'new eclasses', the
87existing crop (as of this writing) will be referenced as 'old eclasses'. The 89existing crop (as of this writing) will be referenced as 'old eclasses'. The
88distinction is elaborated on within this document.</p> 90distinction is elaborated on within this document.</p>
89</div> 91</div>
90<div class="section" id="motivation-and-rationale"> 92<div class="section">
91<h1><a class="toc-backref" href="#id4" name="motivation-and-rationale">Motivation and Rationale</a></h1> 93<h1><a class="toc-backref" href="#id5" id="motivation-and-rationale" name="motivation-and-rationale">Motivation and Rationale</a></h1>
92<p>Eclasses within the tree currently are a bit of a mess- they're forced to 94<p>Eclasses within the tree currently are a bit of a mess- they're forced to
93maintain backwards compatibility w/ all previous functionality. In effect, 95maintain backwards compatibility w/ all previous functionality. In effect,
94their api is constant, and can only be added to- never changing the existing 96their api is constant, and can only be added to- never changing the existing
95functionality. This obviously is quite limiting, and leads to cruft accruing in 97functionality. This obviously is quite limiting, and leads to cruft accruing in
96eclasses as a eclasses design is refined. This needs to be dealt with prior to 98eclasses as a eclasses design is refined. This needs to be dealt with prior to
… …
107function they're using, but shouldn't have to worry about their default src_* 109function they're using, but shouldn't have to worry about their default src_*
108and pkg_* functions being overwritten, let alone the env changes.</p> 110and pkg_* functions being overwritten, let alone the env changes.</p>
109<p>Addressing up front why a collection of eclass refinements are being rolled into 111<p>Addressing up front why a collection of eclass refinements are being rolled into
110a single set of changes, parts of this proposal -could- be split into multiple 112a single set of changes, parts of this proposal -could- be split into multiple
111phases. Why do it though? It's simpler for developers to know that the first 113phases. Why do it though? It's simpler for developers to know that the first
112eclass specification was this, and that the second specification is that, 114eclass specification was this, and that the second specification is that,
113rather then requiring them to be aware of what phase of eclass changes is in 115rather then requiring them to be aware of what phase of eclass changes is in
114progress.</p> 116progress.</p>
115<p>By rolling all changes into one large change, a line is intentionally drawn in 117<p>By rolling all changes into one large change, a line is intentionally drawn in
116the sand. Old eclasses allowed for this, behaved this way. New eclasses allow 118the sand. Old eclasses allowed for this, behaved this way. New eclasses allow
117for that, and behave this way. This should reduce misconceptions about what is 119for that, and behave this way. This should reduce misconceptions about what is
118allowed/possible with eclasses, thus reducing bugs that result from said 120allowed/possible with eclasses, thus reducing bugs that result from said
119misconceptions.</p> 121misconceptions.</p>
120<p>A few words on elibs- think of them as a clear definition between behavioral 122<p>A few words on elibs- think of them as a clear definition between behavioral
121functionality of an eclass, and the library functionality. Eclass's modify 123functionality of an eclass, and the library functionality. Eclass's modify
122template data, and are the basis for other ebuilds- elibs, however are <em>just</em> 124template data, and are the basis for other ebuilds- elibs, however are <em>just</em>
123common bash functionality.</p> 125common bash functionality.</p>
124<p>Consider the majority of the portage bin/* scripts- these all are candidates for 126<p>Consider the majority of the portage bin/* scripts- these all are candidates for
125being added to the tree as elibs, as is the bulk of eutils.</p> 127being added to the tree as elibs, as is the bulk of eutils.</p>
126</div> 128</div>
127<div class="section" id="specification"> 129<div class="section">
128<h1><a class="toc-backref" href="#id5" name="specification">Specification</a></h1> 130<h1><a class="toc-backref" href="#id6" id="specification" name="specification">Specification</a></h1>
129<p>The various parts of this proposal are broken down into a set of changes and 131<p>The various parts of this proposal are broken down into a set of changes and
130elaborations on why a proposed change is preferable. It's advisable to the 132elaborations on why a proposed change is preferable. It's advisable to the
131reader that this be read serially, rather then jumping around.</p> 133reader that this be read serially, rather then jumping around.</p>
132<div class="section" id="ebuild-libraries-elibs-for-short"> 134<div class="section">
133<h2><a class="toc-backref" href="#id6" name="ebuild-libraries-elibs-for-short">Ebuild Libraries (elibs for short)</a></h2> 135<h2><a class="toc-backref" href="#id7" id="ebuild-libraries-elibs-for-short" name="ebuild-libraries-elibs-for-short">Ebuild Libraries (elibs for short)</a></h2>
134<p>As briefly touched upon in Motivation and Rationale, the original eclass design 136<p>As briefly touched upon in Motivation and Rationale, the original eclass design
135allowed for the eclass to modify the metadata of an ebuild, metadata being the 137allowed for the eclass to modify the metadata of an ebuild, metadata being the
136DEPENDS, RDEPENDS, SRC_URI, IUSE, etc, vars that are required to be constant, 138DEPENDS, RDEPENDS, SRC_URI, IUSE, etc, vars that are required to be constant,
137and used by portage for dep resolution, fetching, etc. Using the earlier 139and used by portage for dep resolution, fetching, etc. Using the earlier
138example, if you're after a single function from an eclass (say epatch from 140example, if you're after a single function from an eclass (say epatch from
… …
140inheriting might do. You want to treat the eclass you're pulling from as a 142inheriting might do. You want to treat the eclass you're pulling from as a
141library, pure and simple.</p> 143library, pure and simple.</p>
142<p>A new directory named elib should be added to the top level of the tree to serve 144<p>A new directory named elib should be added to the top level of the tree to serve
143as a repository of ebuild function libraries. Rather then relying on using the 145as a repository of ebuild function libraries. Rather then relying on using the
144source command, an 'elib' function should be added to portage to import that 146source command, an 'elib' function should be added to portage to import that
145libraries functionality. The reason for the indirection via the function is 147libraries functionality. The reason for the indirection via the function is
146mostly related to portage internals, but it does serve as an abstraction such 148mostly related to portage internals, but it does serve as an abstraction such
147that (for example) zsh compatibility hacks could be hidden in the elib function.</p> 149that (for example) zsh compatibility hacks could be hidden in the elib function.</p>
148<p>Elib's will be collections of bash functions- they're not allowed to do anything 150<p>Elib's will be collections of bash functions- they're not allowed to do anything
149in the global scope aside from function definition, and any -minimal- 151in the global scope aside from function definition, and any -minimal-
150initialization of the library that is absolutely needed. Additionally, they 152initialization of the library that is absolutely needed. Additionally, they
151cannot modify any ebuild template functions- src_compile, src_unpack. Since they are 153cannot modify any ebuild template functions- src_compile, src_unpack. Since they are
152required to not modify the metadata keys, nor in any way affect the ebuild aside 154required to not modify the metadata keys, nor in any way affect the ebuild aside
153from providing functionality, they can be conditionally pulled in. They also 155from providing functionality, they can be conditionally pulled in. They also
154are allowed to pull in other elibs, but strictly just elibs- no eclasses, just 156are allowed to pull in other elibs, but strictly just elibs- no eclasses, just
155other elibs. A real world example would be the eutils eclass.</p> 157other elibs. A real world example would be the eutils eclass.</p>
156<p>Portage, since the elib's don't modify metadata, isn't required to track elibs 158<p>Portage, since the elib's don't modify metadata, isn't required to track elibs
157as it tracks eclasses. Thus a change in an elib doesn't result in half the tree 159as it tracks eclasses. Thus a change in an elib doesn't result in half the tree
158forced to be regenerated/marked stale when changed (this is more of an infra 160forced to be regenerated/marked stale when changed (this is more of an infra
159benefit, although regen's that take too long due to eclass changes have been 161benefit, although regen's that take too long due to eclass changes have been
160known to cause rsync issues due to missing timestamps).</p> 162known to cause rsync issues due to missing timestamps).</p>
161<p>Elibs will not be available in the global scope of an eclass, or ebuild- nor during the 163<p>Elibs will not be available in the global scope of an eclass, or ebuild- nor during the
162depends phase (basically a phase that sources the ebuild, to get its metadata). Elib 164depends phase (basically a phase that sources the ebuild, to get its metadata). Elib
163calls in the global scope will be tracked, but the elib will not be loaded till just before 165calls in the global scope will be tracked, but the elib will not be loaded till just before
164the setup phase (pkg_setup). There are two reasons for this- first, it ensures elibs are 166the setup phase (pkg_setup). There are two reasons for this- first, it ensures elibs are
165completely incapable of modifying metadata. There is no room for confusion, late loading 167completely incapable of modifying metadata. There is no room for confusion, late loading
166of elibs gives you the functionality for all phases, except for depends- depends being the 168of elibs gives you the functionality for all phases, except for depends- depends being the
167only phase that is capable of specifying metadata. Second, as an added bonus, late 169only phase that is capable of specifying metadata. Second, as an added bonus, late
168loading reduces the amount of bash sourced for a regen- faster regens. This however is minor, 170loading reduces the amount of bash sourced for a regen- faster regens. This however is minor,
169and is an ancillary benefit of the first reason.</p> 171and is an ancillary benefit of the first reason.</p>
170<p>There are a few further restrictions with elibs--mainly, elibs to load can only be specified 172<p>There are a few further restrictions with elibs--mainly, elibs to load can only be specified
171in either global scope, or in the setup, unpack, compile, test, and install phases. You can 173in either global scope, or in the setup, unpack, compile, test, and install phases. You can
172not load elibs in prerm, postrm, preinst, and postinst. The reason being, for *rm phases, 174not load elibs in prerm, postrm, preinst, and postinst. The reason being, for *rm phases,
173installed pkgs will have to look to the tree for the elib, which allows for api drift to cause 175installed pkgs will have to look to the tree for the elib, which allows for api drift to cause
174breakage. For *inst phases, same thing, except the culprit is binpkgs.</p> 176breakage. For *inst phases, same thing, except the culprit is binpkgs.</p>
175<p>There is a final restriction--elibs cannot change their exported api dependent on the api 177<p>There is a final restriction--elibs cannot change their exported api dependent on the api
176(as some eclass do for example). The reason mainly being that elibs are loaded once--not 178(as some eclass do for example). The reason mainly being that elibs are loaded once--not
177multiple times, as eclasses are.</p> 179multiple times, as eclasses are.</p>
178<p>To clarify, for example this is invalid.</p> 180<p>To clarify, for example this is invalid.</p>
179<pre class="literal-block"> 181<pre class="literal-block">
180if [[ -n ${SOME_VAR} ]]; then 182if [[ -n ${SOME_VAR} ]]; then
181 func x() { echo &quot;I'm accessible only via tweaking some var&quot;;} 183 func x() { echo &quot;I'm accessible only via tweaking some var&quot;;}
… …
192<p>There is no need for backwards compatibility with elibs- they just must work 194<p>There is no need for backwards compatibility with elibs- they just must work
193against the current tree. Thus elibs can be removed when the tree no longer 195against the current tree. Thus elibs can be removed when the tree no longer
194needs them. The reasons for this are explained below.</p> 196needs them. The reasons for this are explained below.</p>
195<p>Structuring of the elibs directory will be exactly the same as that of the new 197<p>Structuring of the elibs directory will be exactly the same as that of the new
196eclass directory (detailed below), sans a different extension.</p> 198eclass directory (detailed below), sans a different extension.</p>
197<p>As to why their are so many restrictions, the answer is simple- the definition of 199<p>As to why their are so many restrictions, the answer is simple- the definition of
198what elibs are, what they are capable of, and how to use them is nailed down as much as 200what elibs are, what they are capable of, and how to use them is nailed down as much as
199possible to avoid <em>any</em> ambiguity related to them. The intention is to make it clear, 201possible to avoid <em>any</em> ambiguity related to them. The intention is to make it clear,
200such that no misconceptions occur, resulting in bugs.</p> 202such that no misconceptions occur, resulting in bugs.</p>
201</div> 203</div>
202<div class="section" id="the-reduced-role-of-eclasses-and-a-clarification-of-existing-eclass-requirements"> 204<div class="section">
203<h2><a class="toc-backref" href="#id7" name="the-reduced-role-of-eclasses-and-a-clarification-of-existing-eclass-requirements">The reduced role of Eclasses, and a clarification of existing Eclass requirements</a></h2> 205<h2><a class="toc-backref" href="#id8" id="the-reduced-role-of-eclasses-and-a-clarification-of-existing-eclass-requirements" name="the-reduced-role-of-eclasses-and-a-clarification-of-existing-eclass-requirements">The reduced role of Eclasses, and a clarification of existing Eclass requirements</a></h2>
204<p>Since elibs are now intended on holding common bash functionality, the focus of 206<p>Since elibs are now intended on holding common bash functionality, the focus of
205eclasses should be in defining an appropriate template for ebuilds. For example, 207eclasses should be in defining an appropriate template for ebuilds. For example,
206defining common DEPENDS, RDEPENDS, src_compile functions, src_unpack, etc. 208defining common DEPENDS, RDEPENDS, src_compile functions, src_unpack, etc.
207Additionally, eclasses should pull in any elibs they need for functionality.</p> 209Additionally, eclasses should pull in any elibs they need for functionality.</p>
208<p>Eclass functionality that isn't directly related to the metadata, or src_* and 210<p>Eclass functionality that isn't directly related to the metadata, or src_* and
… …
221pulled in, leading to compilation failure, or dud deps.</p> 223pulled in, leading to compilation failure, or dud deps.</p>
222<p>If the existing metadata isn't flexible enough for what is required for a 224<p>If the existing metadata isn't flexible enough for what is required for a
223package, the parsing of the metadata is changed to address that. Cases where 225package, the parsing of the metadata is changed to address that. Cases where
224the constant requirement is violated are known, and a select few are allowed- 226the constant requirement is violated are known, and a select few are allowed-
225these are exceptions to the rule that are required due to inadequacies in 227these are exceptions to the rule that are required due to inadequacies in
226portage. Any case where it's determined the constant requirement may need to be 228portage. Any case where it's determined the constant requirement may need to be
227violated the dev must make it aware to the majority of devs, along with the portage 229violated the dev must make it aware to the majority of devs, along with the portage
228devs. This should be done prior to committing.</p> 230devs. This should be done prior to committing.</p>
229<p>It's quite likely there is a way to allow what you're attempting- if you just go 231<p>It's quite likely there is a way to allow what you're attempting- if you just go
230and do it, the rsync users (our user base) suffer the results of compilation 232and do it, the rsync users (our user base) suffer the results of compilation
231failures and unneeded deps being pulled in.</p> 233failures and unneeded deps being pulled in.</p>
232<p>After that stern reminder, back to new eclasses. Defining INHERITED and ECLASS 234<p>After that stern reminder, back to new eclasses. Defining INHERITED and ECLASS
… …
236indefinitely- compatibility must be maintained against the current tree, but 238indefinitely- compatibility must be maintained against the current tree, but
237just that. As such new eclasses (the true distinction of new vs old is 239just that. As such new eclasses (the true distinction of new vs old is
238elaborated in the next section) can be removed from the tree once they're no 240elaborated in the next section) can be removed from the tree once they're no
239longer in use.</p> 241longer in use.</p>
240</div> 242</div>
241<div class="section" id="the-end-of-backwards-compatibility"> 243<div class="section">
242<h2><a class="toc-backref" href="#id8" name="the-end-of-backwards-compatibility">The end of backwards compatibility...</a></h2> 244<h2><a class="toc-backref" href="#id9" id="the-end-of-backwards-compatibility" name="the-end-of-backwards-compatibility">The end of backwards compatibility...</a></h2>
243<p>With current eclasses, once the eclass is in use, its api can no longer be 245<p>With current eclasses, once the eclass is in use, its api can no longer be
244changed, nor can the eclass ever be removed from the tree. This is why we still 246changed, nor can the eclass ever be removed from the tree. This is why we still
245have <em>ancient</em> eclasses that are completely unused sitting in the tree, for 247have <em>ancient</em> eclasses that are completely unused sitting in the tree, for
246example inherit.eclass. The reason for this, not surprisingly, is a portage 248example inherit.eclass. The reason for this, not surprisingly, is a portage
247deficiency: on unmerging an installed ebuild, portage used the eclass from the 249deficiency: on unmerging an installed ebuild, portage used the eclass from the
248current tree.</p> 250current tree.</p>
249<p>For a real world example of this, if you merged a glibc 2 years back, whatever 251<p>For a real world example of this, if you merged a glibc 2 years back, whatever
250eclasses it used must still be compatible, or you may not be able to unmerge the 252eclasses it used must still be compatible, or you may not be able to unmerge the
251older glibc version during an upgrade to a newer version. So either the glibc 253older glibc version during an upgrade to a newer version. So either the glibc
… …
260be re-used rather then relying on the eclass. In other words, binpkgs and 262be re-used rather then relying on the eclass. In other words, binpkgs and
261installed ebuilds will no longer go and pull needed eclasses from the tree, 263installed ebuilds will no longer go and pull needed eclasses from the tree,
262they'll use the 'saved' version of the eclass they were built/merged with.</p> 264they'll use the 'saved' version of the eclass they were built/merged with.</p>
263<p>So the backwards compatibility requirement for users of the next major portage 265<p>So the backwards compatibility requirement for users of the next major portage
264version (and beyond) isn't required. All the cruft can be dropped.</p> 266version (and beyond) isn't required. All the cruft can be dropped.</p>
265<p>The problem is that there will be users using older versions of portage that don't 267<p>The problem is that there will be users using older versions of portage that don't
266support this functionality- these older installations <em>cannot</em> use the 268support this functionality- these older installations <em>cannot</em> use the
267new eclasses, due to the fact that their portage version is incapable of 269new eclasses, due to the fact that their portage version is incapable of
268properly relying on the env- in other words, the varying api of the eclass will 270properly relying on the env- in other words, the varying api of the eclass will
269result in user-visible failures during unmerging.</p> 271result in user-visible failures during unmerging.</p>
270<p>So we're able to do a clean break of all old eclasses, and api cruft, but we need 272<p>So we're able to do a clean break of all old eclasses, and api cruft, but we need
271a means to basically disallow access to the new eclasses for all portage versions 273a means to basically disallow access to the new eclasses for all portage versions
272incapable of properly handling the env requirements.</p> 274incapable of properly handling the env requirements.</p>
273<p>Unfortunately, we cannot just rely on a different grouping/naming convention within 275<p>Unfortunately, we cannot just rely on a different grouping/naming convention within
274the old eclass directory. The new eclasses must be inaccessible, and portage throws 276the old eclass directory. The new eclasses must be inaccessible, and portage throws
275a snag into this- the existing inherit function that is used to handle existing 277a snag into this- the existing inherit function that is used to handle existing
276eclasses. Basically, whatever it's passed (inherit kernel or inherit 278eclasses. Basically, whatever it's passed (inherit kernel or inherit
277kernel/kernel) it will pull in (kernel.eclass, and kernel/kernel.eclass 279kernel/kernel) it will pull in (kernel.eclass, and kernel/kernel.eclass
278respectively). So even if the new eclasses were implemented within a 280respectively). So even if the new eclasses were implemented within a
279subdirectory of the eclass dir in the tree, all current portage versions would 281subdirectory of the eclass dir in the tree, all current portage versions would
280still be able to access them.</p> 282still be able to access them.</p>
281<p>In other words, these new eclasses would in effect, be old eclasses since older 283<p>In other words, these new eclasses would in effect, be old eclasses since older
282portage versions could still access them.</p> 284portage versions could still access them.</p>
283</div> 285</div>
284<div class="section" id="tree-restructuring"> 286<div class="section">
285<h2><a class="toc-backref" href="#id9" name="tree-restructuring">Tree restructuring</a></h2> 287<h2><a class="toc-backref" href="#id10" id="tree-restructuring" name="tree-restructuring">Tree restructuring</a></h2>
286<p>There are only two way to block the existing (as of this writing) inherit 288<p>There are only two way to block the existing (as of this writing) inherit
287functionality from accessing the new eclasses- either change the extension of 289functionality from accessing the new eclasses- either change the extension of
288eclasses to something other then 'eclass', or to have them stored in a separate 290eclasses to something other then 'eclass', or to have them stored in a separate
289subdirectory of the tree then eclass.</p> 291subdirectory of the tree then eclass.</p>
290<p>The latter is preferable, and the proposed solution. Reasons are- the current 292<p>The latter is preferable, and the proposed solution. Reasons are- the current
291eclass directory is already overgrown. Structuring of the new eclass dir 293eclass directory is already overgrown. Structuring of the new eclass dir
292(clarified below) will allow for easier signing, ChangeLogs, and grouping of 294(clarified below) will allow for easier signing, ChangeLogs, and grouping of
293eclasses. New eclasses allow for something akin to a clean break and have new 295eclasses. New eclasses allow for something akin to a clean break and have new
294capabilities/requirements, thus it's advisable to start with a clean directory, 296capabilities/requirements, thus it's advisable to start with a clean directory,
295devoid of all cruft from the old eclass implementation.</p> 297devoid of all cruft from the old eclass implementation.</p>
296<p>If it's unclear as to why the old inherit function <em>cannot</em> access the new 298<p>If it's unclear as to why the old inherit function <em>cannot</em> access the new
297eclasses, please reread the previous section. It's unfortunately a requirement 299eclasses, please reread the previous section. It's unfortunately a requirement
298to take advantage of all that the next major portage release will allow.</p> 300to take advantage of all that the next major portage release will allow.</p>
299<p>The proposed directory structure is ${PORTDIR}/include/{eclass,elib}. 301<p>The proposed directory structure is ${PORTDIR}/include/{eclass,elib}.
… …
323to ensure no files are missing, and that nothing has been tainted.</p> 325to ensure no files are missing, and that nothing has been tainted.</p>
324<p>The elib directory will be structured in the same way, for the same reasons.</p> 326<p>The elib directory will be structured in the same way, for the same reasons.</p>
325<p>Repoman will have to be extended to work within new eclass and elib groups, and 327<p>Repoman will have to be extended to work within new eclass and elib groups, and
326to handle signing and committing. This is intentional, and a good thing. This 328to handle signing and committing. This is intentional, and a good thing. This
327gives repoman the possibility of doing sanity checks on elibs/new eclasses.</p> 329gives repoman the possibility of doing sanity checks on elibs/new eclasses.</p>
328<p>Note these checks will not prevent developers from doing dumb things with eclass- 330<p>Note these checks will not prevent developers from doing dumb things with eclass-
329these checks would only be capable of doing basic sanity checks, such as syntax checks. 331these checks would only be capable of doing basic sanity checks, such as syntax checks.
330There is no way to prevent people from doing dumb things (exempting perhaps repeated 332There is no way to prevent people from doing dumb things (exempting perhaps repeated
331applications of a cattle prod)- these are strictly automatic checks, akin to repoman's 333applications of a cattle prod)- these are strictly automatic checks, akin to repoman's
332dependency checks.</p> 334dependency checks.</p>
333</div> 335</div>
334<div class="section" id="the-start-of-a-different-phase-of-backwards-compatibility"> 336<div class="section">
335<h2><a class="toc-backref" href="#id10" name="the-start-of-a-different-phase-of-backwards-compatibility">The start of a different phase of backwards compatibility</a></h2> 337<h2><a class="toc-backref" href="#id11" id="the-start-of-a-different-phase-of-backwards-compatibility" name="the-start-of-a-different-phase-of-backwards-compatibility">The start of a different phase of backwards compatibility</a></h2>
336<p>As clarified above, new eclasses will exist in a separate directory that will be 338<p>As clarified above, new eclasses will exist in a separate directory that will be
337intentionally inaccessible to the inherit function. As such, users of older 339intentionally inaccessible to the inherit function. As such, users of older
338portage versions <em>will</em> have to upgrade to merge any ebuild that uses elibs/new 340portage versions <em>will</em> have to upgrade to merge any ebuild that uses elibs/new
339eclasses. A depend on the next major portage version would transparently handle 341eclasses. A depend on the next major portage version would transparently handle
340this for rsync users.</p> 342this for rsync users.</p>
341<p>There still is the issue of users who haven't upgraded to the required portage 343<p>There still is the issue of users who haven't upgraded to the required portage
342version. This is a minor concern frankly- portage releases include new 344version. This is a minor concern frankly- portage releases include new
343functionality, and bug fixes. If they won't upgrade, it's assumed they have 345functionality, and bug fixes. If they won't upgrade, it's assumed they have
344their reasons and are big boys, thus able to handle the complications themselves.</p> 346their reasons and are big boys, thus able to handle the complications themselves.</p>
… …
358<p>For users who do not upgrade within the window of N months while the old 360<p>For users who do not upgrade within the window of N months while the old
359eclasses are in the tree, as stated, it's assumed they know what they are doing. 361eclasses are in the tree, as stated, it's assumed they know what they are doing.
360If they specifically block the new portage version, as the ebuilds in the tree 362If they specifically block the new portage version, as the ebuilds in the tree
361migrate to the new eclasses, they will have less and less ebuilds available to 363migrate to the new eclasses, they will have less and less ebuilds available to
362them. If they tried injecting the new portage version (lying to portage, 364them. If they tried injecting the new portage version (lying to portage,
363essentially), portage would bail since it cannot find the new eclass. 365essentially), portage would bail since it cannot find the new eclass.
364For ebuilds that use the new eclasses, there really isn't any way to sidestep 366For ebuilds that use the new eclasses, there really isn't any way to sidestep
365the portage version requirement- same as it has been for other portage features.</p> 367the portage version requirement- same as it has been for other portage features.</p>
366<p>What is a bit more annoying is that once the old eclasses are out of the tree, 368<p>What is a bit more annoying is that once the old eclasses are out of the tree,
367if a user has not upgraded to a portage version supporting env processing, they 369if a user has not upgraded to a portage version supporting env processing, they
368will lose the ability to unmerge any installed ebuild that used an old 370will lose the ability to unmerge any installed ebuild that used an old
369eclass. Same cause, different symptom being they will lose the ability to merge 371eclass. Same cause, different symptom being they will lose the ability to merge
370any tbz2 that uses old eclasses also.</p> 372any tbz2 that uses old eclasses also.</p>
371<p>There is one additional case that is a rarity, but should be noted- if a user 373<p>There is one additional case that is a rarity, but should be noted- if a user
372has suffered significant corruption of their installed package database (vdb). This is 374has suffered significant corruption of their installed package database (vdb). This is
373ignoring the question of whether the vdb is even usable at this point, but the possibility 375ignoring the question of whether the vdb is even usable at this point, but the possibility
374exists for the saved envs to be non usable due to either A) missing, or B) corrupted. 376exists for the saved envs to be non usable due to either A) missing, or B) corrupted.
375In such a case, even with the new portage capabilities, they would need 377In such a case, even with the new portage capabilities, they would need
376the old eclass compat ebuild.</p> 378the old eclass compat ebuild.</p>
377<p>Note for this to happen requires either rather... unwise uses of root, or significant 379<p>Note for this to happen requires either rather... unwise uses of root, or significant
378fs corruption. Regardless of the cause, it's quite likely for this to even become an 380fs corruption. Regardless of the cause, it's quite likely for this to even become an
379issue, the system's vdb is completely unusable. It's a moot issue at that point. 381issue, the system's vdb is completely unusable. It's a moot issue at that point.
380If you lose your vdb, or it gets seriously damaged, it's akin to lobotomizing portage- 382If you lose your vdb, or it gets seriously damaged, it's akin to lobotomizing portage-
381it doesn't know what's installed, it doesn't know of its own files, and in general, 383it doesn't know what's installed, it doesn't know of its own files, and in general,
382a rebuilding of the system is about the only sane course of action. The missing env is 384a rebuilding of the system is about the only sane course of action. The missing env is
383truly the least of the users concern in such a case.</p> 385truly the least of the users concern in such a case.</p>
384<p>Continuing with the more likely scenario, users unwilling to upgrade portage will 386<p>Continuing with the more likely scenario, users unwilling to upgrade portage will
385<em>not</em> be left out in the rain. Merging the old eclass compat ebuild will provide 387<em>not</em> be left out in the rain. Merging the old eclass compat ebuild will provide
386the missing eclasses, thus providing that lost functionality.</p> 388the missing eclasses, thus providing that lost functionality.</p>
387<p>Note the intention isn't to force them to upgrade, hence the ability to restore the 389<p>Note the intention isn't to force them to upgrade, hence the ability to restore the
388lost functionality. The intention is to clean up the existing mess, and allow us 390lost functionality. The intention is to clean up the existing mess, and allow us
389to move forward. The saying &quot;you've got to break a few eggs to make an omelet&quot; 391to move forward. The saying &quot;you've got to break a few eggs to make an omelet&quot;
390is akin, exempting the fact we're providing a way to make the eggs whole again 392is akin, exempting the fact we're providing a way to make the eggs whole again
391(the king's men would've loved such an option).</p> 393(the king's men would've loved such an option).</p>
392</div> 394</div>
393<div class="section" id="migrating-to-the-new-setup"> 395<div class="section">
394<h2><a class="toc-backref" href="#id11" name="migrating-to-the-new-setup">Migrating to the new setup</a></h2> 396<h2><a class="toc-backref" href="#id12" id="migrating-to-the-new-setup" name="migrating-to-the-new-setup">Migrating to the new setup</a></h2>
395<p>As has been done in the past whenever a change in the tree results in ebuilds 397<p>As has been done in the past whenever a change in the tree results in ebuilds
396requiring a specific version of portage, as ebuilds migrate to the new eclasses, 398requiring a specific version of portage, as ebuilds migrate to the new eclasses,
397they should depend on a version of portage that supports it. From the users 399they should depend on a version of portage that supports it. From the users
398viewpoint, this transparently handles the migration.</p> 400viewpoint, this transparently handles the migration.</p>
399<p>This isn't so transparent for devs or a particular infrastructure server however. 401<p>This isn't so transparent for devs or a particular infrastructure server however.
… …
417<p>Essentially, you have a chance to nail the design perfectly/cleanly, and have a 419<p>Essentially, you have a chance to nail the design perfectly/cleanly, and have a
418window in which to redesign it. It's humbly suggested eclass devs take 420window in which to redesign it. It's humbly suggested eclass devs take
419advantage of it. :)</p> 421advantage of it. :)</p>
420</div> 422</div>
421</div> 423</div>
422<div class="section" id="backwards-compatibility"> 424<div class="section">
423<h1><a class="toc-backref" href="#id12" name="backwards-compatibility">Backwards Compatibility</a></h1> 425<h1><a class="toc-backref" href="#id13" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
424<p>All backwards compatibility issues are addressed in line, but a recap is offered- 426<p>All backwards compatibility issues are addressed in line, but a recap is offered-
425it's suggested that if the a particular compatibility issue is 427it's suggested that if the a particular compatibility issue is
426questioned/worried over, the reader read the relevant section. There should be 428questioned/worried over, the reader read the relevant section. There should be
427a more in depth discussion of the issue, along with a more extensive explanation 429a more in depth discussion of the issue, along with a more extensive explanation
428of the potential solutions, and reasons for the chosen solution.</p> 430of the potential solutions, and reasons for the chosen solution.</p>
… …
436'thinning' of available ebuilds should they block the portage upgrade is 438'thinning' of available ebuilds should they block the portage upgrade is
437their responsibility. 439their responsibility.
438 440
439Old eclasses at some point in the future should be removed from the tree, 441Old eclasses at some point in the future should be removed from the tree,
440and released in a tarball/ebuild. This will cause installed ebuilds that 442and released in a tarball/ebuild. This will cause installed ebuilds that
441rely on the old eclass to be unable to unmerge, with the same applying for 443rely on the old eclass to be unable to unmerge, with the same applying for
442merging of binpkgs dependent on the following paragraph. 444merging of binpkgs dependent on the following paragraph.
443 445
444The old eclass-compat is only required for users who do not upgrade their 446The old eclass-compat is only required for users who do not upgrade their
445portage installation, and one further exemption- if the user has somehow 447portage installation, and one further exemption- if the user has somehow
446corrupted/destroyed their installed pkgs database (/var/db/pkg currently), 448corrupted/destroyed their installed pkgs database (/var/db/pkg currently),
447in the process, they've lost their saved environments. The eclass-compat 449in the process, they've lost their saved environments. The eclass-compat
448ebuild would be required for ebuilds that required older eclasses in such a 450ebuild would be required for ebuilds that required older eclasses in such a
449case. Note, this case is rare also- as clarified above, it's mentioned 451case. Note, this case is rare also- as clarified above, it's mentioned
450strictly to be complete, it's not much of a real world scenario as elaborated 452strictly to be complete, it's not much of a real world scenario as elaborated
451above. 453above.
452</pre> 454</pre>
453</div> 455</div>
454<div class="section" id="copyright"> 456<div class="section">
455<h1><a class="toc-backref" href="#id13" name="copyright">Copyright</a></h1> 457<h1><a class="toc-backref" href="#id14" id="copyright" name="copyright">Copyright</a></h1>
456<p>This document has been placed in the public domain.</p> 458<p>This document has been placed in the public domain.</p>
457</div> 459</div>
458 460
459</div> 461</div>
460<div class="footer"> 462<div class="footer">
461<hr class="footer" /> 463<hr class="footer" />
462<a class="reference" href="glep-0033.txt">View document source</a>. 464<a class="reference" href="glep-0033.txt">View document source</a>.
463Generated on: 2005-09-15 02:37 UTC. 465Generated on: 2009-02-20 09:17 UTC.
464Generated 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. 466Generated 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.
465 467
466</div> 468</div>
467</body> 469</body>
468</html> 470</html>
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.9
  ViewVC Help
Powered by ViewVC 1.1.20