| … | |
… | |
| 26 | <tbody valign="top"> |
26 | <tbody valign="top"> |
| 27 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">56</td> |
27 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">56</td> |
| 28 | </tr> |
28 | </tr> |
| 29 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">USE flag descriptions in metadata</td> |
29 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">USE flag descriptions in metadata</td> |
| 30 | </tr> |
30 | </tr> |
| 31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> |
31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> |
| 32 | </tr> |
32 | </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> |
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/07/10 18:15:05</a></td> |
| 34 | </tr> |
34 | </tr> |
| 35 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Doug Goldstein <cardoe at gentoo.org></td> |
35 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Doug Goldstein <cardoe at gentoo.org></td> |
| 36 | </tr> |
36 | </tr> |
| 37 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
37 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
| 38 | </tr> |
38 | </tr> |
| … | |
… | |
| 40 | </tr> |
40 | </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> |
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> |
| 42 | </tr> |
42 | </tr> |
| 43 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Jun-2008</td> |
43 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Jun-2008</td> |
| 44 | </tr> |
44 | </tr> |
| 45 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">05-Jun-2008</td> |
45 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">13-Jun-2008</td> |
| 46 | </tr> |
46 | </tr> |
| 47 | </tbody> |
47 | </tbody> |
| 48 | </table> |
48 | </table> |
| 49 | <hr /> |
49 | <hr /> |
| 50 | <div class="contents topic"> |
50 | <div class="contents topic"> |
| 51 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
51 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
| 52 | <ul class="simple"> |
52 | <ul class="simple"> |
| 53 | <li><a class="reference" href="#abstract" id="id12" name="id12">Abstract</a></li> |
53 | <li><a class="reference" href="#abstract" id="id11" name="id11">Abstract</a></li> |
| 54 | <li><a class="reference" href="#motivation" id="id13" name="id13">Motivation</a></li> |
54 | <li><a class="reference" href="#motivation" id="id12" name="id12">Motivation</a></li> |
| 55 | <li><a class="reference" href="#specification" id="id14" name="id14">Specification</a></li> |
55 | <li><a class="reference" href="#specification" id="id13" name="id13">Specification</a></li> |
| 56 | <li><a class="reference" href="#credits" id="id15" name="id15">Credits</a></li> |
56 | <li><a class="reference" href="#credits" id="id14" name="id14">Credits</a></li> |
| 57 | <li><a class="reference" href="#references" id="id16" name="id16">References</a></li> |
57 | <li><a class="reference" href="#references" id="id15" name="id15">References</a></li> |
|
|
58 | <li><a class="reference" href="#backwards-compatibility" id="id16" name="id16">Backwards Compatibility</a></li> |
| 58 | <li><a class="reference" href="#copyright" id="id17" name="id17">Copyright</a></li> |
59 | <li><a class="reference" href="#copyright" id="id17" name="id17">Copyright</a></li> |
| 59 | </ul> |
60 | </ul> |
| 60 | </div> |
61 | </div> |
| 61 | <div class="section"> |
62 | <div class="section"> |
| 62 | <h1><a class="toc-backref" href="#id12" id="abstract" name="abstract">Abstract</a></h1> |
63 | <h1><a class="toc-backref" href="#id11" id="abstract" name="abstract">Abstract</a></h1> |
| 63 | <p>This GLEP proposes to add per-package USE flag descriptions to each package's |
64 | <p>This GLEP proposes to add per-package USE flag descriptions to each package's |
| 64 | metadata.</p> |
65 | metadata.</p> |
| 65 | </div> |
66 | </div> |
| 66 | <div class="section"> |
67 | <div class="section"> |
| 67 | <h1><a class="toc-backref" href="#id13" id="motivation" name="motivation">Motivation</a></h1> |
68 | <h1><a class="toc-backref" href="#id12" id="motivation" name="motivation">Motivation</a></h1> |
| 68 | <p>Gives Gentoo users the ability to better identify how USE flags affect their |
69 | <p>Gives Gentoo users the ability to better identify how USE flags affect their |
| 69 | installations of a given package. For example, many global USE flags have very |
70 | installations of a given package. For example, many global USE flags have very |
| 70 | generic descriptions but no specifics on how it affects a certain package. |
71 | generic descriptions but no specifics on how it affects a certain package. |
| 71 | Specifically speaking, an example would be net-print/cups and the 'jpeg' USE |
72 | Specifically speaking, an example would be net-print/cups and the 'jpeg' USE |
| 72 | flag. Does this flag mean you won't be able to print jpeg files? You can print |
73 | flag. Does this flag mean you won't be able to print jpeg files? You can print |
| … | |
… | |
| 77 | and <a class="footnote-reference" href="#motivators4" id="id4" name="id4">[9]</a></li> |
78 | and <a class="footnote-reference" href="#motivators4" id="id4" name="id4">[9]</a></li> |
| 78 | </ul> |
79 | </ul> |
| 79 | </blockquote> |
80 | </blockquote> |
| 80 | </div> |
81 | </div> |
| 81 | <div class="section"> |
82 | <div class="section"> |
| 82 | <h1><a class="toc-backref" href="#id14" id="specification" name="specification">Specification</a></h1> |
83 | <h1><a class="toc-backref" href="#id13" id="specification" name="specification">Specification</a></h1> |
| 83 | <p>This GLEP proposes the addition of <tt class="docutils literal"><span class="pre"><use></span></tt> XML tag that is only allowed to |
84 | <p>This GLEP proposes the addition of <tt class="docutils literal"><span class="pre"><use></span></tt> XML tag that is only allowed to |
| 84 | appear inside of a <tt class="docutils literal"><span class="pre"><pkgmetadata></span></tt> XML tag.</p> |
85 | appear inside of a <tt class="docutils literal"><span class="pre"><pkgmetadata></span></tt> XML tag.</p> |
| 85 | <blockquote> |
86 | <blockquote> |
| 86 | <ul> |
87 | <ul> |
| 87 | <li><p class="first">Inside the <tt class="docutils literal"><span class="pre"><use></span></tt> XML tag, the <tt class="docutils literal"><span class="pre"><flag></span></tt> XML tag is allowed to appear |
88 | <li><p class="first">Inside the <tt class="docutils literal"><span class="pre"><use></span></tt> XML tag, the <tt class="docutils literal"><span class="pre"><flag></span></tt> XML tag is allowed to appear |
| 88 | once per USE flag as specified by the <tt class="docutils literal"><span class="pre">'name'</span></tt> attribute with the |
89 | once per USE flag as specified by the <tt class="docutils literal"><span class="pre">'name'</span></tt> attribute with the |
| 89 | following exception:</p> |
90 | following exception:</p> |
| 90 | <ul class="simple"> |
91 | <ul class="simple"> |
| 91 | <li>The <tt class="docutils literal"><span class="pre">'restrict'</span></tt> atttribute can limit to specific versions of the |
92 | <li>The <tt class="docutils literal"><span class="pre">'restrict'</span></tt> atttribute can limit to specific versions of the |
| 92 | package, where the attribute value must be a valid CPV as defined by the |
93 | package, 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 |
94 | <cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id5" name="id5">[4]</a>. This follows the current |
| 94 | of the <tt class="docutils literal"><span class="pre">'restrict'</span></tt> attribute in metadata.xml.<ul> |
95 | behavior of the <tt class="docutils literal"><span class="pre">'restrict'</span></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> |
|
|
| 96 | attribute 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, |
96 | <li>e.g. A USE flag may have one behavior for version 0.1 of a package, |
| 98 | while version 0.2, the USE flag may differ slightly.</li> |
97 | while version 0.2, the USE flag may differ slightly.</li> |
| 99 | </ul> |
98 | </ul> |
| 100 | </li> |
99 | </li> |
| 101 | </ul> |
100 | </ul> |
| … | |
… | |
| 108 | </ul> |
107 | </ul> |
| 109 | </blockquote> |
108 | </blockquote> |
| 110 | </li> |
109 | </li> |
| 111 | <li><p class="first">Each <tt class="docutils literal"><span class="pre"><flag></span></tt> XML tag allows 0 or more nested <tt class="docutils literal"><span class="pre"><pkg></span></tt> XML tags whose |
110 | <li><p class="first">Each <tt class="docutils literal"><span class="pre"><flag></span></tt> XML tag allows 0 or more nested <tt class="docutils literal"><span class="pre"><pkg></span></tt> XML tags whose |
| 112 | character data is a valid CP or CPV as defined by the |
111 | character 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> |
112 | <cite>Gentoo Development Guide - Ebuild File Format</cite> <a class="footnote-reference" href="#devmanual" id="id6" name="id6">[5]</a>.</p> |
| 114 | </li> |
113 | </li> |
| 115 | <li><p class="first">Each <tt class="docutils literal"><span class="pre"><flag></span></tt> XML tag allows 0 or more nested <tt class="docutils literal"><span class="pre"><cat></span></tt> XML tags whose |
114 | <li><p class="first">Each <tt class="docutils literal"><span class="pre"><flag></span></tt> XML tag allows 0 or more nested <tt class="docutils literal"><span class="pre"><cat></span></tt> XML tags whose |
| 116 | character data is a valid category.</p> |
115 | character data is a valid category.</p> |
| 117 | </li> |
116 | </li> |
| 118 | <li><p class="first">The <tt class="docutils literal"><span class="pre"><use></span></tt> XML tag may appear multiple times inside of the |
117 | <li><p class="first">The <tt class="docutils literal"><span class="pre"><use></span></tt> XML tag may appear multiple times inside of the |
| 119 | <tt class="docutils literal"><span class="pre"><pkgmetadata></span></tt> XML tag if and only if it contains a different <tt class="docutils literal"><span class="pre">'lang'</span></tt> |
118 | <tt class="docutils literal"><span class="pre"><pkgmetadata></span></tt> XML tag if and only if it contains a different <tt class="docutils literal"><span class="pre">'lang'</span></tt> |
| 120 | attribute value.</p> |
119 | attribute value.</p> |
| 121 | <ul class="simple"> |
120 | <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 |
121 | <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 |
| 123 | <cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id8" name="id8">[5]</a>.</li> |
122 | <cite>Gentoo Developer Handbook</cite> <a class="footnote-reference" href="#devhandbook" id="id7" name="id7">[4]</a>.</li> |
| 124 | <li>The default <tt class="docutils literal"><span class="pre">'lang'</span></tt> attribute value is "C", which is equivilent to "en".</li> |
|
|
| 125 | </ul> |
123 | </ul> |
| 126 | </li> |
124 | </li> |
| 127 | </ul> |
125 | </ul> |
| 128 | </blockquote> |
126 | </blockquote> |
| 129 | <p>Documentation for the Developer Manual and the metadata.dtd can be found in |
127 | <p>Documentation for the Developer Manual and the metadata.dtd can be found in |
| 130 | Gentoo's Bugzilla <a class="footnote-reference" href="#use-flag-metadata-bug" id="id9" name="id9">[1]</a> bug #199788.</p> |
128 | Gentoo's Bugzilla <a class="footnote-reference" href="#use-flag-metadata-bug" id="id8" name="id8">[1]</a> bug #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="id9" name="id9">[2]</a> |
| 132 | and <a class="footnote-reference" href="#use-flag-metadata-example2" id="id11" name="id11">[3]</a>.</p> |
130 | and <a class="footnote-reference" href="#use-flag-metadata-example2" id="id10" name="id10">[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 | <use> |
133 | <use> |
| 136 | <flag name='acpi'>Enables HAL to attempt to read from |
134 | <flag name='acpi'>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 |
| … | |
… | |
| 144 | dictionaries found in <cat>app-dict</cat></flag> |
142 | dictionaries found in <cat>app-dict</cat></flag> |
| 145 | </use> |
143 | </use> |
| 146 | </pre> |
144 | </pre> |
| 147 | </div> |
145 | </div> |
| 148 | <div class="section"> |
146 | <div class="section"> |
| 149 | <h1><a class="toc-backref" href="#id15" id="credits" name="credits">Credits</a></h1> |
147 | <h1><a class="toc-backref" href="#id14" id="credits" name="credits">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): |
| 152 | Diego Pettenò (flameeyes), Alec Warner (antarus), Joshua Nichols (nichoj), |
150 | Diego Pettenò (flameeyes), Alec Warner (antarus), Joshua Nichols (nichoj), |
| 153 | Steve Dibb (beandog), and Tiziano Müller (dev-zero)</p> |
151 | Steve Dibb (beandog), and Tiziano Müller (dev-zero)</p> |
| 154 | </div> |
152 | </div> |
| 155 | <div class="section"> |
153 | <div class="section"> |
| 156 | <h1><a class="toc-backref" href="#id16" id="references" name="references">References</a></h1> |
154 | <h1><a class="toc-backref" href="#id15" id="references" name="references">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="#id8" 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> |
| 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="#id9" 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> |
| 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="#id10" 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> |
| 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&chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4</a></td></tr> |
176 | <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>)</em> <a class="reference" href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&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" 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> |
| 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"> |
| … | |
… | |
| 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" 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> |
| 209 | </tbody> |
207 | </tbody> |
| 210 | </table> |
208 | </table> |
|
|
209 | </div> |
|
|
210 | <div class="section"> |
|
|
211 | <h1><a class="toc-backref" href="#id16" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
|
|
212 | <p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files. Information in |
|
|
213 | the new tags is not mandatory. Tools that currently read <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> |
|
|
214 | files may break if written poorly, while well written tools should just ignore |
|
|
215 | the additional elements. Tools which are capable of handling the new tags |
|
|
216 | should 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> |
|
|
217 | <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 |
|
|
218 | USE 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 |
|
|
219 | information contained within the new tags in <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> must be ignored |
|
|
220 | and QA tools should warn as they currently do.</p> |
|
|
221 | <p>Once this GLEP is approved, the Gentoo Infrastructure Team will work to remove |
|
|
222 | the <tt class="docutils literal"><span class="pre">use.local.desc</span></tt> file from CVS and it will be auto-generated for rsync. |
|
|
223 | This will ensure that backwards compatibility is not broken for users of |
|
|
224 | non-CVS trees. At this time, QA tools will need to be updated to verify the |
|
|
225 | contents of <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> containing the necessary tags which would appear |
|
|
226 | in <tt class="docutils literal"><span class="pre">use.local.desc</span></tt>.</p> |
| 211 | </div> |
227 | </div> |
| 212 | <div class="section"> |
228 | <div class="section"> |
| 213 | <h1><a class="toc-backref" href="#id17" id="copyright" name="copyright">Copyright</a></h1> |
229 | <h1><a class="toc-backref" href="#id17" id="copyright" name="copyright">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 : --> |
| … | |
… | |
| 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" href="glep-0056.txt">View document source</a>. |
| 222 | Generated on: 2008-06-05 05:54 UTC. |
238 | Generated on: 2008-07-10 18:23 UTC. |
| 223 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
239 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
| 224 | |
240 | |
| 225 | </div> |
241 | </div> |
| 226 | </body> |
242 | </body> |
| 227 | </html> |
243 | </html> |
Parent Directory
| 
Revision Log
| 
Patch