| 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 | |
| 5 | This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new |
|
|
| 6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
|
|
| 7 | to 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.5: 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 | <div class="document"> |
|
|
| 28 | <table class="rfc2822 field-list" frame="void" rules="none"> |
23 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
| 29 | <col class="field-name" /> |
24 | <col class="field-name" /> |
| 30 | <col class="field-body" /> |
25 | <col class="field-body" /> |
| 31 | <tbody valign="top"> |
26 | <tbody valign="top"> |
| 32 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">33</td> |
27 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">33</td> |
| 33 | </tr> |
28 | </tr> |
| 34 | <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> |
| 35 | </tr> |
30 | </tr> |
| 36 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> |
31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.6</td> |
| 37 | </tr> |
32 | </tr> |
| 38 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0033.txt?cvsroot=gentoo">2005/03/06 20:33:20</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> |
| 39 | </tr> |
34 | </tr> |
| 40 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Brian Harring <ferringb at gentoo.org>, John Mylchreest <johnm at gentoo.org></td> |
35 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Brian Harring <ferringb at gentoo.org>, John Mylchreest <johnm at gentoo.org></td> |
| 41 | </tr> |
36 | </tr> |
| 42 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
37 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Moribund</td> |
| 43 | </tr> |
38 | </tr> |
| 44 | <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> |
| 45 | </tr> |
40 | </tr> |
| 46 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="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> |
| 47 | </tr> |
42 | </tr> |
| 48 | <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> |
| 49 | </tr> |
44 | </tr> |
| 50 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">29-Jan-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> |
| 51 | </tr> |
46 | </tr> |
| 52 | </tbody> |
47 | </tbody> |
| 53 | </table> |
48 | </table> |
| 54 | <hr /> |
49 | <hr /> |
| 55 | <div class="contents topic" id="contents"> |
50 | <div class="contents topic"> |
| 56 | <p class="topic-title first"><a name="contents">Contents</a></p> |
51 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
| 57 | <ul class="simple"> |
52 | <ul class="simple"> |
|
|
53 | <li><a class="reference" href="#status" id="id2" name="id2">Status</a></li> |
| 58 | <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> |
| 59 | <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> |
| 60 | <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> |
| 61 | <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> |
| 62 | <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> |
| 63 | <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> |
| 64 | <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> |
| 65 | <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> |
| 66 | <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> |
| 67 | <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> |
| 68 | </ul> |
64 | </ul> |
| 69 | </li> |
65 | </li> |
| 70 | <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> |
| 71 | <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> |
| 72 | </ul> |
68 | </ul> |
| 73 | </div> |
69 | </div> |
| 74 | <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 |
|
|
73 | this GLEP is on hold, pending future revisions.</p> |
|
|
74 | </div> |
|
|
75 | <div class="section"> |
| 75 | <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> |
| 76 | <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 |
| 77 | in the original design. This document is intended to document, and propose a |
78 | in the original design. This document is intended to document, and propose a |
| 78 | revision of the current eclass setup to address current eclass inadequacies.</p> |
79 | revision of the current eclass setup to address current eclass inadequacies.</p> |
| 79 | <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', |
| 80 | a narrowing of the focus of eclasses, a move of eclasses w/in the tree, the |
81 | a narrowing of the focus of eclasses, a move of eclasses w/in the tree, the |
| 81 | addition of changelogs, and a way to allow for simple eclass gpg signing. |
82 | addition of changelogs, and a way to allow for simple eclass gpg signing. |
| 82 | In general, a large scale restructuring of what eclasses are and how they're |
83 | In general, a large scale restructuring of what eclasses are and how they're |
| 83 | implemented. Essentially version two of the eclass setup.</p> |
84 | implemented. Essentially version two of the eclass setup.</p> |
| 84 | </div> |
85 | </div> |
| 85 | <div class="section" id="terminology"> |
86 | <div class="section"> |
| 86 | <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> |
| 87 | <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 |
| 88 | existing crop (as of this writing) will be referenced as 'old eclasses'. The |
89 | existing crop (as of this writing) will be referenced as 'old eclasses'. The |
| 89 | distinction is elaborated on within this document.</p> |
90 | distinction is elaborated on within this document.</p> |
| 90 | </div> |
91 | </div> |
| 91 | <div class="section" id="motivation-and-rationale"> |
92 | <div class="section"> |
| 92 | <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> |
| 93 | <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 |
| 94 | maintain backwards compatibility w/ all previous functionality. In effect, |
95 | maintain backwards compatibility w/ all previous functionality. In effect, |
| 95 | their api is constant, and can only be added to- never changing the existing |
96 | their api is constant, and can only be added to- never changing the existing |
| 96 | functionality. This obviously is quite limiting, and leads to cruft accruing in |
97 | functionality. This obviously is quite limiting, and leads to cruft accruing in |
| 97 | eclasses as a eclasses design is refined. This needs to be dealt with prior to |
98 | eclasses as a eclasses design is refined. This needs to be dealt with prior to |
| 98 | eclass code reaching a critical mass where they become unmanageable/fragile |
99 | eclass code reaching a critical mass where they become unmanageable/fragile |
| 99 | (recent pushes for eclass versioning could be interpreted as proof of this).</p> |
100 | (recent pushes for eclass versioning could be interpreted as proof of this).</p> |
| 100 | <p>Beyond that, eclasses were originally intended as a method to allow for ebuilds |
101 | <p>Beyond that, eclasses were originally intended as a method to allow for ebuilds |
| 101 | to use a pre-existing block of code, rather then having to duplicate the code in |
102 | to use a pre-existing block of code, rather then having to duplicate the code in |
| 102 | each ebuild. This is a good thing, but there are ill effects that result from |
103 | each ebuild. This is a good thing, but there are ill effects that result from |
| 103 | the current design. Eclasses inherit other eclasses to get a single function- in |
104 | the current design. Eclasses inherit other eclasses to get a single function- in |
| 104 | doing so, modifying the the exported 'template' (default src_compile, default |
105 | doing so, modifying the the exported 'template' (default src_compile, default |
| 105 | src_unpack, various vars, etc). All the eclass designer was after was reusing a |
106 | src_unpack, various vars, etc). All the eclass designer was after was reusing a |
| 106 | function, not making their eclass sensitive to changes in the template of the |
107 | function, not making their eclass sensitive to changes in the template of the |
| 107 | eclass it's inheriting. The eclass designer -should- be aware of changes in the |
108 | eclass it's inheriting. The eclass designer -should- be aware of changes in the |
| 108 | function they're using, but shouldn't have to worry about their default src_* |
109 | function they're using, but shouldn't have to worry about their default src_* |
| 109 | and pkg_* functions being overwritten, let alone the env changes.</p> |
110 | and pkg_* functions being overwritten, let alone the env changes.</p> |
| 110 | <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 |
| 111 | a single set of changes, parts of this proposal -could- be split into multiple |
112 | a single set of changes, parts of this proposal -could- be split into multiple |
| 112 | phases. Why do it though? It's simpler for developers to know that the first |
113 | phases. Why do it though? It's simpler for developers to know that the first |
| 113 | eclass specification was this, and that the second specification is that, |
114 | eclass specification was this, and that the second specification is that, |
| 114 | rather then requiring them to be aware of what phase of eclass changes is in |
115 | rather then requiring them to be aware of what phase of eclass changes is in |
| 115 | progress.</p> |
116 | progress.</p> |
| 116 | <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 |
| 117 | the sand. Old eclasses allowed for this, behaved this way. New eclasses allow |
118 | the sand. Old eclasses allowed for this, behaved this way. New eclasses allow |
| 118 | for that, and behave this way. This should reduce misconceptions about what is |
119 | for that, and behave this way. This should reduce misconceptions about what is |
| 119 | allowed/possible with eclasses, thus reducing bugs that result from said |
120 | allowed/possible with eclasses, thus reducing bugs that result from said |
| 120 | misconceptions.</p> |
121 | misconceptions.</p> |
| 121 | <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 |
| 122 | functionality of an eclass, and the library functionality. Eclass's modify |
123 | functionality of an eclass, and the library functionality. Eclass's modify |
| 123 | template data, and are the basis for other ebuilds- elibs, however are <em>just</em> |
124 | template data, and are the basis for other ebuilds- elibs, however are <em>just</em> |
| 124 | common bash functionality.</p> |
125 | common bash functionality.</p> |
| 125 | <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 |
| 126 | being added to the tree as elibs, as is the bulk of eutils.</p> |
127 | being added to the tree as elibs, as is the bulk of eutils.</p> |
| 127 | </div> |
128 | </div> |
| 128 | <div class="section" id="specification"> |
129 | <div class="section"> |
| 129 | <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> |
| 130 | <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 |
| 131 | elaborations on why a proposed change is preferable. It's advisable to the |
132 | elaborations on why a proposed change is preferable. It's advisable to the |
| 132 | reader that this be read serially, rather then jumping around.</p> |
133 | reader that this be read serially, rather then jumping around.</p> |
| 133 | <div class="section" id="ebuild-libraries-elibs-for-short"> |
134 | <div class="section"> |
| 134 | <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> |
| 135 | <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 |
| 136 | allowed for the eclass to modify the metadata of an ebuild, metadata being the |
137 | allowed for the eclass to modify the metadata of an ebuild, metadata being the |
| 137 | DEPENDS, RDEPENDS, SRC_URI, IUSE, etc, vars that are required to be constant, |
138 | DEPENDS, RDEPENDS, SRC_URI, IUSE, etc, vars that are required to be constant, |
| 138 | and used by portage for dep resolution, fetching, etc. Using the earlier |
139 | and used by portage for dep resolution, fetching, etc. Using the earlier |
| 139 | example, if you're after a single function from an eclass (say epatch from |
140 | example, if you're after a single function from an eclass (say epatch from |
| … | |
… | |
| 141 | inheriting might do. You want to treat the eclass you're pulling from as a |
142 | inheriting might do. You want to treat the eclass you're pulling from as a |
| 142 | library, pure and simple.</p> |
143 | library, pure and simple.</p> |
| 143 | <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 |
| 144 | as a repository of ebuild function libraries. Rather then relying on using the |
145 | as a repository of ebuild function libraries. Rather then relying on using the |
| 145 | source command, an 'elib' function should be added to portage to import that |
146 | source command, an 'elib' function should be added to portage to import that |
| 146 | libraries functionality. The reason for the indirection via the function is |
147 | libraries functionality. The reason for the indirection via the function is |
| 147 | mostly related to portage internals, but it does serve as an abstraction such |
148 | mostly related to portage internals, but it does serve as an abstraction such |
| 148 | that (for example) zsh compatibility hacks could be hidden in the elib function.</p> |
149 | that (for example) zsh compatibility hacks could be hidden in the elib function.</p> |
| 149 | <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 |
| 150 | in the global scope aside from function definition, and any -minimal- |
151 | in the global scope aside from function definition, and any -minimal- |
| 151 | initialization of the library that is absolutely needed. Additionally, they |
152 | initialization of the library that is absolutely needed. Additionally, they |
| 152 | cannot modify any ebuild template functions- src_compile, src_unpack. Since they are |
153 | cannot modify any ebuild template functions- src_compile, src_unpack. Since they are |
| 153 | required to not modify the metadata keys, nor in any way affect the ebuild aside |
154 | required to not modify the metadata keys, nor in any way affect the ebuild aside |
| 154 | from providing functionality, they can be conditionally pulled in. They also |
155 | from providing functionality, they can be conditionally pulled in. They also |
| 155 | are allowed to pull in other elibs, but strictly just elibs- no eclasses, just |
156 | are allowed to pull in other elibs, but strictly just elibs- no eclasses, just |
| 156 | other elibs. A real world example would be the eutils eclass.</p> |
157 | other elibs. A real world example would be the eutils eclass.</p> |
| 157 | <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 |
| 158 | as it tracks eclasses. Thus a change in an elib doesn't result in half the tree |
159 | as it tracks eclasses. Thus a change in an elib doesn't result in half the tree |
| 159 | forced to be regenerated/marked stale when changed (this is more of an infra |
160 | forced to be regenerated/marked stale when changed (this is more of an infra |
| 160 | benefit, although regen's that take too long due to eclass changes have been |
161 | benefit, although regen's that take too long due to eclass changes have been |
| 161 | known to cause rsync issues due to missing timestamps).</p> |
162 | known to cause rsync issues due to missing timestamps).</p> |
| 162 | <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 |
| 163 | depends phase (basically a phase that sources the ebuild, to get it's metadata). Elib |
164 | depends phase (basically a phase that sources the ebuild, to get its metadata). Elib |
| 164 | calls in the global scope will be tracked, but the elib will not be loaded till just before |
165 | calls in the global scope will be tracked, but the elib will not be loaded till just before |
| 165 | the setup phase (pkg_setup). There are two reasons for this- first, it ensures elibs are |
166 | the setup phase (pkg_setup). There are two reasons for this- first, it ensures elibs are |
| 166 | completely incapable of modifying metadata. There is no room for confusion, late loading |
167 | completely incapable of modifying metadata. There is no room for confusion, late loading |
| 167 | of elibs gives you the functionality for all phases, except for depends- depends being the |
168 | of elibs gives you the functionality for all phases, except for depends- depends being the |
| 168 | only phase that is capable of specifying metadata. Second, as an added bonus, late |
169 | only phase that is capable of specifying metadata. Second, as an added bonus, late |
| 169 | loading reduces the amount of bash sourced for a regen- faster regens. This however is minor, |
170 | loading reduces the amount of bash sourced for a regen- faster regens. This however is minor, |
| 170 | and is an ancillary benefit of the first reason.</p> |
171 | and is an ancillary benefit of the first reason.</p> |
| 171 | <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 |
| 172 | in either global scope, or in the setup, unpack, compile, test, and install phases. You can |
173 | in either global scope, or in the setup, unpack, compile, test, and install phases. You can |
| 173 | not load elibs in prerm, postrm, preinst, and postinst. The reason being, for *rm phases, |
174 | not load elibs in prerm, postrm, preinst, and postinst. The reason being, for *rm phases, |
| 174 | installed pkgs will have to look to the tree for the elib, which allows for api drift to cause |
175 | installed pkgs will have to look to the tree for the elib, which allows for api drift to cause |
| 175 | breakage. For *inst phases, same thing, except the culprit is binpkgs.</p> |
176 | breakage. For *inst phases, same thing, except the culprit is binpkgs.</p> |
| 176 | <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 |
| 177 | (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 |
| 178 | multiple times, as eclasses are.</p> |
179 | multiple times, as eclasses are.</p> |
| 179 | <p>To clarify, for example this is invalid.</p> |
180 | <p>To clarify, for example this is invalid.</p> |
| 180 | <pre class="literal-block"> |
181 | <pre class="literal-block"> |
| 181 | if [[ -n ${SOME_VAR} ]]; then |
182 | if [[ -n ${SOME_VAR} ]]; then |
| 182 | func x() { echo "I'm accessible only via tweaking some var";} |
183 | func x() { echo "I'm accessible only via tweaking some var";} |
| … | |
… | |
| 184 | func x() { echo "this is invalid, do not do it."; } |
185 | func x() { echo "this is invalid, do not do it."; } |
| 185 | fi |
186 | fi |
| 186 | </pre> |
187 | </pre> |
| 187 | <p>Regarding maintainability of elibs, it should be a less of a load then old |
188 | <p>Regarding maintainability of elibs, it should be a less of a load then old |
| 188 | eclasses. One of the major issues with old eclasses is that their functions are |
189 | eclasses. One of the major issues with old eclasses is that their functions are |
| 189 | quite incestuous- they're bound tightly to the env they're defined in. This |
190 | quite incestuous- they're bound tightly to the env they're defined in. This |
| 190 | makes eclass functions a bit fragile- the restrictions on what can, and cannot |
191 | makes eclass functions a bit fragile- the restrictions on what can, and cannot |
| 191 | be done in elibs will address this, making functionality less fragile (thus a |
192 | be done in elibs will address this, making functionality less fragile (thus a |
| 192 | bit more maintainable).</p> |
193 | bit more maintainable).</p> |
| 193 | <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 |
| 194 | against the current tree. Thus elibs can be removed when the tree no longer |
195 | against the current tree. Thus elibs can be removed when the tree no longer |
| 195 | needs them. The reasons for this are explained below.</p> |
196 | needs them. The reasons for this are explained below.</p> |
| 196 | <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 |
| 197 | eclass directory (detailed below), sans a different extension.</p> |
198 | eclass directory (detailed below), sans a different extension.</p> |
| 198 | <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 |
| 199 | what elibs are, what they are capable of, and how to use them is nailed down as much as |
200 | what elibs are, what they are capable of, and how to use them is nailed down as much as |
| 200 | possible to avoid <em>any</em> ambiguity related to them. The intention is to make it clear, |
201 | possible to avoid <em>any</em> ambiguity related to them. The intention is to make it clear, |
| 201 | such that no misconceptions occur, resulting in bugs.</p> |
202 | such that no misconceptions occur, resulting in bugs.</p> |
| 202 | </div> |
203 | </div> |
| 203 | <div class="section" id="the-reduced-role-of-eclasses-and-a-clarification-of-existing-eclass-requirements"> |
204 | <div class="section"> |
| 204 | <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> |
| 205 | <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 |
| 206 | eclasses should be in defining an appropriate template for ebuilds. For example, |
207 | eclasses should be in defining an appropriate template for ebuilds. For example, |
| 207 | defining common DEPENDS, RDEPENDS, src_compile functions, src_unpack, etc. |
208 | defining common DEPENDS, RDEPENDS, src_compile functions, src_unpack, etc. |
| 208 | Additionally, eclasses should pull in any elibs they need for functionality.</p> |
209 | Additionally, eclasses should pull in any elibs they need for functionality.</p> |
| 209 | <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 |
| 210 | pkg_* funcs should be shifted into elibs to allow for maximal code reuse. This |
211 | pkg_* funcs should be shifted into elibs to allow for maximal code reuse. This |
| 211 | however isn't a hard requirement, merely a strongly worded suggestion.</p> |
212 | however isn't a hard requirement, merely a strongly worded suggestion.</p> |
| … | |
… | |
| 222 | pulled in, leading to compilation failure, or dud deps.</p> |
223 | pulled in, leading to compilation failure, or dud deps.</p> |
| 223 | <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 |
| 224 | package, the parsing of the metadata is changed to address that. Cases where |
225 | package, the parsing of the metadata is changed to address that. Cases where |
| 225 | the constant requirement is violated are known, and a select few are allowed- |
226 | the constant requirement is violated are known, and a select few are allowed- |
| 226 | these are exceptions to the rule that are required due to inadequacies in |
227 | these are exceptions to the rule that are required due to inadequacies in |
| 227 | portage. Any case where it's determined the constant requirement may need to be |
228 | portage. Any case where it's determined the constant requirement may need to be |
| 228 | violated the dev must make it aware to the majority of devs, along with the portage |
229 | violated the dev must make it aware to the majority of devs, along with the portage |
| 229 | devs. This should be done prior to committing.</p> |
230 | devs. This should be done prior to committing.</p> |
| 230 | <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 |
| 231 | and do it, the rsync users (our user base) suffer the results of compilation |
232 | and do it, the rsync users (our user base) suffer the results of compilation |
| 232 | failures and unneeded deps being pulled in.</p> |
233 | failures and unneeded deps being pulled in.</p> |
| 233 | <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 |
| … | |
… | |
| 237 | indefinitely- compatibility must be maintained against the current tree, but |
238 | indefinitely- compatibility must be maintained against the current tree, but |
| 238 | just that. As such new eclasses (the true distinction of new vs old is |
239 | just that. As such new eclasses (the true distinction of new vs old is |
| 239 | elaborated in the next section) can be removed from the tree once they're no |
240 | elaborated in the next section) can be removed from the tree once they're no |
| 240 | longer in use.</p> |
241 | longer in use.</p> |
| 241 | </div> |
242 | </div> |
| 242 | <div class="section" id="the-end-of-backwards-compatibility"> |
243 | <div class="section"> |
| 243 | <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> |
| 244 | <p>With current eclasses, once the eclass is in use, it's api can no longer be |
245 | <p>With current eclasses, once the eclass is in use, its api can no longer be |
| 245 | changed, nor can the eclass ever be removed from the tree. This is why we still |
246 | changed, nor can the eclass ever be removed from the tree. This is why we still |
| 246 | have <em>ancient</em> eclasses that are completely unused sitting in the tree, for |
247 | have <em>ancient</em> eclasses that are completely unused sitting in the tree, for |
| 247 | example inherit.eclass . The reason for this, not surprisingly is a portage |
248 | example inherit.eclass. The reason for this, not surprisingly, is a portage |
| 248 | deficiency- on unmerging an installed ebuild, portage used the eclass from the |
249 | deficiency: on unmerging an installed ebuild, portage used the eclass from the |
| 249 | current tree.</p> |
250 | current tree.</p> |
| 250 | <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 |
| 251 | eclasses it used must still be compatible, or you may not be able to unmerge the |
252 | eclasses it used must still be compatible, or you may not be able to unmerge the |
| 252 | older glibc version during an upgrade to a newer version. So either the glibc |
253 | older glibc version during an upgrade to a newer version. So either the glibc |
| 253 | maintainer is left with the option of leaving people using ancient versions out |
254 | maintainer is left with the option of leaving people using ancient versions out |
| … | |
… | |
| 261 | be re-used rather then relying on the eclass. In other words, binpkgs and |
262 | be re-used rather then relying on the eclass. In other words, binpkgs and |
| 262 | installed ebuilds will no longer go and pull needed eclasses from the tree, |
263 | installed ebuilds will no longer go and pull needed eclasses from the tree, |
| 263 | they'll use the 'saved' version of the eclass they were built/merged with.</p> |
264 | they'll use the 'saved' version of the eclass they were built/merged with.</p> |
| 264 | <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 |
| 265 | version (and beyond) isn't required. All the cruft can be dropped.</p> |
266 | version (and beyond) isn't required. All the cruft can be dropped.</p> |
| 266 | <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 |
| 267 | support this functionality- these older installations <em>cannot</em> use the |
268 | support this functionality- these older installations <em>cannot</em> use the |
| 268 | new eclasses, due to the fact that their portage version is incapable of |
269 | new eclasses, due to the fact that their portage version is incapable of |
| 269 | properly relying on the env- in other words, the varying api of the eclass will |
270 | properly relying on the env- in other words, the varying api of the eclass will |
| 270 | result in user-visible failures during unmerging.</p> |
271 | result in user-visible failures during unmerging.</p> |
| 271 | <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 |
| 272 | a means to basically disallow access to the new eclasses for all portage versions |
273 | a means to basically disallow access to the new eclasses for all portage versions |
| 273 | incapable of properly handling the env requirements.</p> |
274 | incapable of properly handling the env requirements.</p> |
| 274 | <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 |
| 275 | the old eclass directory. The new eclasses must be inaccessible, and portage throws |
276 | the old eclass directory. The new eclasses must be inaccessible, and portage throws |
| 276 | a snag into this- the existing inherit function that is used to handle existing |
277 | a snag into this- the existing inherit function that is used to handle existing |
| 277 | eclasses. Basically, whatever it's passed (inherit kernel or inherit |
278 | eclasses. Basically, whatever it's passed (inherit kernel or inherit |
| 278 | kernel/kernel) it will pull in (kernel.eclass, and kernel/kernel.eclass |
279 | kernel/kernel) it will pull in (kernel.eclass, and kernel/kernel.eclass |
| 279 | respectively). So even if the new eclasses were implemented within a |
280 | respectively). So even if the new eclasses were implemented within a |
| 280 | subdirectory of the eclass dir in the tree, all current portage versions would |
281 | subdirectory of the eclass dir in the tree, all current portage versions would |
| 281 | still be able to access them.</p> |
282 | still be able to access them.</p> |
| 282 | <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 |
| 283 | portage versions could still access them.</p> |
284 | portage versions could still access them.</p> |
| 284 | </div> |
285 | </div> |
| 285 | <div class="section" id="tree-restructuring"> |
286 | <div class="section"> |
| 286 | <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> |
| 287 | <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 |
| 288 | functionality from accessing the new eclasses- either change the extension of |
289 | functionality from accessing the new eclasses- either change the extension of |
| 289 | eclasses to something other then 'eclass', or to have them stored in a separate |
290 | eclasses to something other then 'eclass', or to have them stored in a separate |
| 290 | subdirectory of the tree then eclass.</p> |
291 | subdirectory of the tree then eclass.</p> |
| 291 | <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 |
| 292 | eclass directory is already overgrown. Structuring of the new eclass dir |
293 | eclass directory is already overgrown. Structuring of the new eclass dir |
| 293 | (clarified below) will allow for easier signing, ChangeLogs, and grouping of |
294 | (clarified below) will allow for easier signing, ChangeLogs, and grouping of |
| 294 | eclasses. New eclasses allow for something akin to a clean break and have new |
295 | eclasses. New eclasses allow for something akin to a clean break and have new |
| 295 | capabilities/requirements, thus it's advisable to start with a clean directory, |
296 | capabilities/requirements, thus it's advisable to start with a clean directory, |
| 296 | devoid of all cruft from the old eclass implementation.</p> |
297 | devoid of all cruft from the old eclass implementation.</p> |
| 297 | <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 |
| 298 | eclasses, please reread the previous section. It's unfortunately a requirement |
299 | eclasses, please reread the previous section. It's unfortunately a requirement |
| 299 | to take advantage of all that the next major portage release will allow.</p> |
300 | to take advantage of all that the next major portage release will allow.</p> |
| 300 | <p>The proposed directory structure is ${PORTDIR}/include/{eclass,elib}. |
301 | <p>The proposed directory structure is ${PORTDIR}/include/{eclass,elib}. |
| 301 | Something like ${PORTDIR}/new-eclass, or ${PORTDIR}/eclass-ng could be used |
302 | Something like ${PORTDIR}/new-eclass, or ${PORTDIR}/eclass-ng could be used |
| 302 | (although many would cringe at the -ng), but such a name is unwise. Consider the |
303 | (although many would cringe at the -ng), but such a name is unwise. Consider the |
| 303 | possibility (likely a fact) that new eclasses someday may be found lacking, and |
304 | possibility (likely a fact) that new eclasses someday may be found lacking, and |
| 304 | refined further (version three as it were). Or perhaps we want to add yet more |
305 | refined further (version three as it were). Or perhaps we want to add yet more |
| 305 | functionality with direct relation to sourcing new files, and we would then need |
306 | functionality with direct relation to sourcing new files, and we would then need |
| 306 | to further populate ${PORTDIR}.</p> |
307 | to further populate ${PORTDIR}.</p> |
| 307 | <p>The new-eclass directory will be (at least) 2 levels deep- for example:</p> |
308 | <p>The new-eclass directory will be (at least) 2 levels deep- for example:</p> |
| 308 | <dl> |
309 | <dl class="docutils"> |
| 309 | <dt>::</dt> |
310 | <dt>::</dt> |
| 310 | <dd>kernel/ |
311 | <dd>kernel/ |
| 311 | kernel/linux-info.eclass |
312 | kernel/linux-info.eclass |
| 312 | kernel/linux-mod.eclass |
313 | kernel/linux-mod.eclass |
| 313 | kernel/kernel-2.6.eclass |
314 | kernel/kernel-2.6.eclass |
| … | |
… | |
| 322 | saner/easier signing of eclasses- you can just stick a signed |
323 | saner/easier signing of eclasses- you can just stick a signed |
| 323 | Manifest file w/in that grouping, thus providing the information portage needs |
324 | Manifest file w/in that grouping, thus providing the information portage needs |
| 324 | to ensure no files are missing, and that nothing has been tainted.</p> |
325 | to ensure no files are missing, and that nothing has been tainted.</p> |
| 325 | <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> |
| 326 | <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 |
| 327 | to handle signing and committing. This is intentional, and a good thing. This |
328 | to handle signing and committing. This is intentional, and a good thing. This |
| 328 | gives repoman the possibility of doing sanity checks on elibs/new eclasses.</p> |
329 | gives repoman the possibility of doing sanity checks on elibs/new eclasses.</p> |
| 329 | <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- |
| 330 | these checks would only be capable of doing basic sanity checks, such as syntax checks. |
331 | these checks would only be capable of doing basic sanity checks, such as syntax checks. |
| 331 | There is no way to prevent people from doing dumb things (exempting perhaps repeated |
332 | There is no way to prevent people from doing dumb things (exempting perhaps repeated |
| 332 | applications of a cattle prod)- these are strictly automatic checks, akin to repoman's |
333 | applications of a cattle prod)- these are strictly automatic checks, akin to repoman's |
| 333 | dependency checks.</p> |
334 | dependency checks.</p> |
| 334 | </div> |
335 | </div> |
| 335 | <div class="section" id="the-start-of-a-different-phase-of-backwards-compatibility"> |
336 | <div class="section"> |
| 336 | <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> |
| 337 | <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 |
| 338 | intentionally inaccessible to the inherit function. As such, users of older |
339 | intentionally inaccessible to the inherit function. As such, users of older |
| 339 | portage versions <em>will</em> have to upgrade to merge any ebuild that uses elibs/new |
340 | portage versions <em>will</em> have to upgrade to merge any ebuild that uses elibs/new |
| 340 | eclasses. A depend on the next major portage version would transparently handle |
341 | eclasses. A depend on the next major portage version would transparently handle |
| 341 | this for rsync users.</p> |
342 | this for rsync users.</p> |
| 342 | <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 |
| 343 | version. This is a minor concern frankly- portage releases include new |
344 | version. This is a minor concern frankly- portage releases include new |
| 344 | functionality, and bug fixes. If they won't upgrade, it's assumed they have |
345 | functionality, and bug fixes. If they won't upgrade, it's assumed they have |
| 345 | their reasons and are big boys, thus able to handle the complications themselves.</p> |
346 | their reasons and are big boys, thus able to handle the complications themselves.</p> |
| 346 | <p>The real issue is broken envs, whether in binpkgs, or for installed packages. |
347 | <p>The real issue is broken envs, whether in binpkgs, or for installed packages. |
| 347 | Two options exist- either the old eclasses are left in the tree indefinitely, or |
348 | Two options exist- either the old eclasses are left in the tree indefinitely, or |
| 348 | they're left for N months, then shifted out of the tree, and into a tarball that |
349 | they're left for N months, then shifted out of the tree, and into a tarball that |
| … | |
… | |
| 359 | <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 |
| 360 | eclasses are in the tree, as stated, it's assumed they know what they are doing. |
361 | eclasses are in the tree, as stated, it's assumed they know what they are doing. |
| 361 | If they specifically block the new portage version, as the ebuilds in the tree |
362 | If they specifically block the new portage version, as the ebuilds in the tree |
| 362 | migrate to the new eclasses, they will have less and less ebuilds available to |
363 | migrate to the new eclasses, they will have less and less ebuilds available to |
| 363 | them. If they tried injecting the new portage version (lying to portage, |
364 | them. If they tried injecting the new portage version (lying to portage, |
| 364 | essentially), portage would bail since it cannot find the new eclass. |
365 | essentially), portage would bail since it cannot find the new eclass. |
| 365 | For ebuilds that use the new eclasses, there really isn't any way to sidestep |
366 | For ebuilds that use the new eclasses, there really isn't any way to sidestep |
| 366 | the portage version requirement- same as it has been for other portage features.</p> |
367 | the portage version requirement- same as it has been for other portage features.</p> |
| 367 | <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, |
| 368 | if a user has not upgraded to a portage version supporting env processing, they |
369 | if a user has not upgraded to a portage version supporting env processing, they |
| 369 | will lose the ability to unmerge any installed ebuild that used an old |
370 | will lose the ability to unmerge any installed ebuild that used an old |
| 370 | eclass. Same cause, different symptom being they will lose the ability to merge |
371 | eclass. Same cause, different symptom being they will lose the ability to merge |
| 371 | any tbz2 that uses old eclasses also.</p> |
372 | any tbz2 that uses old eclasses also.</p> |
| 372 | <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 |
| 373 | has suffered significant corruption of their installed package database (vdb). This is |
374 | has suffered significant corruption of their installed package database (vdb). This is |
| 374 | ignoring the question of whether the vdb is even usable at this point, but the possibility |
375 | ignoring the question of whether the vdb is even usable at this point, but the possibility |
| 375 | exists for the saved envs to be non usable due to either A) missing, or B) corrupted. |
376 | exists for the saved envs to be non usable due to either A) missing, or B) corrupted. |
| 376 | In such a case, even with the new portage capabilities, they would need |
377 | In such a case, even with the new portage capabilities, they would need |
| 377 | the old eclass compat ebuild.</p> |
378 | the old eclass compat ebuild.</p> |
| 378 | <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 |
| 379 | fs corruption. Regardless of the cause, it's quite likely for this to even become an |
380 | fs corruption. Regardless of the cause, it's quite likely for this to even become an |
| 380 | issue, the system's vdb is completely unusable. It's a moot issue at that point. |
381 | issue, the system's vdb is completely unusable. It's a moot issue at that point. |
| 381 | If you lose your vdb, or it gets seriously damaged, it's akin to lobotomizing portage- |
382 | If you lose your vdb, or it gets seriously damaged, it's akin to lobotomizing portage- |
| 382 | it doesn't know what's installed, it doesn't know of it's own files, and in general, |
383 | it doesn't know what's installed, it doesn't know of its own files, and in general, |
| 383 | a rebuilding of the system is about the only sane course of action. The missing env is |
384 | a rebuilding of the system is about the only sane course of action. The missing env is |
| 384 | truly the least of the users concern in such a case.</p> |
385 | truly the least of the users concern in such a case.</p> |
| 385 | <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 |
| 386 | <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 |
| 387 | the missing eclasses, thus providing that lost functionality .</p> |
388 | the missing eclasses, thus providing that lost functionality.</p> |
| 388 | <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 |
| 389 | lost functionality. The intention is to clean up the existing mess, and allow us |
390 | lost functionality. The intention is to clean up the existing mess, and allow us |
| 390 | to move forward. The saying "you've got to break a few eggs to make an omelet" |
391 | to move forward. The saying "you've got to break a few eggs to make an omelet" |
| 391 | is akin, exempting the fact we're providing a way to make the eggs whole again |
392 | is akin, exempting the fact we're providing a way to make the eggs whole again |
| 392 | (the king's men would've loved such an option).</p> |
393 | (the king's men would've loved such an option).</p> |
| 393 | </div> |
394 | </div> |
| 394 | <div class="section" id="migrating-to-the-new-setup"> |
395 | <div class="section"> |
| 395 | <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> |
| 396 | <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 |
| 397 | requiring a specific version of portage, as ebuilds migrate to the new eclasses, |
398 | requiring a specific version of portage, as ebuilds migrate to the new eclasses, |
| 398 | they should depend on a version of portage that supports it. From the users |
399 | they should depend on a version of portage that supports it. From the users |
| 399 | viewpoint, this transparently handles the migration.</p> |
400 | viewpoint, this transparently handles the migration.</p> |
| 400 | <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. |
| … | |
… | |
| 406 | <p>Additionally, prior to any ebuilds in the tree using the new eclasses, the |
407 | <p>Additionally, prior to any ebuilds in the tree using the new eclasses, the |
| 407 | infrastructure server that generates the cache for rsync users will have to |
408 | infrastructure server that generates the cache for rsync users will have to |
| 408 | either be upgraded to a version of portage supporting new eclasses, or patched. |
409 | either be upgraded to a version of portage supporting new eclasses, or patched. |
| 409 | The former being much more preferable then the latter for the portage devs.</p> |
410 | The former being much more preferable then the latter for the portage devs.</p> |
| 410 | <p>Beyond that, an appropriate window for old eclasses to exist in the tree must be |
411 | <p>Beyond that, an appropriate window for old eclasses to exist in the tree must be |
| 411 | determined, and prior to that window passing an ebuild must be added to the tree |
412 | determined, and prior to that window passing, an ebuild must be added to the tree |
| 412 | so users can get the old eclasses if needed.</p> |
413 | so users can get the old eclasses if needed.</p> |
| 413 | <p>For eclass devs to migrate from old to new, it is possible for them to just |
414 | <p>For eclass devs to migrate from old to new, it is possible for them to just |
| 414 | transfer the old eclass into an appropriate grouping in the new eclass directory, |
415 | transfer the old eclass into an appropriate grouping in the new eclass directory, |
| 415 | although it's advisable they cleanse all cruft out of the eclass. You can |
416 | although it's advisable they cleanse all cruft out of the eclass. You can |
| 416 | migrate ebuilds gradually over to the new eclass, and don't have to worry about |
417 | migrate ebuilds gradually over to the new eclass, and don't have to worry about |
| 417 | having to support ebuilds from X years back.</p> |
418 | having to support ebuilds from X years back.</p> |
| 418 | <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 |
| 419 | window in which to redesign it. It's humbly suggested eclass devs take |
420 | window in which to redesign it. It's humbly suggested eclass devs take |
| 420 | advantage of it. :)</p> |
421 | advantage of it. :)</p> |
| 421 | </div> |
422 | </div> |
| 422 | </div> |
423 | </div> |
| 423 | <div class="section" id="backwards-compatibility"> |
424 | <div class="section"> |
| 424 | <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> |
| 425 | <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- |
| 426 | it's suggested that if the a particular compatibility issue is |
427 | it's suggested that if the a particular compatibility issue is |
| 427 | questioned/worried over, the reader read the relevant section. There should be |
428 | questioned/worried over, the reader read the relevant section. There should be |
| 428 | a more in depth discussion of the issue, along with a more extensive explanation |
429 | a more in depth discussion of the issue, along with a more extensive explanation |
| 429 | of the potential solutions, and reasons for the chosen solution.</p> |
430 | of the potential solutions, and reasons for the chosen solution.</p> |
| 430 | <p>To recap:</p> |
431 | <p>To recap:</p> |
| 431 | <pre class="literal-block"> |
432 | <pre class="literal-block"> |
| 432 | New eclasses and elib functionality will be tied to a specific portage |
433 | New eclasses and elib functionality will be tied to a specific portage |
| 433 | version. A DEPENDs on said portage version should address this for rsync |
434 | version. A DEPENDs on said portage version should address this for rsync |
| 434 | users who refuse to upgrade to a portage version that supports the new |
435 | users who refuse to upgrade to a portage version that supports the new |
| 435 | eclasses/elibs and will gradually be unable to merge ebuilds that use said |
436 | eclasses/elibs and will gradually be unable to merge ebuilds that use said |
| 436 | functionality. It is their choice to upgrade, as such, the gradual |
437 | functionality. It is their choice to upgrade, as such, the gradual |
| 437 | 'thinning' of available ebuilds should they block the portage upgrade is |
438 | 'thinning' of available ebuilds should they block the portage upgrade is |
| 438 | their responsibility. |
439 | their responsibility. |
| 439 | |
440 | |
| 440 | Old eclasses at some point in the future should be removed from the tree, |
441 | Old eclasses at some point in the future should be removed from the tree, |
| 441 | and released in a tarball/ebuild. This will cause installed ebuilds that |
442 | and released in a tarball/ebuild. This will cause installed ebuilds that |
| 442 | rely on the old eclass to be unable to unmerge, with the same applying for |
443 | rely on the old eclass to be unable to unmerge, with the same applying for |
| 443 | merging of binpkgs dependent on the following paragraph. |
444 | merging of binpkgs dependent on the following paragraph. |
| 444 | |
445 | |
| 445 | The old eclass-compat is only required for users who do not upgrade their |
446 | The old eclass-compat is only required for users who do not upgrade their |
| 446 | portage installation, and one further exemption- if the user has somehow |
447 | portage installation, and one further exemption- if the user has somehow |
| 447 | corrupted/destroyed their installed pkgs database (/var/db/pkg currently), |
448 | corrupted/destroyed their installed pkgs database (/var/db/pkg currently), |
| 448 | in the process, they've lost their saved environments. The eclass-compat |
449 | in the process, they've lost their saved environments. The eclass-compat |
| 449 | ebuild would be required for ebuilds that required older eclasses in such a |
450 | ebuild would be required for ebuilds that required older eclasses in such a |
| 450 | case. Note, this case is rare also- as clarified above, it's mentioned |
451 | case. Note, this case is rare also- as clarified above, it's mentioned |
| 451 | strictly to be complete, it's not much of a real world scenario as elaborated |
452 | strictly to be complete, it's not much of a real world scenario as elaborated |
| 452 | above. |
453 | above. |
| 453 | </pre> |
454 | </pre> |
| 454 | </div> |
455 | </div> |
| 455 | <div class="section" id="copyright"> |
456 | <div class="section"> |
| 456 | <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> |
| 457 | <p>This document has been placed in the public domain.</p> |
458 | <p>This document has been placed in the public domain.</p> |
| 458 | </div> |
459 | </div> |
| 459 | </div> |
|
|
| 460 | |
460 | |
|
|
461 | </div> |
|
|
462 | <div class="footer"> |
| 461 | <hr class="footer" /> |
463 | <hr class="footer" /> |
| 462 | <div class="footer"> |
|
|
| 463 | <a class="reference" href="glep-0033.txt">View document source</a>. |
464 | <a class="reference" href="glep-0033.txt">View document source</a>. |
| 464 | Generated on: 2005-03-06 20:38 UTC. |
465 | Generated on: 2007-10-13 13:39 UTC. |
| 465 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
466 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
|
|
467 | |
| 466 | </div> |
468 | </div> |
| 467 | </body> |
469 | </body> |
| 468 | </html> |
470 | </html> |
| 469 | |
471 | |