/[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.1 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 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" /></head>
10</head>
11<body bgcolor="white"> 10<body bgcolor="white">
12<table class="navigation" cellpadding="0" cellspacing="0" 11<table class="navigation" cellpadding="0" cellspacing="0"
13 width="100%" border="0"> 12 width="100%" border="0">
14<tr><td class="navicon" width="150" height="35"> 13<tr><td class="navicon" width="150" height="35">
15<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 14<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
26<tbody valign="top"> 25<tbody valign="top">
27<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>
28</tr> 27</tr>
29<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>
30</tr> 29</tr>
31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 30<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
32</tr> 31</tr>
33<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0056.txt?cvsroot=gentoo">2008/06/05 05:54:10</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>
34</tr> 33</tr>
35<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>
36</tr> 35</tr>
37<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">Final</td>
38</tr> 37</tr>
39<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>
40</tr> 39</tr>
41<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> 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>
42</tr> 41</tr>
43<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>
44</tr> 43</tr>
45<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">05-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>
46</tr> 45</tr>
47</tbody> 46</tbody>
48</table> 47</table>
49<hr /> 48<hr />
50<div class="contents topic"> 49<div class="contents topic" id="contents">
51<p class="topic-title first"><a id="contents" name="contents">Contents</a></p> 50<p class="topic-title first">Contents</p>
52<ul class="simple"> 51<ul class="simple">
53<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>
54<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>
55<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>
56<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>
57<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>
57<li><a class="reference internal" href="#backwards-compatibility" id="id17">Backwards Compatibility</a></li>
58<li><a class="reference" href="#copyright" id="id17" name="id17">Copyright</a></li> 58<li><a class="reference internal" href="#copyright" id="id18">Copyright</a></li>
59</ul> 59</ul>
60</div> 60</div>
61<div class="section"> 61<div class="section" id="abstract">
62<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>
63<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
64metadata.</p> 64metadata.</p>
65</div> 65</div>
66<div class="section"> 66<div class="section" id="motivation">
67<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>
68<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
69installations 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
70generic descriptions but no specifics on how it affects a certain package. 70generic descriptions but no specifics on how it affects a certain package.
71Specifically 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
72flag. 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
73them directly? It's interface won't use jpeg files.</p> 73them directly? It's interface won't use jpeg files.</p>
74<blockquote> 74<blockquote>
75<ul class="simple"> 75<ul class="simple">
76<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>,
77and <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>
78</ul> 78</ul>
79</blockquote> 79</blockquote>
80</div> 80</div>
81<div class="section"> 81<div class="section" id="specification">
82<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>
83<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
84appear 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>
85<blockquote> 85<blockquote>
86<ul> 86<ul>
87<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
88once 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
89following exception:</p> 89following exception:</p>
90<ul class="simple"> 90<ul class="simple">
91<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
92package, 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
93<cite>Package Manager Specification</cite> <a class="footnote-reference" href="#pms" id="id5" name="id5">[4]</a>. This follows the current behavior 93<cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id5">[4]</a>. This follows the current
94of 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>
95<li>The <tt class="docutils literal"><span class="pre">restrict</span></tt> attribute follows the documented <tt class="docutils literal"><span class="pre">restrict</span></tt>
96attribute in the <cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id6" name="id6">[5]</a>.</li>
97<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,
98while version 0.2, the USE flag may differ slightly.</li> 96while version 0.2, the USE flag may differ slightly.</li>
99</ul> 97</ul>
100</li> 98</li>
101</ul> 99</ul>
102</li> 100</li>
103<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
104flag 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>
105<blockquote> 103<blockquote>
106<ul class="simple"> 104<ul class="simple">
107<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>
108</ul> 106</ul>
109</blockquote> 107</blockquote>
110</li> 108</li>
111<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
112character data is a valid CP or CPV as defined by the 110character data is a valid CP or CPV as defined by the
113<cite>Package Manager Specification</cite> <a class="footnote-reference" href="#pms" id="id7" name="id7">[4]</a>.</p> 111<cite>Gentoo Development Manual - Ebuild File Format</cite> <a class="footnote-reference" href="#devmanual" id="id6">[5]</a>.</p>
114</li> 112</li>
115<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
116character data is a valid category.</p> 114character data is a valid category.</p>
117</li> 115</li>
118<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
119<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>
120attribute value.</p> 118attribute value.</p>
121<ul class="simple"> 119<ul class="simple">
122<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
123<cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id8" name="id8">[5]</a>.</li> 121<cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id7">[4]</a>.</li>
124<li>The default <tt class="docutils literal"><span class="pre">'lang'</span></tt> attribute value is &quot;C&quot;, which is equivilent to &quot;en&quot;.</li>
125</ul> 122</ul>
126</li> 123</li>
127</ul> 124</ul>
128</blockquote> 125</blockquote>
129<p>Documentation for the Developer Manual and the metadata.dtd can be found in 126<p>Documentation for the <cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id8">[4]</a> and the
130Gentoo's Bugzilla <a class="footnote-reference" href="#use-flag-metadata-bug" id="id9" name="id9">[1]</a> bug #199788.</p> 127metadata.dtd can be found in Gentoo's Bugzilla <a class="footnote-reference" href="#use-flag-metadata-bug" id="id9">[1]</a>
128bug #199788.</p>
131<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>
132and <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>
133<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>
134<pre class="literal-block"> 132<pre class="literal-block">
135&lt;use&gt; 133&lt;use&gt;
136 &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
137 /proc/acpi/event, if unavailable, HAL will read events from 135 /proc/acpi/event, if unavailable, HAL will read events from
143 &lt;flag name='spell'&gt;Enables spell checking capability using 141 &lt;flag name='spell'&gt;Enables spell checking capability using
144 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;
145&lt;/use&gt; 143&lt;/use&gt;
146</pre> 144</pre>
147</div> 145</div>
148<div class="section"> 146<div class="section" id="credits">
149<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>
150<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
151(even though they might not have known it): 149(even though they might not have known it):
152Diego Pettenò (flameeyes), Alec Warner (antarus), Joshua Nichols (nichoj), 150Diego Pettenò (flameeyes), Alec Warner (antarus), Joshua Nichols (nichoj),
153Steve Dibb (beandog), and Tiziano Müller (dev-zero)</p> 151Steve Dibb (beandog), and Tiziano Müller (dev-zero)</p>
154</div> 152</div>
155<div class="section"> 153<div class="section" id="references">
156<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>
157<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">
158<colgroup><col class="label" /><col /></colgroup> 156<colgroup><col class="label" /><col /></colgroup>
159<tbody valign="top"> 157<tbody valign="top">
160<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>
161</tbody> 159</tbody>
162</table> 160</table>
163<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">
164<colgroup><col class="label" /><col /></colgroup> 162<colgroup><col class="label" /><col /></colgroup>
165<tbody valign="top"> 163<tbody valign="top">
166<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>
167</tbody> 165</tbody>
168</table> 166</table>
169<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">
170<colgroup><col class="label" /><col /></colgroup> 168<colgroup><col class="label" /><col /></colgroup>
171<tbody valign="top"> 169<tbody valign="top">
172<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>
173</tbody>
174</table>
175<table class="docutils footnote" frame="void" id="pms" rules="none">
176<colgroup><col class="label" /><col /></colgroup>
177<tbody valign="top">
178<tr><td class="label"><a name="pms">[4]</a></td><td><em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference" href="http://git.overlays.gentoo.org/gitweb/?p=proj/pms.git;a=summary">http://git.overlays.gentoo.org/gitweb/?p=proj/pms.git;a=summary</a></td></tr>
179</tbody> 171</tbody>
180</table> 172</table>
181<table class="docutils footnote" frame="void" id="devhandbook" rules="none"> 173<table class="docutils footnote" frame="void" id="devhandbook" rules="none">
182<colgroup><col class="label" /><col /></colgroup> 174<colgroup><col class="label" /><col /></colgroup>
183<tbody valign="top"> 175<tbody valign="top">
184<tr><td class="label"><a name="devhandbook">[5]</a></td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id8">2</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>
177</tbody>
178</table>
179<table class="docutils footnote" frame="void" id="devmanual" rules="none">
180<colgroup><col class="label" /><col /></colgroup>
181<tbody valign="top">
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>
185</tbody> 183</tbody>
186</table> 184</table>
187<table class="docutils footnote" frame="void" id="motivators1" rules="none"> 185<table class="docutils footnote" frame="void" id="motivators1" rules="none">
188<colgroup><col class="label" /><col /></colgroup> 186<colgroup><col class="label" /><col /></colgroup>
189<tbody valign="top"> 187<tbody valign="top">
190<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>
191</tbody> 189</tbody>
192</table> 190</table>
193<table class="docutils footnote" frame="void" id="motivators2" rules="none"> 191<table class="docutils footnote" frame="void" id="motivators2" rules="none">
194<colgroup><col class="label" /><col /></colgroup> 192<colgroup><col class="label" /><col /></colgroup>
195<tbody valign="top"> 193<tbody valign="top">
196<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>
197</tbody> 195</tbody>
198</table> 196</table>
199<table class="docutils footnote" frame="void" id="motivators3" rules="none"> 197<table class="docutils footnote" frame="void" id="motivators3" rules="none">
200<colgroup><col class="label" /><col /></colgroup> 198<colgroup><col class="label" /><col /></colgroup>
201<tbody valign="top"> 199<tbody valign="top">
202<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>
203</tbody> 201</tbody>
204</table> 202</table>
205<table class="docutils footnote" frame="void" id="motivators4" rules="none"> 203<table class="docutils footnote" frame="void" id="motivators4" rules="none">
206<colgroup><col class="label" /><col /></colgroup> 204<colgroup><col class="label" /><col /></colgroup>
207<tbody valign="top"> 205<tbody valign="top">
208<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>
209</tbody> 207</tbody>
210</table> 208</table>
211</div> 209</div>
212<div class="section"> 210<div class="section" id="backwards-compatibility">
211<h1><a class="toc-backref" href="#id17">Backwards Compatibility</a></h1>
212<p>No changes are necessary to existing <tt class="docutils literal">metadata.xml</tt> files. Information in
213the new tags is not mandatory. Tools that currently read <tt class="docutils literal">metadata.xml</tt>
214files may break if written poorly, while well written tools should just ignore
215the additional elements. Tools which are capable of handling the new tags
216should prefer their data over <tt class="docutils literal">use.desc</tt> and <tt class="docutils literal">use.local.desc</tt>.</p>
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
218USE flag is not found in either <tt class="docutils literal">use.desc</tt> or <tt class="docutils literal">use.local.desc</tt>, the
219information contained within the new tags in <tt class="docutils literal">metadata.xml</tt> must be ignored
220and QA tools should warn as they currently do.</p>
221<p>Once this GLEP is approved, the Gentoo Infrastructure Team will work to remove
222the <tt class="docutils literal">use.local.desc</tt> file from CVS and it will be auto-generated for rsync.
223This will ensure that backwards compatibility is not broken for users of
224non-CVS trees. At this time, QA tools will need to be updated to verify the
225contents of <tt class="docutils literal">metadata.xml</tt> containing the necessary tags which would appear
226in <tt class="docutils literal">use.local.desc</tt>.</p>
227</div>
228<div class="section" id="copyright">
213<h1><a class="toc-backref" href="#id17" id="copyright" name="copyright">Copyright</a></h1> 229<h1><a class="toc-backref" href="#id18">Copyright</a></h1>
214<p>This document is placed into the public domain.</p> 230<p>This document is placed into the public domain.</p>
215<!-- vim: set ft=glep tw=72 : --> 231<!-- vim: set ft=glep tw=72 : -->
216</div> 232</div>
217 233
218</div> 234</div>
219<div class="footer"> 235<div class="footer">
220<hr class="footer" /> 236<hr class="footer" />
221<a class="reference" href="glep-0056.txt">View document source</a>. 237<a class="reference external" href="glep-0056.txt">View document source</a>.
222Generated on: 2008-06-05 05:54 UTC. 238Generated on: 2010-04-07 22:13 UTC.
223Generated 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.
224 240
225</div> 241</div>
226</body> 242</body>
227</html> 243</html>
228

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

  ViewVC Help
Powered by ViewVC 1.1.20