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

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

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

Revision 1.3 Revision 1.4
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 4
5<head> 5<head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
8 <title>GLEP 56 -- USE flag descriptions in metadata</title> 8 <title>GLEP 56 -- USE flag descriptions in metadata</title>
9 <style type="text/css"> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" /></head>
10
11/*
12:Author: David Goodger
13:Contact: goodger@users.sourceforge.net
14:date: $Date: 2008/07/10 22:14:40 $
15:version: $Revision: 1.3 $
16:copyright: This stylesheet has been placed in the public domain.
17
18Default cascading style sheet for the PEP HTML output of Docutils.
19*/
20
21.first {
22 margin-top: 0 }
23
24.last {
25 margin-bottom: 0 }
26
27.navigation {
28 width: 100% ;
29 background: #cc99ff ;
30 margin-top: 0px ;
31 margin-bottom: 0px }
32
33.navigation .navicon {
34 width: 150px ;
35 height: 35px }
36
37.navigation .textlinks {
38 padding-left: 1em ;
39 text-align: left }
40
41.navigation td, .navigation th {
42 padding-left: 0em ;
43 padding-right: 0em ;
44 vertical-align: middle }
45
46.rfc2822 {
47 margin-top: 0.5em ;
48 margin-left: 0.5em ;
49 margin-right: 0.5em ;
50 margin-bottom: 0em }
51
52.rfc2822 td {
53 text-align: left }
54
55.rfc2822 th.field-name {
56 text-align: right ;
57 font-family: sans-serif ;
58 padding-right: 0.5em ;
59 font-weight: bold ;
60 margin-bottom: 0em }
61
62a.toc-backref {
63 text-decoration: none ;
64 color: black }
65
66body {
67 margin: 0px ;
68 margin-bottom: 1em ;
69 padding: 0px }
70
71dd {
72 margin-bottom: 0.5em }
73
74div.section {
75 margin-left: 1em ;
76 margin-right: 1em ;
77 margin-bottom: 1.5em }
78
79div.section div.section {
80 margin-left: 0em ;
81 margin-right: 0em ;
82 margin-top: 1.5em }
83
84div.abstract {
85 margin: 2em 5em }
86
87div.abstract p.topic-title {
88 font-weight: bold ;
89 text-align: center }
90
91div.attention, div.caution, div.danger, div.error, div.hint,
92div.important, div.note, div.tip, div.warning {
93 margin: 2em ;
94 border: medium outset ;
95 padding: 1em }
96
97div.attention p.admonition-title, div.caution p.admonition-title,
98div.danger p.admonition-title, div.error p.admonition-title,
99div.warning p.admonition-title {
100 color: red ;
101 font-weight: bold ;
102 font-family: sans-serif }
103
104div.hint p.admonition-title, div.important p.admonition-title,
105div.note p.admonition-title, div.tip p.admonition-title {
106 font-weight: bold ;
107 font-family: sans-serif }
108
109div.figure {
110 margin-left: 2em }
111
112div.footer, div.header {
113 font-size: smaller }
114
115div.footer {
116 margin-left: 1em ;
117 margin-right: 1em }
118
119div.system-messages {
120 margin: 5em }
121
122div.system-messages h1 {
123 color: red }
124
125div.system-message {
126 border: medium outset ;
127 padding: 1em }
128
129div.system-message p.system-message-title {
130 color: red ;
131 font-weight: bold }
132
133div.topic {
134 margin: 2em }
135
136h1 {
137 font-family: sans-serif ;
138 font-size: large }
139
140h2 {
141 font-family: sans-serif ;
142 font-size: medium }
143
144h3 {
145 font-family: sans-serif ;
146 font-size: small }
147
148h4 {
149 font-family: sans-serif ;
150 font-style: italic ;
151 font-size: small }
152
153h5 {
154 font-family: sans-serif;
155 font-size: x-small }
156
157h6 {
158 font-family: sans-serif;
159 font-style: italic ;
160 font-size: x-small }
161
162.section hr {
163 width: 75% }
164
165ol.simple, ul.simple {
166 margin-bottom: 1em }
167
168ol.arabic {
169 list-style: decimal }
170
171ol.loweralpha {
172 list-style: lower-alpha }
173
174ol.upperalpha {
175 list-style: upper-alpha }
176
177ol.lowerroman {
178 list-style: lower-roman }
179
180ol.upperroman {
181 list-style: upper-roman }
182
183p.caption {
184 font-style: italic }
185
186p.credits {
187 font-style: italic ;
188 font-size: smaller }
189
190p.label {
191 white-space: nowrap }
192
193p.topic-title {
194 font-family: sans-serif ;
195 font-weight: bold }
196
197pre.line-block {
198 font-family: serif ;
199 font-size: 100% }
200
201pre.literal-block, pre.doctest-block {
202 margin-left: 2em ;
203 margin-right: 2em ;
204 background-color: #eeeeee }
205
206span.classifier {
207 font-family: sans-serif ;
208 font-style: oblique }
209
210span.classifier-delimiter {
211 font-family: sans-serif ;
212 font-weight: bold }
213
214span.interpreted {
215 font-family: sans-serif }
216
217span.option-argument {
218 font-style: italic }
219
220span.pre {
221 white-space: pre }
222
223span.problematic {
224 color: red }
225
226table {
227 margin-top: 0.5em ;
228 margin-bottom: 0.5em }
229
230td, th {
231 padding-left: 0.5em ;
232 padding-right: 0.5em ;
233 vertical-align: top }
234
235td.num {
236 text-align: right }
237
238th.field-name {
239 font-weight: bold ;
240 text-align: left ;
241 white-space: nowrap }
242
243h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
244 font-size: 100% }
245
246tt {
247 background-color: #eeeeee }
248
249ul.auto-toc {
250 list-style-type: none }
251
252</style>
253</head>
254<body bgcolor="white"> 10<body bgcolor="white">
255<table class="navigation" cellpadding="0" cellspacing="0" 11<table class="navigation" cellpadding="0" cellspacing="0"
256 width="100%" border="0"> 12 width="100%" border="0">
257<tr><td class="navicon" width="150" height="35"> 13<tr><td class="navicon" width="150" height="35">
258<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 14<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
269<tbody valign="top"> 25<tbody valign="top">
270<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">56</td> 26<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">56</td>
271</tr> 27</tr>
272<tr class="field"><th class="field-name">Title:</th><td class="field-body">USE flag descriptions in metadata</td> 28<tr class="field"><th class="field-name">Title:</th><td class="field-body">USE flag descriptions in metadata</td>
273</tr> 29</tr>
274<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td> 30<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
275</tr> 31</tr>
276<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-0056.txt?cvsroot=gentoo">2008/07/10 22:13:45</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-0056.txt?cvsroot=gentoo">2008/09/02 20:37:40</a></td>
277</tr> 33</tr>
278<tr class="field"><th class="field-name">Author:</th><td class="field-body">Doug Goldstein &lt;cardoe&#32;&#97;t&#32;gentoo.org&gt;</td> 34<tr class="field"><th class="field-name">Author:</th><td class="field-body">Doug Goldstein &lt;cardoe&#32;&#97;t&#32;gentoo.org&gt;</td>
279</tr> 35</tr>
280<tr class="field"><th class="field-name">Status:</th><td class="field-body">Accepted</td> 36<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
281</tr> 37</tr>
282<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 38<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
283</tr> 39</tr>
284<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> 40<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="glep-0002.html">text/x-rst</a></td>
285</tr> 41</tr>
286<tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Jun-2008</td> 42<tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Jun-2008</td>
287</tr> 43</tr>
288<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">05-June-2008, 13-Jun-2008</td> 44<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">05-June-2008, 13-Jun-2008</td>
289</tr> 45</tr>
290</tbody> 46</tbody>
291</table> 47</table>
292<hr /> 48<hr />
293<div class="contents topic"> 49<div class="contents topic" id="contents">
294<p class="topic-title first"><a id="contents" name="contents">Contents</a></p> 50<p class="topic-title first">Contents</p>
295<ul class="simple"> 51<ul class="simple">
296<li><a class="reference" href="#abstract" id="id12" name="id12">Abstract</a></li> 52<li><a class="reference internal" href="#abstract" id="id12">Abstract</a></li>
297<li><a class="reference" href="#motivation" id="id13" name="id13">Motivation</a></li> 53<li><a class="reference internal" href="#motivation" id="id13">Motivation</a></li>
298<li><a class="reference" href="#specification" id="id14" name="id14">Specification</a></li> 54<li><a class="reference internal" href="#specification" id="id14">Specification</a></li>
299<li><a class="reference" href="#credits" id="id15" name="id15">Credits</a></li> 55<li><a class="reference internal" href="#credits" id="id15">Credits</a></li>
300<li><a class="reference" href="#references" id="id16" name="id16">References</a></li> 56<li><a class="reference internal" href="#references" id="id16">References</a></li>
301<li><a class="reference" href="#backwards-compatibility" id="id17" name="id17">Backwards Compatibility</a></li> 57<li><a class="reference internal" href="#backwards-compatibility" id="id17">Backwards Compatibility</a></li>
302<li><a class="reference" href="#copyright" id="id18" name="id18">Copyright</a></li> 58<li><a class="reference internal" href="#copyright" id="id18">Copyright</a></li>
303</ul> 59</ul>
304</div> 60</div>
305<div class="section"> 61<div class="section" id="abstract">
306<h1><a class="toc-backref" href="#id12" id="abstract" name="abstract">Abstract</a></h1> 62<h1><a class="toc-backref" href="#id12">Abstract</a></h1>
307<p>This GLEP proposes to add per-package USE flag descriptions to each package's 63<p>This GLEP proposes to add per-package USE flag descriptions to each package's
308metadata.</p> 64metadata.</p>
309</div> 65</div>
310<div class="section"> 66<div class="section" id="motivation">
311<h1><a class="toc-backref" href="#id13" id="motivation" name="motivation">Motivation</a></h1> 67<h1><a class="toc-backref" href="#id13">Motivation</a></h1>
312<p>Gives Gentoo users the ability to better identify how USE flags affect their 68<p>Gives Gentoo users the ability to better identify how USE flags affect their
313installations of a given package. For example, many global USE flags have very 69installations of a given package. For example, many global USE flags have very
314generic descriptions but no specifics on how it affects a certain package. 70generic descriptions but no specifics on how it affects a certain package.
315Specifically speaking, an example would be net-print/cups and the 'jpeg' USE 71Specifically speaking, an example would be net-print/cups and the 'jpeg' USE
316flag. Does this flag mean you won't be able to print jpeg files? You can print 72flag. Does this flag mean you won't be able to print jpeg files? You can print
317them directly? It's interface won't use jpeg files.</p> 73them directly? It's interface won't use jpeg files.</p>
318<blockquote> 74<blockquote>
319<ul class="simple"> 75<ul class="simple">
320<li>Motivator References: <a class="footnote-reference" href="#motivators1" id="id1" name="id1">[6]</a>, <a class="footnote-reference" href="#motivators2" id="id2" name="id2">[7]</a>, <a class="footnote-reference" href="#motivators3" id="id3" name="id3">[8]</a>, 76<li>Motivator References: <a class="footnote-reference" href="#motivators1" id="id1">[6]</a>, <a class="footnote-reference" href="#motivators2" id="id2">[7]</a>, <a class="footnote-reference" href="#motivators3" id="id3">[8]</a>,
321and <a class="footnote-reference" href="#motivators4" id="id4" name="id4">[9]</a></li> 77and <a class="footnote-reference" href="#motivators4" id="id4">[9]</a></li>
322</ul> 78</ul>
323</blockquote> 79</blockquote>
324</div> 80</div>
325<div class="section"> 81<div class="section" id="specification">
326<h1><a class="toc-backref" href="#id14" id="specification" name="specification">Specification</a></h1> 82<h1><a class="toc-backref" href="#id14">Specification</a></h1>
327<p>This GLEP proposes the addition of <tt class="docutils literal"><span class="pre">&lt;use&gt;</span></tt> XML tag that is only allowed to 83<p>This GLEP proposes the addition of <tt class="docutils literal">&lt;use&gt;</tt> XML tag that is only allowed to
328appear inside of a <tt class="docutils literal"><span class="pre">&lt;pkgmetadata&gt;</span></tt> XML tag.</p> 84appear inside of a <tt class="docutils literal">&lt;pkgmetadata&gt;</tt> XML tag.</p>
329<blockquote> 85<blockquote>
330<ul> 86<ul>
331<li><p class="first">Inside the <tt class="docutils literal"><span class="pre">&lt;use&gt;</span></tt> XML tag, the <tt class="docutils literal"><span class="pre">&lt;flag&gt;</span></tt> XML tag is allowed to appear 87<li><p class="first">Inside the <tt class="docutils literal">&lt;use&gt;</tt> XML tag, the <tt class="docutils literal">&lt;flag&gt;</tt> XML tag is allowed to appear
332once per USE flag as specified by the <tt class="docutils literal"><span class="pre">'name'</span></tt> attribute with the 88once per USE flag as specified by the <tt class="docutils literal">'name'</tt> attribute with the
333following exception:</p> 89following exception:</p>
334<ul class="simple"> 90<ul class="simple">
335<li>The <tt class="docutils literal"><span class="pre">'restrict'</span></tt> atttribute can limit to specific versions of the 91<li>The <tt class="docutils literal">'restrict'</tt> atttribute can limit to specific versions of the
336package, where the attribute value must be a valid CPV as defined by the 92package, where the attribute value must be a valid CPV as defined by the
337<cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id5" name="id5">[4]</a>. This follows the current 93<cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id5">[4]</a>. This follows the current
338behavior of the <tt class="docutils literal"><span class="pre">'restrict'</span></tt> attribute in metadata.xml.<ul> 94behavior of the <tt class="docutils literal">'restrict'</tt> attribute in metadata.xml.<ul>
339<li>e.g. A USE flag may have one behavior for version 0.1 of a package, 95<li>e.g. A USE flag may have one behavior for version 0.1 of a package,
340while version 0.2, the USE flag may differ slightly.</li> 96while version 0.2, the USE flag may differ slightly.</li>
341</ul> 97</ul>
342</li> 98</li>
343</ul> 99</ul>
344</li> 100</li>
345<li><p class="first">Each <tt class="docutils literal"><span class="pre">&lt;flag&gt;</span></tt> XML tag requires a 'name' attribute which is the full USE 101<li><p class="first">Each <tt class="docutils literal">&lt;flag&gt;</tt> XML tag requires a 'name' attribute which is the full USE
346flag name as it would appear in the IUSE section of the ebuild.</p> 102flag name as it would appear in the IUSE section of the ebuild.</p>
347<blockquote> 103<blockquote>
348<ul class="simple"> 104<ul class="simple">
349<li>e.g. &quot;video_cards_i810&quot; or &quot;alsa&quot;</li> 105<li>e.g. &quot;video_cards_i810&quot; or &quot;alsa&quot;</li>
350</ul> 106</ul>
351</blockquote> 107</blockquote>
352</li> 108</li>
353<li><p class="first">Each <tt class="docutils literal"><span class="pre">&lt;flag&gt;</span></tt> XML tag allows 0 or more nested <tt class="docutils literal"><span class="pre">&lt;pkg&gt;</span></tt> XML tags whose 109<li><p class="first">Each <tt class="docutils literal">&lt;flag&gt;</tt> XML tag allows 0 or more nested <tt class="docutils literal">&lt;pkg&gt;</tt> XML tags whose
354character data is a valid CP or CPV as defined by the 110character data is a valid CP or CPV as defined by the
355<cite>Gentoo Development Manual - Ebuild File Format</cite> <a class="footnote-reference" href="#devmanual" id="id6" name="id6">[5]</a>.</p> 111<cite>Gentoo Development Manual - Ebuild File Format</cite> <a class="footnote-reference" href="#devmanual" id="id6">[5]</a>.</p>
356</li> 112</li>
357<li><p class="first">Each <tt class="docutils literal"><span class="pre">&lt;flag&gt;</span></tt> XML tag allows 0 or more nested <tt class="docutils literal"><span class="pre">&lt;cat&gt;</span></tt> XML tags whose 113<li><p class="first">Each <tt class="docutils literal">&lt;flag&gt;</tt> XML tag allows 0 or more nested <tt class="docutils literal">&lt;cat&gt;</tt> XML tags whose
358character data is a valid category.</p> 114character data is a valid category.</p>
359</li> 115</li>
360<li><p class="first">The <tt class="docutils literal"><span class="pre">&lt;use&gt;</span></tt> XML tag may appear multiple times inside of the 116<li><p class="first">The <tt class="docutils literal">&lt;use&gt;</tt> XML tag may appear multiple times inside of the
361<tt class="docutils literal"><span class="pre">&lt;pkgmetadata&gt;</span></tt> XML tag if and only if it contains a different <tt class="docutils literal"><span class="pre">'lang'</span></tt> 117<tt class="docutils literal">&lt;pkgmetadata&gt;</tt> XML tag if and only if it contains a different <tt class="docutils literal">'lang'</tt>
362attribute value.</p> 118attribute value.</p>
363<ul class="simple"> 119<ul class="simple">
364<li>The <tt class="docutils literal"><span class="pre">lang</span></tt> attribute follows the documented <tt class="docutils literal"><span class="pre">lang</span></tt> attribute in the 120<li>The <tt class="docutils literal">lang</tt> attribute follows the documented <tt class="docutils literal">lang</tt> attribute in the
365<cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id7" name="id7">[4]</a>.</li> 121<cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id7">[4]</a>.</li>
366</ul> 122</ul>
367</li> 123</li>
368</ul> 124</ul>
369</blockquote> 125</blockquote>
370<p>Documentation for the <cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id8" name="id8">[4]</a> and the 126<p>Documentation for the <cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id8">[4]</a> and the
371metadata.dtd can be found in Gentoo's Bugzilla <a class="footnote-reference" href="#use-flag-metadata-bug" id="id9" name="id9">[1]</a> 127metadata.dtd can be found in Gentoo's Bugzilla <a class="footnote-reference" href="#use-flag-metadata-bug" id="id9">[1]</a>
372bug #199788.</p> 128bug #199788.</p>
373<p>The following are two concrete examples in tree, <a class="footnote-reference" href="#use-flag-metadata-example1" id="id10" name="id10">[2]</a> 129<p>The following are two concrete examples in tree, <a class="footnote-reference" href="#use-flag-metadata-example1" id="id10">[2]</a>
374and <a class="footnote-reference" href="#use-flag-metadata-example2" id="id11" name="id11">[3]</a>.</p> 130and <a class="footnote-reference" href="#use-flag-metadata-example2" id="id11">[3]</a>.</p>
375<p>And the following is an embedded example and not from a real package:</p> 131<p>And the following is an embedded example and not from a real package:</p>
376<pre class="literal-block"> 132<pre class="literal-block">
377&lt;use&gt; 133&lt;use&gt;
378 &lt;flag name='acpi'&gt;Enables HAL to attempt to read from 134 &lt;flag name='acpi'&gt;Enables HAL to attempt to read from
379 /proc/acpi/event, if unavailable, HAL will read events from 135 /proc/acpi/event, if unavailable, HAL will read events from
385 &lt;flag name='spell'&gt;Enables spell checking capability using 141 &lt;flag name='spell'&gt;Enables spell checking capability using
386 dictionaries found in &lt;cat&gt;app-dict&lt;/cat&gt;&lt;/flag&gt; 142 dictionaries found in &lt;cat&gt;app-dict&lt;/cat&gt;&lt;/flag&gt;
387&lt;/use&gt; 143&lt;/use&gt;
388</pre> 144</pre>
389</div> 145</div>
390<div class="section"> 146<div class="section" id="credits">
391<h1><a class="toc-backref" href="#id15" id="credits" name="credits">Credits</a></h1> 147<h1><a class="toc-backref" href="#id15">Credits</a></h1>
392<p>Thanks to the following persons for their input on or related to this GLEP 148<p>Thanks to the following persons for their input on or related to this GLEP
393(even though they might not have known it): 149(even though they might not have known it):
394Diego Pettenò (flameeyes), Alec Warner (antarus), Joshua Nichols (nichoj), 150Diego Pettenò (flameeyes), Alec Warner (antarus), Joshua Nichols (nichoj),
395Steve Dibb (beandog), and Tiziano Müller (dev-zero)</p> 151Steve Dibb (beandog), and Tiziano Müller (dev-zero)</p>
396</div> 152</div>
397<div class="section"> 153<div class="section" id="references">
398<h1><a class="toc-backref" href="#id16" id="references" name="references">References</a></h1> 154<h1><a class="toc-backref" href="#id16">References</a></h1>
399<table class="docutils footnote" frame="void" id="use-flag-metadata-bug" rules="none"> 155<table class="docutils footnote" frame="void" id="use-flag-metadata-bug" rules="none">
400<colgroup><col class="label" /><col /></colgroup> 156<colgroup><col class="label" /><col /></colgroup>
401<tbody valign="top"> 157<tbody valign="top">
402<tr><td class="label"><a class="fn-backref" href="#id9" name="use-flag-metadata-bug">[1]</a></td><td><a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=199788">http://bugs.gentoo.org/show_bug.cgi?id=199788</a></td></tr> 158<tr><td class="label"><a class="fn-backref" href="#id9">[1]</a></td><td><a class="reference external" href="http://bugs.gentoo.org/show_bug.cgi?id=199788">http://bugs.gentoo.org/show_bug.cgi?id=199788</a></td></tr>
403</tbody> 159</tbody>
404</table> 160</table>
405<table class="docutils footnote" frame="void" id="use-flag-metadata-example1" rules="none"> 161<table class="docutils footnote" frame="void" id="use-flag-metadata-example1" rules="none">
406<colgroup><col class="label" /><col /></colgroup> 162<colgroup><col class="label" /><col /></colgroup>
407<tbody valign="top"> 163<tbody valign="top">
408<tr><td class="label"><a class="fn-backref" href="#id10" name="use-flag-metadata-example1">[2]</a></td><td><a class="reference" href="http://sources.gentoo.org/viewcvs.py/gentoo-x86/sys-apps/hal/metadata.xml?view=markup">http://sources.gentoo.org/viewcvs.py/gentoo-x86/sys-apps/hal/metadata.xml?view=markup</a></td></tr> 164<tr><td class="label"><a class="fn-backref" href="#id10">[2]</a></td><td><a class="reference external" href="http://sources.gentoo.org/viewcvs.py/gentoo-x86/sys-apps/hal/metadata.xml?view=markup">http://sources.gentoo.org/viewcvs.py/gentoo-x86/sys-apps/hal/metadata.xml?view=markup</a></td></tr>
409</tbody> 165</tbody>
410</table> 166</table>
411<table class="docutils footnote" frame="void" id="use-flag-metadata-example2" rules="none"> 167<table class="docutils footnote" frame="void" id="use-flag-metadata-example2" rules="none">
412<colgroup><col class="label" /><col /></colgroup> 168<colgroup><col class="label" /><col /></colgroup>
413<tbody valign="top"> 169<tbody valign="top">
414<tr><td class="label"><a class="fn-backref" href="#id11" name="use-flag-metadata-example2">[3]</a></td><td><a class="reference" href="http://sources.gentoo.org/viewcvs.py/gentoo-x86/media-tv/mythtv/metadata.xml?view=markup">http://sources.gentoo.org/viewcvs.py/gentoo-x86/media-tv/mythtv/metadata.xml?view=markup</a></td></tr> 170<tr><td class="label"><a class="fn-backref" href="#id11">[3]</a></td><td><a class="reference external" href="http://sources.gentoo.org/viewcvs.py/gentoo-x86/media-tv/mythtv/metadata.xml?view=markup">http://sources.gentoo.org/viewcvs.py/gentoo-x86/media-tv/mythtv/metadata.xml?view=markup</a></td></tr>
415</tbody> 171</tbody>
416</table> 172</table>
417<table class="docutils footnote" frame="void" id="devhandbook" rules="none"> 173<table class="docutils footnote" frame="void" id="devhandbook" rules="none">
418<colgroup><col class="label" /><col /></colgroup> 174<colgroup><col class="label" /><col /></colgroup>
419<tbody valign="top"> 175<tbody valign="top">
420<tr><td class="label"><a name="devhandbook">[4]</a></td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id7">2</a>, <a class="fn-backref" href="#id8">3</a>)</em> <a class="reference" href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4</a></td></tr> 176<tr><td class="label">[4]</td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id7">2</a>, <a class="fn-backref" href="#id8">3</a>)</em> <a class="reference external" href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4</a></td></tr>
421</tbody> 177</tbody>
422</table> 178</table>
423<table class="docutils footnote" frame="void" id="devmanual" rules="none"> 179<table class="docutils footnote" frame="void" id="devmanual" rules="none">
424<colgroup><col class="label" /><col /></colgroup> 180<colgroup><col class="label" /><col /></colgroup>
425<tbody valign="top"> 181<tbody valign="top">
426<tr><td class="label"><a class="fn-backref" href="#id6" name="devmanual">[5]</a></td><td><a class="reference" href="http://devmanual.gentoo.org/ebuild-writing/file-format/index.html">http://devmanual.gentoo.org/ebuild-writing/file-format/index.html</a></td></tr> 182<tr><td class="label"><a class="fn-backref" href="#id6">[5]</a></td><td><a class="reference external" href="http://devmanual.gentoo.org/ebuild-writing/file-format/index.html">http://devmanual.gentoo.org/ebuild-writing/file-format/index.html</a></td></tr>
427</tbody> 183</tbody>
428</table> 184</table>
429<table class="docutils footnote" frame="void" id="motivators1" rules="none"> 185<table class="docutils footnote" frame="void" id="motivators1" rules="none">
430<colgroup><col class="label" /><col /></colgroup> 186<colgroup><col class="label" /><col /></colgroup>
431<tbody valign="top"> 187<tbody valign="top">
432<tr><td class="label"><a class="fn-backref" href="#id1" name="motivators1">[6]</a></td><td><a class="reference" href="http://blog.flameeyes.eu/articles/2007/11/19/lets-actually-get-some-metadata">http://blog.flameeyes.eu/articles/2007/11/19/lets-actually-get-some-metadata</a></td></tr> 188<tr><td class="label"><a class="fn-backref" href="#id1">[6]</a></td><td><a class="reference external" href="http://blog.flameeyes.eu/articles/2007/11/19/lets-actually-get-some-metadata">http://blog.flameeyes.eu/articles/2007/11/19/lets-actually-get-some-metadata</a></td></tr>
433</tbody> 189</tbody>
434</table> 190</table>
435<table class="docutils footnote" frame="void" id="motivators2" rules="none"> 191<table class="docutils footnote" frame="void" id="motivators2" rules="none">
436<colgroup><col class="label" /><col /></colgroup> 192<colgroup><col class="label" /><col /></colgroup>
437<tbody valign="top"> 193<tbody valign="top">
438<tr><td class="label"><a class="fn-backref" href="#id2" name="motivators2">[7]</a></td><td><a class="reference" href="http://blog.cardoe.com/archives/2007/11/19/use-flag-metadata/">http://blog.cardoe.com/archives/2007/11/19/use-flag-metadata/</a></td></tr> 194<tr><td class="label"><a class="fn-backref" href="#id2">[7]</a></td><td><a class="reference external" href="http://blog.cardoe.com/archives/2007/11/19/use-flag-metadata/">http://blog.cardoe.com/archives/2007/11/19/use-flag-metadata/</a></td></tr>
439</tbody> 195</tbody>
440</table> 196</table>
441<table class="docutils footnote" frame="void" id="motivators3" rules="none"> 197<table class="docutils footnote" frame="void" id="motivators3" rules="none">
442<colgroup><col class="label" /><col /></colgroup> 198<colgroup><col class="label" /><col /></colgroup>
443<tbody valign="top"> 199<tbody valign="top">
444<tr><td class="label"><a class="fn-backref" href="#id3" name="motivators3">[8]</a></td><td><a class="reference" href="http://blog.cardoe.com/archives/2007/11/23/metadataxml-updates-examples/">http://blog.cardoe.com/archives/2007/11/23/metadataxml-updates-examples/</a></td></tr> 200<tr><td class="label"><a class="fn-backref" href="#id3">[8]</a></td><td><a class="reference external" href="http://blog.cardoe.com/archives/2007/11/23/metadataxml-updates-examples/">http://blog.cardoe.com/archives/2007/11/23/metadataxml-updates-examples/</a></td></tr>
445</tbody> 201</tbody>
446</table> 202</table>
447<table class="docutils footnote" frame="void" id="motivators4" rules="none"> 203<table class="docutils footnote" frame="void" id="motivators4" rules="none">
448<colgroup><col class="label" /><col /></colgroup> 204<colgroup><col class="label" /><col /></colgroup>
449<tbody valign="top"> 205<tbody valign="top">
450<tr><td class="label"><a class="fn-backref" href="#id4" name="motivators4">[9]</a></td><td><a class="reference" href="http://technicalpickles.com/posts/pidgin-idle-time">http://technicalpickles.com/posts/pidgin-idle-time</a></td></tr> 206<tr><td class="label"><a class="fn-backref" href="#id4">[9]</a></td><td><a class="reference external" href="http://technicalpickles.com/posts/pidgin-idle-time">http://technicalpickles.com/posts/pidgin-idle-time</a></td></tr>
451</tbody> 207</tbody>
452</table> 208</table>
453</div> 209</div>
454<div class="section"> 210<div class="section" id="backwards-compatibility">
455<h1><a class="toc-backref" href="#id17" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> 211<h1><a class="toc-backref" href="#id17">Backwards Compatibility</a></h1>
456<p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files. Information in 212<p>No changes are necessary to existing <tt class="docutils literal">metadata.xml</tt> files. Information in
457the new tags is not mandatory. Tools that currently read <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> 213the new tags is not mandatory. Tools that currently read <tt class="docutils literal">metadata.xml</tt>
458files may break if written poorly, while well written tools should just ignore 214files may break if written poorly, while well written tools should just ignore
459the additional elements. Tools which are capable of handling the new tags 215the additional elements. Tools which are capable of handling the new tags
460should prefer their data over <tt class="docutils literal"><span class="pre">use.desc</span></tt> and <tt class="docutils literal"><span class="pre">use.local.desc</span></tt>.</p> 216should prefer their data over <tt class="docutils literal">use.desc</tt> and <tt class="docutils literal">use.local.desc</tt>.</p>
461<p>USE flags still must be defined in <tt class="docutils literal"><span class="pre">use.desc</span></tt> or <tt class="docutils literal"><span class="pre">use.local.desc</span></tt>. If the 217<p>USE flags still must be defined in <tt class="docutils literal">use.desc</tt> or <tt class="docutils literal">use.local.desc</tt>. If the
462USE flag is not found in either <tt class="docutils literal"><span class="pre">use.desc</span></tt> or <tt class="docutils literal"><span class="pre">use.local.desc</span></tt>, the 218USE flag is not found in either <tt class="docutils literal">use.desc</tt> or <tt class="docutils literal">use.local.desc</tt>, the
463information contained within the new tags in <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> must be ignored 219information contained within the new tags in <tt class="docutils literal">metadata.xml</tt> must be ignored
464and QA tools should warn as they currently do.</p> 220and QA tools should warn as they currently do.</p>
465<p>Once this GLEP is approved, the Gentoo Infrastructure Team will work to remove 221<p>Once this GLEP is approved, the Gentoo Infrastructure Team will work to remove
466the <tt class="docutils literal"><span class="pre">use.local.desc</span></tt> file from CVS and it will be auto-generated for rsync. 222the <tt class="docutils literal">use.local.desc</tt> file from CVS and it will be auto-generated for rsync.
467This will ensure that backwards compatibility is not broken for users of 223This will ensure that backwards compatibility is not broken for users of
468non-CVS trees. At this time, QA tools will need to be updated to verify the 224non-CVS trees. At this time, QA tools will need to be updated to verify the
469contents of <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> containing the necessary tags which would appear 225contents of <tt class="docutils literal">metadata.xml</tt> containing the necessary tags which would appear
470in <tt class="docutils literal"><span class="pre">use.local.desc</span></tt>.</p> 226in <tt class="docutils literal">use.local.desc</tt>.</p>
471</div> 227</div>
472<div class="section"> 228<div class="section" id="copyright">
473<h1><a class="toc-backref" href="#id18" id="copyright" name="copyright">Copyright</a></h1> 229<h1><a class="toc-backref" href="#id18">Copyright</a></h1>
474<p>This document is placed into the public domain.</p> 230<p>This document is placed into the public domain.</p>
475<!-- vim: set ft=glep tw=72 : --> 231<!-- vim: set ft=glep tw=72 : -->
476</div> 232</div>
477 233
478</div> 234</div>
479<div class="footer"> 235<div class="footer">
480<hr class="footer" /> 236<hr class="footer" />
481<a class="reference" href="glep-0056.txt">View document source</a>. 237<a class="reference external" href="glep-0056.txt">View document source</a>.
482Generated on: 2008-07-10 22:14 UTC. 238Generated on: 2010-04-07 22:13 UTC.
483Generated 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. 239Generated 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.
484 240
485</div> 241</div>
486</body> 242</body>
487</html> 243</html>
488

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

  ViewVC Help
Powered by ViewVC 1.1.20