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

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

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

Revision 1.2 Revision 1.7
… …
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 4
5<head> 5<head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
8 <title>GLEP 60 -- Manifest2 filetypes</title> 8 <title>GLEP 60 -- Manifest2 filetypes</title>
9 <link rel="stylesheet" href="tools/glep.css" type="text/css" /></head> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" /></head>
10<body bgcolor="white"> 10<body bgcolor="white">
11<table class="navigation" cellpadding="0" cellspacing="0" 11<table class="navigation" cellpadding="0" cellspacing="0"
12 width="100%" border="0"> 12 width="100%" border="0">
… …
25<tbody valign="top"> 25<tbody valign="top">
26<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">60</td> 26<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">60</td>
27</tr> 27</tr>
28<tr class="field"><th class="field-name">Title:</th><td class="field-body">Manifest2 filetypes</td> 28<tr class="field"><th class="field-name">Title:</th><td class="field-body">Manifest2 filetypes</td>
29</tr> 29</tr>
30<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> 30<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.8</td>
31</tr> 31</tr>
32<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0060.txt?cvsroot=gentoo">2008/10/22 17:59:43</a></td> 32<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0060.txt?cvsroot=gentoo">2010/01/31 07:56:58</a></td>
33</tr> 33</tr>
34<tr class="field"><th class="field-name">Author:</th><td class="field-body">Robin Hugh Johnson &lt;robbat2&#32;&#97;t&#32;gentoo.org&gt;</td> 34<tr class="field"><th class="field-name">Author:</th><td class="field-body">Robin Hugh Johnson &lt;robbat2&#32;&#97;t&#32;gentoo.org&gt;</td>
35</tr> 35</tr>
36<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 36<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
37</tr> 37</tr>
… …
41</tr> 41</tr>
42<tr class="field"><th class="field-name">Requires:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/proj/en/glepglep-0044.html">44</a></td> 42<tr class="field"><th class="field-name">Requires:</th><td class="field-body"><a class="reference external" href="http://www.gentoo.org/proj/en/glepglep-0044.html">44</a></td>
43</tr> 43</tr>
44<tr class="field"><th class="field-name">Created:</th><td class="field-body">November 2007</td> 44<tr class="field"><th class="field-name">Created:</th><td class="field-body">November 2007</td>
45</tr> 45</tr>
46<tr class="field"><th class="field-name">Updated:</th><td class="field-body">June 2008, July 2008</td> 46<tr class="field"><th class="field-name">Updated:</th><td class="field-body">June 2008, July 2008, October 2008, January 2010</td>
47</tr> 47</tr>
48<tr class="field"><th class="field-name">Updates:</th><td class="field-body">44</td> 48<tr class="field"><th class="field-name">Updates:</th><td class="field-body">44</td>
49</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">December 2009, January 2010</td>
49</tr> 51</tr>
50</tbody> 52</tbody>
51</table> 53</table>
52<hr /> 54<hr />
53<div class="contents topic" id="contents"> 55<div class="contents topic" id="contents">
54<p class="topic-title first">Contents</p> 56<p class="topic-title first">Contents</p>
55<ul class="simple"> 57<ul class="simple">
56<li><a class="reference internal" href="#abstract" id="id16">Abstract</a></li> 58<li><a class="reference internal" href="#abstract" id="id4">Abstract</a></li>
57<li><a class="reference internal" href="#motivation" id="id17">Motivation</a></li> 59<li><a class="reference internal" href="#motivation" id="id5">Motivation</a></li>
58<li><a class="reference internal" href="#specification" id="id18">Specification</a><ul> 60<li><a class="reference internal" href="#specification" id="id6">Specification</a><ul>
59<li><a class="reference internal" href="#general" id="id19">General</a></li> 61<li><a class="reference internal" href="#general" id="id7">General</a></li>
60<li><a class="reference internal" href="#excluded-files" id="id20">Excluded files</a></li> 62<li><a class="reference internal" href="#excluded-files" id="id8">Excluded files</a></li>
61<li><a class="reference internal" href="#existing-filetypes" id="id21">Existing filetypes:</a><ul> 63<li><a class="reference internal" href="#existing-filetypes" id="id9">Existing filetypes:</a><ul>
62<li><a class="reference internal" href="#aux" id="id22">AUX</a></li> 64<li><a class="reference internal" href="#aux" id="id10">AUX</a></li>
63<li><a class="reference internal" href="#ebuild" id="id23">EBUILD</a></li> 65<li><a class="reference internal" href="#ebuild" id="id11">EBUILD</a></li>
64<li><a class="reference internal" href="#dist" id="id24">DIST</a></li> 66<li><a class="reference internal" href="#dist" id="id12">DIST</a></li>
65<li><a class="reference internal" href="#misc" id="id25">MISC</a></li> 67<li><a class="reference internal" href="#misc" id="id13">MISC</a></li>
66</ul>
67</li> 68</ul>
69</li>
68<li><a class="reference internal" href="#new-filetypes" id="id26">New filetypes:</a><ul> 70<li><a class="reference internal" href="#new-filetypes" id="id14">New filetypes:</a><ul>
69<li><a class="reference internal" href="#info-new-abstract" id="id27">_INFO (new, abstract)</a></li> 71<li><a class="reference internal" href="#info-new-abstract" id="id15">_INFO (new, abstract)</a></li>
70<li><a class="reference internal" href="#crit-new-abstract" id="id28">_CRIT (new, abstract)</a></li> 72<li><a class="reference internal" href="#crit-new-abstract" id="id16">_CRIT (new, abstract)</a></li>
71<li><a class="reference internal" href="#id9" id="id29">EBUILD</a></li> 73<li><a class="reference internal" href="#id1" id="id17">EBUILD</a></li>
72<li><a class="reference internal" href="#id10" id="id30">DIST</a></li> 74<li><a class="reference internal" href="#id2" id="id18">DIST</a></li>
73<li><a class="reference internal" href="#id11" id="id31">MISC</a></li> 75<li><a class="reference internal" href="#id3" id="id19">MISC</a></li>
74<li><a class="reference internal" href="#manifest-new" id="id32">MANIFEST (new)</a></li> 76<li><a class="reference internal" href="#manifest-new" id="id20">MANIFEST (new)</a></li>
75<li><a class="reference internal" href="#eclass-new" id="id33">ECLASS (new)</a></li> 77<li><a class="reference internal" href="#eclass-new" id="id21">ECLASS (new)</a></li>
76<li><a class="reference internal" href="#data-new" id="id34">DATA (new)</a></li> 78<li><a class="reference internal" href="#data-new" id="id22">DATA (new)</a></li>
77<li><a class="reference internal" href="#exec-new" id="id35">EXEC (new)</a></li> 79<li><a class="reference internal" href="#exec-new" id="id23">EXEC (new)</a></li>
78<li><a class="reference internal" href="#unknown-new" id="id36">UNKNOWN (new)</a></li> 80<li><a class="reference internal" href="#other-new" id="id24">OTHER (new)</a></li>
79</ul>
80</li> 81</ul>
82</li>
81<li><a class="reference internal" href="#on-bloat" id="id37">On Bloat</a></li> 83<li><a class="reference internal" href="#on-bloat" id="id25">On Bloat</a></li>
82<li><a class="reference internal" href="#chosing-a-filetype" id="id38">Chosing a filetype</a></li> 84<li><a class="reference internal" href="#chosing-a-filetype" id="id26">Chosing a filetype</a></li>
83</ul>
84</li> 85</ul>
86</li>
85<li><a class="reference internal" href="#backwards-compatibility" id="id39">Backwards Compatibility</a></li> 87<li><a class="reference internal" href="#backwards-compatibility" id="id27">Backwards Compatibility</a></li>
86<li><a class="reference internal" href="#thanks-to" id="id40">Thanks to</a></li> 88<li><a class="reference internal" href="#thanks-to" id="id28">Thanks to</a></li>
87<li><a class="reference internal" href="#references" id="id41">References</a></li> 89<li><a class="reference internal" href="#references" id="id29">References</a></li>
88<li><a class="reference internal" href="#copyright" id="id42">Copyright</a></li> 90<li><a class="reference internal" href="#copyright" id="id30">Copyright</a></li>
89</ul> 91</ul>
90</div> 92</div>
91<div class="section" id="abstract"> 93<div class="section" id="abstract">
92<h1><a class="toc-backref" href="#id16">Abstract</a></h1> 94<h1><a class="toc-backref" href="#id4">Abstract</a></h1>
93<p>Clarification of the Manifest2 [GLEP44] specification, including new types to 95<p>Clarification of the Manifest2 [#GLEP44] specification, including new types to
94help in the tree-signing specification.</p> 96help in the tree-signing specification.</p>
95</div> 97</div>
96<div class="section" id="motivation"> 98<div class="section" id="motivation">
97<h1><a class="toc-backref" href="#id17">Motivation</a></h1> 99<h1><a class="toc-backref" href="#id5">Motivation</a></h1>
98<p>[GLEP44] was not entirely clear on the usage of filetype specifiers. 100<p>[#GLEP44] was not entirely clear on the usage of filetype specifiers.
99This document serves to provide some of the internal logic used by 101This document serves to provide some of the internal logic used by
100Portage at the point of writing, as well as adding new types to cover 102Portage at the point of writing, as well as adding new types to cover
101the rest of the tree, for the purposes of tree-signing coverage.</p> 103the rest of the tree, for the purposes of tree-signing coverage.</p>
104<p>This GLEP is not mandatory for the tree-signing specification, but
105instead aims to clarify the usage of the Manifest2 filetype specifiers,
106and note which types signify files that are allowed to be missing from
107the tree (e.g. a user excluding a package or category).</p>
102</div> 108</div>
103<div class="section" id="specification"> 109<div class="section" id="specification">
104<h1><a class="toc-backref" href="#id18">Specification</a></h1> 110<h1><a class="toc-backref" href="#id6">Specification</a></h1>
105<div class="section" id="general"> 111<div class="section" id="general">
106<h2><a class="toc-backref" href="#id19">General</a></h2> 112<h2><a class="toc-backref" href="#id7">General</a></h2>
107<p>For any given directory with a Manifest file, every file located in that 113<p>For any given directory with a Manifest file, every file located in that
108directory, or a sub-directory must be listed in that Manifest file, 114directory, or a sub-directory must be listed in that Manifest file,
109unless stated otherwise in the following sections. The Manifest file 115unless stated otherwise in the following sections. The Manifest file
110must not contain an entry for itself.</p> 116must not contain an entry for itself.</p>
111</div> 117</div>
112<div class="section" id="excluded-files"> 118<div class="section" id="excluded-files">
113<h2><a class="toc-backref" href="#id20">Excluded files</a></h2> 119<h2><a class="toc-backref" href="#id8">Excluded files</a></h2>
114<p>When generating or validating a Manifest, or commiting to a version 120<p>When generating or validating a Manifest, or committing to a version
115control system, the package manager should endeavour to ignore files 121control system, the package manager should endeavour to ignore files
116created by a version control system, backup files from text editors. A 122created by a version control system, backup files from text editors. A
117non-exhaustive list is suggested here: CVS/, .svn/, .bzr/, .git/, .hg/, 123non-exhaustive list is suggested here: <tt class="docutils literal">CVS/</tt>, <tt class="docutils literal">.svn/</tt>, <tt class="docutils literal">.bzr/</tt>,
118.#*, <a href="#id1"><span class="problematic" id="id2">*</span></a>.rej, <a href="#id3"><span class="problematic" id="id4">*</span></a>.orig, <a href="#id5"><span class="problematic" id="id6">*</span></a>.bak, <a href="#id7"><span class="problematic" id="id8">*</span></a>~.</p> 124<tt class="docutils literal">.git/</tt>, <tt class="docutils literal">.hg/</tt>, <tt class="docutils literal">.#*</tt>, <tt class="docutils literal">*.rej</tt>, <tt class="docutils literal">*.orig</tt>, <tt class="docutils literal">*.bak</tt>, <tt class="docutils literal">*~</tt>.</p>
119<div class="system-message" id="id1">
120<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">glep-0060.txt</tt>, line 37); <em><a href="#id2">backlink</a></em></p>
121Inline emphasis start-string without end-string.</div>
122<div class="system-message" id="id3">
123<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">glep-0060.txt</tt>, line 37); <em><a href="#id4">backlink</a></em></p>
124Inline emphasis start-string without end-string.</div>
125<div class="system-message" id="id5">
126<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">glep-0060.txt</tt>, line 37); <em><a href="#id6">backlink</a></em></p>
127Inline emphasis start-string without end-string.</div>
128<div class="system-message" id="id7">
129<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">glep-0060.txt</tt>, line 37); <em><a href="#id8">backlink</a></em></p>
130Inline emphasis start-string without end-string.</div>
131<p>Additionally, for a transitional Manifest1-&gt;Manifest2 system, old-style 125<p>Additionally, for a transitional Manifest1-&gt;Manifest2 system, old-style
132digest files located in a 'files/' directory, may be excluded from 126digest files located in a 'files/' directory, may be excluded from
133Manifest2 generation, or included with a type of MISC.</p> 127Manifest2 generation, or included with a type of MISC.</p>
134<p>Under strict security conditions, the exclusion list may be ignored 128<p>Under strict security conditions, the exclusion list may be ignored
135during validation if the existence of a file would be considered a 129during validation if the existence of a file would be considered a
136security risk.</p> 130security risk.</p>
137</div> 131</div>
138<div class="section" id="existing-filetypes"> 132<div class="section" id="existing-filetypes">
139<h2><a class="toc-backref" href="#id21">Existing filetypes:</a></h2> 133<h2><a class="toc-backref" href="#id9">Existing filetypes:</a></h2>
140<div class="section" id="aux"> 134<div class="section" id="aux">
141<h3><a class="toc-backref" href="#id22">AUX</a></h3> 135<h3><a class="toc-backref" href="#id10">AUX</a></h3>
142<ul class="simple"> 136<ul class="simple">
143<li>The AUX type is used for all items under the 'files' subdirectory.</li> 137<li>The AUX type is used for all items under the 'files' subdirectory.</li>
144<li>They should be verified relative to $FILESDIR.</li> 138<li>They should be verified relative to $FILESDIR.</li>
145<li>The string 'files/' is left out of the Manifest line.</li> 139<li>The string 'files/' is left out of the Manifest line.</li>
146<li>The absence of a file mentioned by AUX must be treated as an error.</li> 140<li>The absence of a file mentioned by AUX must be treated as an error.</li>
… …
148(either directly or indirectly), that must be treated an error if 142(either directly or indirectly), that must be treated an error if
149modified or absent.</li> 143modified or absent.</li>
150</ul> 144</ul>
151</div> 145</div>
152<div class="section" id="ebuild"> 146<div class="section" id="ebuild">
153<h3><a class="toc-backref" href="#id23">EBUILD</a></h3> 147<h3><a class="toc-backref" href="#id11">EBUILD</a></h3>
154<ul class="simple"> 148<ul class="simple">
155<li>The EBUILD type is used solely for files ending in .ebuild, or other 149<li>The EBUILD type is used solely for files ending in .ebuild, or other
156suffixes as defined by the EAPI.</li> 150suffixes as defined by the EAPI.</li>
157<li>The files are located in the same directory as the Manifest file.</li> 151<li>The files are located in the same directory as the Manifest file.</li>
158<li>The modification or absence of a file mentioned by EBUILD must be 152<li>The modification or absence of a file mentioned by EBUILD must be
159treated as an error.</li> 153treated as an error.</li>
160</ul> 154</ul>
161</div> 155</div>
162<div class="section" id="dist"> 156<div class="section" id="dist">
163<h3><a class="toc-backref" href="#id24">DIST</a></h3> 157<h3><a class="toc-backref" href="#id12">DIST</a></h3>
164<ul class="simple"> 158<ul class="simple">
165<li>The DIST type is used for distfiles</li> 159<li>The DIST type is used for distfiles</li>
166<li>They may be found directly via the $DISTDIR setting of the package 160<li>They may be found directly via the $DISTDIR setting of the package
167manager.</li> 161manager.</li>
168<li>During simple verification of a Manifest, a missing DIST file should 162<li>During simple verification of a Manifest, a missing DIST file should
169not be consider as a validation error (it is however a failure to 163not be consider as a validation error (it is however a failure to
170fetch or unpack).</li> 164fetch or unpack).</li>
171</ul> 165</ul>
172</div> 166</div>
173<div class="section" id="misc"> 167<div class="section" id="misc">
174<h3><a class="toc-backref" href="#id25">MISC</a></h3> 168<h3><a class="toc-backref" href="#id13">MISC</a></h3>
175<ul class="simple"> 169<ul class="simple">
176<li>The MISC type covers all remaining files in a directory.</li> 170<li>The MISC type covers all remaining files in a directory.</li>
177<li>MISC is intended to mark all content that was not used in 171<li>MISC is intended to mark all content that was not used in
178some way that directly affected execution of the package manager.</li> 172some way that directly affected execution of the package manager.</li>
179<li>This includes metadata.xml and ChangeLog entries, and any other purely 173<li>This includes metadata.xml and ChangeLog entries, and any other purely
… …
184been deleted from the tree.</li> 178been deleted from the tree.</li>
185</ul> 179</ul>
186</div> 180</div>
187</div> 181</div>
188<div class="section" id="new-filetypes"> 182<div class="section" id="new-filetypes">
189<h2><a class="toc-backref" href="#id26">New filetypes:</a></h2> 183<h2><a class="toc-backref" href="#id14">New filetypes:</a></h2>
190<div class="section" id="info-new-abstract"> 184<div class="section" id="info-new-abstract">
191<h3><a class="toc-backref" href="#id27">_INFO (new, abstract)</a></h3> 185<h3><a class="toc-backref" href="#id15">_INFO (new, abstract)</a></h3>
192<ul class="simple"> 186<ul class="simple">
193<li>This is the functionality of the old AUX, but does not include the 187<li>This is the functionality of the old AUX, but does not include the
194implicit 'files/' prefix in the path, and is verified relative to the 188implicit 'files/' prefix in the path, and is verified relative to the
195working directory instead of $FILESDIR.</li> 189working directory instead of $FILESDIR.</li>
196<li>The modification or absence of a file listed as a _INFO-derived type 190<li>The modification or absence of a file listed as a _INFO-derived type
197is not an error unless the package manager is attempting to be strict.</li> 191is not an error unless the package manager is attempting to be strict.</li>
198</ul> 192</ul>
199</div> 193</div>
200<div class="section" id="crit-new-abstract"> 194<div class="section" id="crit-new-abstract">
201<h3><a class="toc-backref" href="#id28">_CRIT (new, abstract)</a></h3> 195<h3><a class="toc-backref" href="#id16">_CRIT (new, abstract)</a></h3>
202<ul class="simple"> 196<ul class="simple">
203<li>_CRIT is based off the _INFO type.</li> 197<li>_CRIT is based off the _INFO type.</li>
204<li>The modification or absence of a file listed as a _CRIT-derived type 198<li>The modification or absence of a file listed as a _CRIT-derived type
205must be treated as an error.</li> 199MUST be treated as an error.</li>
206</ul> 200</ul>
207</div> 201</div>
208<div class="section" id="id9"> 202<div class="section" id="id1">
209<h3><a class="toc-backref" href="#id29">EBUILD</a></h3> 203<h3><a class="toc-backref" href="#id17">EBUILD</a></h3>
210<ul class="simple"> 204<ul class="simple">
211<li>Now derived from _CRIT.</li> 205<li>Now derived from _CRIT.</li>
212<li>Otherwise unchanged.</li> 206<li>Otherwise unchanged.</li>
213</ul> 207</ul>
214</div> 208</div>
215<div class="section" id="id10"> 209<div class="section" id="id2">
216<h3><a class="toc-backref" href="#id30">DIST</a></h3> 210<h3><a class="toc-backref" href="#id18">DIST</a></h3>
217<ul class="simple"> 211<ul class="simple">
218<li>Now derived from _CRIT.</li> 212<li>Now derived from _CRIT.</li>
219<li>Otherwise unchanged.</li> 213<li>Otherwise unchanged.</li>
220</ul> 214</ul>
221</div> 215</div>
222<div class="section" id="id11"> 216<div class="section" id="id3">
223<h3><a class="toc-backref" href="#id31">MISC</a></h3> 217<h3><a class="toc-backref" href="#id19">MISC</a></h3>
224<ul class="simple"> 218<ul class="simple">
225<li>Now derived from _INFO.</li> 219<li>Now derived from _INFO.</li>
226<li>Otherwise unchanged.</li> 220<li>Otherwise unchanged.</li>
227</ul> 221</ul>
228</div> 222</div>
229<div class="section" id="manifest-new"> 223<div class="section" id="manifest-new">
230<h3><a class="toc-backref" href="#id32">MANIFEST (new)</a></h3> 224<h3><a class="toc-backref" href="#id20">MANIFEST (new)</a></h3>
231<ul class="simple"> 225<ul class="simple">
232<li>The MANIFEST type is explicitly to cover all nested Manifest files.</li> 226<li>The MANIFEST type is explicitly to cover all nested Manifest files.</li>
233<li>During validation, this serves as an indicator that the package 227<li>During validation, this serves as an indicator that the package
234manager may need to check subtree Manifest file.</li> 228manager may need to check subtree Manifest file.</li>
235<li>A missing MANIFEST file may be treated as a minor (eg excluding an 229<li>A missing MANIFEST file may be treated as a minor (e.g. excluding an
236entire category) or critical validation failure.</li> 230entire category) or critical validation failure.</li>
237<li>The failure should be considered as critical only if files that would 231<li>The failure should be considered as critical only if files that would
238be directly covered by this Manifest are missing. Deletion of a 232be directly covered by this Manifest are missing. Deletion of a
239category-level Manifest while preserving the packages is forbidden. 233category-level Manifest while preserving the packages is forbidden.
240Deletion of an entire category is not.</li> 234Deletion of an entire category is not.</li>
241</ul> 235</ul>
242</div> 236</div>
243<div class="section" id="eclass-new"> 237<div class="section" id="eclass-new">
244<h3><a class="toc-backref" href="#id33">ECLASS (new)</a></h3> 238<h3><a class="toc-backref" href="#id21">ECLASS (new)</a></h3>
245<ul class="simple"> 239<ul class="simple">
246<li>uses _CRIT.</li> 240<li>uses _CRIT.</li>
247<li>This type shall be used for all eclasses only.</li> 241<li>This type shall be used for all eclasses only.</li>
248<li>TODO: What about patches etc under eclasses/? Probably EXEC?</li>
249</ul> 242</ul>
250</div> 243</div>
251<div class="section" id="data-new"> 244<div class="section" id="data-new">
252<h3><a class="toc-backref" href="#id34">DATA (new)</a></h3> 245<h3><a class="toc-backref" href="#id22">DATA (new)</a></h3>
253<ul class="simple"> 246<ul class="simple">
254<li>uses _CRIT.</li> 247<li>uses _CRIT.</li>
255<li>The DATA type shall be used for all files that directly affect the 248<li>The DATA type shall be used for all files that directly affect the
256package manager, such as metadata/cache/* and profiles/.</li> 249package manager, such as metadata/cache/* and profiles/.</li>
257</ul> 250</ul>
258</div> 251</div>
259<div class="section" id="exec-new"> 252<div class="section" id="exec-new">
260<h3><a class="toc-backref" href="#id35">EXEC (new)</a></h3> 253<h3><a class="toc-backref" href="#id23">EXEC (new)</a></h3>
261<ul class="simple"> 254<ul class="simple">
262<li>uses _CRIT.</li> 255<li>uses _CRIT.</li>
263<li>If the file gets sourced, executed, or causes a change (patches) in 256<li>If the file gets sourced, executed, or causes a change (patches) in
264how something is sourced or execututed, it belongs in the EXEC 257how something is sourced or executed, it belongs in the EXEC
265filetype.</li> 258filetype.</li>
266<li>This filetype should be used for the scripts directories of a 259<li>This filetype should be used for the scripts directories of a
267repository for important files.</li> 260repository for important files.</li>
261<li>This filetype is not limited to being used in the files/
262subdirectory.</li>
268</ul> 263</ul>
269</div> 264</div>
270<div class="section" id="unknown-new"> 265<div class="section" id="other-new">
271<h3><a class="toc-backref" href="#id36">UNKNOWN (new)</a></h3> 266<h3><a class="toc-backref" href="#id24">OTHER (new)</a></h3>
272<ul class="simple"> 267<ul class="simple">
273<li>uses _CRIT.</li> 268<li>uses _CRIT.</li>
274<li>All other files that are not covered by another type should be 269<li>All other files that are not covered by another type should be
275considered as 'UNKNOWN'.</li> 270considered as 'OTHER'.</li>
271<li>Any further new filetypes should be introduced to subtract files
272from the 'OTHER' set.</li>
273<li>If a package manager runs into a unknown Manifest2 type, it should
274be treated as 'OTHER'.</li>
276</ul> 275</ul>
277</div> 276</div>
278</div> 277</div>
279<div class="section" id="on-bloat"> 278<div class="section" id="on-bloat">
280<h2><a class="toc-backref" href="#id37">On Bloat</a></h2> 279<h2><a class="toc-backref" href="#id25">On Bloat</a></h2>
281<p>If repeated use of a common path prefix is considered a bloat problem, a 280<p>If repeated use of a common path prefix is considered a bloat problem, a
282Manifest file should be added inside the common directory, however this 281Manifest file should be added inside the common directory, however this
283should not be done blindly, as bloat by inodes is more significant for 282should not be done blindly, as bloat by inodes is more significant for
284the majority of use cases.</p> 283the majority of use cases. See also [#GLEP58] on size reductions of
284Manifests.</p>
285</div> 285</div>
286<div class="section" id="chosing-a-filetype"> 286<div class="section" id="chosing-a-filetype">
287<h2><a class="toc-backref" href="#id38">Chosing a filetype</a></h2> 287<h2><a class="toc-backref" href="#id26">Chosing a filetype</a></h2>
288<ol class="arabic"> 288<ol class="arabic">
289<li><dl class="first docutils"> 289<li><dl class="first docutils">
290<dt>matches Manifest</dt> 290<dt>matches <tt class="docutils literal">Manifest</tt></dt>
291<dd><p class="first last">=&gt; MANIFEST, stop.</p> 291<dd><p class="first last">=&gt; MANIFEST, stop.</p>
292</dd> 292</dd>
293</dl> 293</dl>
294</li> 294</li>
295<li><dl class="first docutils"> 295<li><dl class="first docutils">
296<dt>matches <a href="#id12"><span class="problematic" id="id13">*</span></a>.ebuild</dt> 296<dt>matches <tt class="docutils literal">*.ebuild</tt></dt>
297<dd><div class="first system-message" id="id12">
298<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">glep-0060.txt</tt>, line 174); <em><a href="#id13">backlink</a></em></p>
299<p>Inline emphasis start-string without end-string.</p>
300</div>
301<p class="last">=&gt; EBUILD, stop.</p> 297<dd><p class="first last">=&gt; EBUILD, stop.</p>
302</dd>
303</dl> 298</dd>
304</li> 299</dl>
300</li>
305<li><dl class="first docutils"> 301<li><dl class="first docutils">
306<dt>matches <a href="#id14"><span class="problematic" id="id15">*</span></a>.eclass</dt> 302<dt>matches <tt class="docutils literal">*.eclass</tt></dt>
307<dd><div class="first system-message" id="id14">
308<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">glep-0060.txt</tt>, line 176); <em><a href="#id15">backlink</a></em></p>
309<p>Inline emphasis start-string without end-string.</p>
310</div>
311<p class="last">=&gt; ECLASS, stop.</p> 303<dd><p class="first last">=&gt; ECLASS, stop.</p>
312</dd> 304</dd>
313</dl> 305</dl>
314</li> 306</li>
315<li><dl class="first docutils"> 307<li><dl class="first docutils">
316<dt>listed in SRC_URI</dt> 308<dt>listed in SRC_URI</dt>
317<dd><p class="first last">=&gt; DIST, stop.</p> 309<dd><p class="first last">=&gt; DIST, stop.</p>
318</dd> 310</dd>
319</dl> 311</dl>
320</li> 312</li>
321<li><dl class="first docutils"> 313<li><dl class="first docutils">
322<dt>matches files/*</dt> 314<dt>matches <tt class="docutils literal">files/*</tt></dt>
323<dd><p class="first last">=&gt; AUX, continue [see note].</p> 315<dd><p class="first last">=&gt; AUX, continue [see note].</p>
324</dd> 316</dd>
325</dl> 317</dl>
326</li> 318</li>
327<li><dl class="first docutils"> 319<li><dl class="first docutils">
328<dt>matches {<em>.sh,</em>.bashrc,*.patch,...}</dt> 320<dt>matches any of <tt class="docutils literal">*.sh</tt>, <tt class="docutils literal">*.bashrc</tt>, <tt class="docutils literal">*.patch</tt>, ...</dt>
329<dd><p class="first last">=&gt; EXEC, stop.</p> 321<dd><p class="first last">=&gt; EXEC, stop.</p>
330</dd> 322</dd>
331</dl> 323</dl>
332</li> 324</li>
333<li><dl class="first docutils"> 325<li><dl class="first docutils">
334<dt>matches {metadata/cache/<em>,profiles/,package.</em>,use.mask*,...}</dt> 326<dt>matches any of <tt class="docutils literal">metadata/cache/*</tt>, <tt class="docutils literal">profiles/</tt>, <tt class="docutils literal">package.*</tt>, <tt class="docutils literal">use.mask*</tt>, ...</dt>
335<dd><p class="first last">=&gt; DATA, stop.</p> 327<dd><p class="first last">=&gt; DATA, stop.</p>
336</dd> 328</dd>
337</dl> 329</dl>
338</li> 330</li>
339<li><dl class="first docutils"> 331<li><dl class="first docutils">
340<dt>matches {ChangeLog,metadata.xml,*.desc,...}</dt> 332<dt>matches any of <tt class="docutils literal">ChangeLog</tt>, <tt class="docutils literal">metadata.xml</tt>, <tt class="docutils literal">*.desc</tt>, ...</dt>
341<dd><p class="first last">=&gt; MISC, stop.</p> 333<dd><p class="first last">=&gt; MISC, stop.</p>
342</dd> 334</dd>
343</dl> 335</dl>
344</li> 336</li>
345<li><dl class="first docutils"> 337<li><dl class="first docutils">
346<dt>not matched by any other rule</dt> 338<dt>not matched by any other rule</dt>
347<dd><p class="first last">=&gt; UNKNOWN, stop.</p> 339<dd><p class="first last">=&gt; OTHER, stop.</p>
348</dd> 340</dd>
349</dl> 341</dl>
350</li> 342</li>
351</ol> 343</ol>
352<p>The logic behind 5, 6, 7 is ensuring that every item that by it's 344<p>The logic behind 5, 6, 7 is ensuring that every item that by it's
353presence or absense may be dangerous should always be treated strictly. 345presence or absence may be dangerous should always be treated strictly.
354(Consider epatch given a directory of patches ${FILESDIR}/${PV}/, where 346(Consider epatch given a directory of patches <tt class="docutils literal"><span class="pre">${FILESDIR}/${PV}/</span></tt>,
355it blindly includes them, or alternatively, the package.mask file or a 347where it blindly includes them, or alternatively, the package.mask file
356profile being altered/missing).</p> 348or a profile being altered/missing).</p>
349<p>The above lists of file patterns are not intended to be exhaustive,
350but merely demonstrative.</p>
357<p>Note: The AUX entries should only be generated if we are generating a 351<p>Note: The AUX entries should only be generated if we are generating a
358compatible Manifest that supports older versions of Portage. They should 352compatible Manifest that supports older versions of Portage. They should
359be generated along with the new type.</p> 353be generated along with the new type.</p>
360</div> 354</div>
361</div> 355</div>
362<div class="section" id="backwards-compatibility"> 356<div class="section" id="backwards-compatibility">
363<h1><a class="toc-backref" href="#id39">Backwards Compatibility</a></h1> 357<h1><a class="toc-backref" href="#id27">Backwards Compatibility</a></h1>
364<p>For generation of existing package Manifests, the AUX entries must 358<p>For generation of existing package Manifests, the AUX entries must
365continue to be present for the standard Portage deprecation cycle. 359continue to be present for the standard Portage deprecation cycle.
366The new entries may be included already in all Manifest files, as they 360The new entries may be included already in all Manifest files, as they
367will be ignored by older Portage versions. Over time, ECLASS, DATA, 361will be ignored by older Portage versions. Over time, ECLASS, DATA,
368EXEC, UNKNOWN may replace the existing AUX type.</p> 362EXEC, OTHER may replace the existing AUX type.</p>
369<p>The adoption of this proposal does also affect [GLEPxx+1] as part of 363<p>The adoption of this proposal does also affect [#GLEP58] as part of
370this GLEP series, however this GLEP was an offset of the research in 364this GLEP series, however this GLEP was an offset of the research in
371that GLEP.</p> 365that GLEP.</p>
372</div> 366</div>
373<div class="section" id="thanks-to"> 367<div class="section" id="thanks-to">
374<h1><a class="toc-backref" href="#id40">Thanks to</a></h1> 368<h1><a class="toc-backref" href="#id28">Thanks to</a></h1>
375<p>I'd like to thank the following people for input on this GLEP. 369<p>I'd like to thank the following people for input on this GLEP.
376- Marius Mauch (genone) &amp; Zac Medico (zmedico): Portage Manifest2</p> 370- Marius Mauch (genone) &amp; Zac Medico (zmedico): Portage Manifest2</p>
377</div> 371</div>
378<div class="section" id="references"> 372<div class="section" id="references">
379<h1><a class="toc-backref" href="#id41">References</a></h1> 373<h1><a class="toc-backref" href="#id29">References</a></h1>
380<table class="docutils footnote" frame="void" id="glep44" rules="none"> 374<table class="docutils footnote" frame="void" id="glep44" rules="none">
381<colgroup><col class="label" /><col /></colgroup> 375<colgroup><col class="label" /><col /></colgroup>
382<tbody valign="top"> 376<tbody valign="top">
383<tr><td class="label">[1]</td><td>Mauch, M. (2005) GLEP44 - Manifest2 format. 377<tr><td class="label">[1]</td><td>Mauch, M. (2005) GLEP44 - Manifest2 format.
384<a class="reference external" href="http://www.gentoo.org/proj/en/glep/glep-0044.html">http://www.gentoo.org/proj/en/glep/glep-0044.html</a></td></tr> 378<a class="reference external" href="http://www.gentoo.org/proj/en/glep/glep-0044.html">http://www.gentoo.org/proj/en/glep/glep-0044.html</a></td></tr>
385</tbody> 379</tbody>
386</table> 380</table>
387</div> 381</div>
388<div class="section" id="copyright"> 382<div class="section" id="copyright">
389<h1><a class="toc-backref" href="#id42">Copyright</a></h1> 383<h1><a class="toc-backref" href="#id30">Copyright</a></h1>
390<p>Copyright (c) 2007 by Robin Hugh Johnson. This material may be 384<p>Copyright (c) 2007-2010 by Robin Hugh Johnson. This material may be
391distributed only subject to the terms and conditions set forth in the 385distributed only subject to the terms and conditions set forth in the
392Open Publication License, v1.0.</p> 386Open Publication License, v1.0.</p>
393<p>vim: tw=72 ts=2 expandtab:</p> 387<p>vim: tw=72 ts=2 expandtab:</p>
394</div> 388</div>
395 389
396</div> 390</div>
397<div class="footer"> 391<div class="footer">
398<hr class="footer" /> 392<hr class="footer" />
399<a class="reference external" href="glep-0060.txt">View document source</a>. 393<a class="reference external" href="glep-0060.txt">View document source</a>.
400Generated on: 2008-10-22 18:02 UTC. 394Generated on: 2010-01-31 07:57 UTC.
401Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 395Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
402 396
403</div> 397</div>
404</body> 398</body>
405</html> 399</html>
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.7
  ViewVC Help
Powered by ViewVC 1.1.13