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

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

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

Revision 1.5 Revision 1.6
… …
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 5 -- Extending metadata.xml</title> 12 <title>GLEP 5 -- Extending metadata.xml</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <style type="text/css">
14
15/*
16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2006/10/10 20:25:14 $
19:version: $Revision: 1.6 $
20:copyright: This stylesheet has been placed in the public domain.
21
22Default cascading style sheet for the PEP HTML output of Docutils.
23*/
24
25.first {
26 margin-top: 0 }
27
28.last {
29 margin-bottom: 0 }
30
31.navigation {
32 width: 100% ;
33 background: #cc99ff ;
34 margin-top: 0px ;
35 margin-bottom: 0px }
36
37.navigation .navicon {
38 width: 150px ;
39 height: 35px }
40
41.navigation .textlinks {
42 padding-left: 1em ;
43 text-align: left }
44
45.navigation td, .navigation th {
46 padding-left: 0em ;
47 padding-right: 0em ;
48 vertical-align: middle }
49
50.rfc2822 {
51 margin-top: 0.5em ;
52 margin-left: 0.5em ;
53 margin-right: 0.5em ;
54 margin-bottom: 0em }
55
56.rfc2822 td {
57 text-align: left }
58
59.rfc2822 th.field-name {
60 text-align: right ;
61 font-family: sans-serif ;
62 padding-right: 0.5em ;
63 font-weight: bold ;
64 margin-bottom: 0em }
65
66a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75dd {
76 margin-bottom: 0.5em }
77
78div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88div.abstract {
89 margin: 2em 5em }
90
91div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95div.attention, div.caution, div.danger, div.error, div.hint,
96div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101div.attention p.admonition-title, div.caution p.admonition-title,
102div.danger p.admonition-title, div.error p.admonition-title,
103div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108div.hint p.admonition-title, div.important p.admonition-title,
109div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113div.figure {
114 margin-left: 2em }
115
116div.footer, div.header {
117 font-size: smaller }
118
119div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123div.system-messages {
124 margin: 5em }
125
126div.system-messages h1 {
127 color: red }
128
129div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137div.topic {
138 margin: 2em }
139
140h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166.section hr {
167 width: 75% }
168
169ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172ol.arabic {
173 list-style: decimal }
174
175ol.loweralpha {
176 list-style: lower-alpha }
177
178ol.upperalpha {
179 list-style: upper-alpha }
180
181ol.lowerroman {
182 list-style: lower-roman }
183
184ol.upperroman {
185 list-style: upper-roman }
186
187p.caption {
188 font-style: italic }
189
190p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194p.label {
195 white-space: nowrap }
196
197p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218span.interpreted {
219 font-family: sans-serif }
220
221span.option-argument {
222 font-style: italic }
223
224span.pre {
225 white-space: pre }
226
227span.problematic {
228 color: red }
229
230table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239td.num {
240 text-align: right }
241
242th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250tt {
251 background-color: #eeeeee }
252
253ul.auto-toc {
254 list-style-type: none }
255
256</style>
14</head> 257</head>
15<body bgcolor="white"> 258<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 259<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 260 width="100%" border="0">
18<tr><td class="navicon" width="150" height="35"> 261<tr><td class="navicon" width="150" height="35">
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 262<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 263<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 264 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 265<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 266[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] 267[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
25[<b><a href="./glep-0005.txt">GLEP Source</a></b>] 268[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0005.txt">GLEP Source</a></b>]
26</td></tr></table> 269</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 270<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 271<col class="field-name" />
30<col class="field-body" /> 272<col class="field-body" />
31<tbody valign="top"> 273<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">5</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">5</td>
33</tr> 275</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Extending metadata.xml</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Extending metadata.xml</td>
35</tr> 277</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td>
37</tr> 279</tr>
38<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0005.txt?cvsroot=gentoo">2004/11/11 21:27:31</a></td> 280<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-0005.txt?cvsroot=gentoo">2004/11/11 21:27:31</a></td>
39</tr> 281</tr>
40<tr class="field"><th class="field-name">Author:</th><td class="field-body">Heinrich Wendel &lt;sysop&#32;&#97;t&#32;heinospage.de&gt;,</td> 282<tr class="field"><th class="field-name">Author:</th><td class="field-body">Heinrich Wendel &lt;sysop&#32;&#97;t&#32;heinospage.de&gt;,</td>
41</tr> 283</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td> 284<tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
43</tr> 285</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr> 287</tr>
46<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> 288<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
47</tr> 289</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">02-Jul-2003</td> 290<tr class="field"><th class="field-name">Created:</th><td class="field-body">02-Jul-2003</td>
49</tr> 291</tr>
50<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">02-Jul-2003, 11-Nov-2004</td> 292<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">02-Jul-2003, 11-Nov-2004</td>
51</tr> 293</tr>
52</tbody> 294</tbody>
53</table> 295</table>
54<hr /> 296<hr />
55<div class="contents topic" id="contents"> 297<div class="contents topic">
56<p class="topic-title first"><a name="contents">Contents</a></p> 298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
57<ul class="simple"> 299<ul class="simple">
58<li><a class="reference" href="#abstract" id="id5" name="id5">Abstract</a></li> 300<li><a class="reference" href="#abstract" id="id5" name="id5">Abstract</a></li>
59<li><a class="reference" href="#status" id="id6" name="id6">Status</a></li> 301<li><a class="reference" href="#status" id="id6" name="id6">Status</a></li>
60<li><a class="reference" href="#motivation" id="id7" name="id7">Motivation</a></li> 302<li><a class="reference" href="#motivation" id="id7" name="id7">Motivation</a></li>
61<li><a class="reference" href="#specification" id="id8" name="id8">Specification</a></li> 303<li><a class="reference" href="#specification" id="id8" name="id8">Specification</a></li>
… …
64<li><a class="reference" href="#reference-implementation" id="id11" name="id11">Reference Implementation</a></li> 306<li><a class="reference" href="#reference-implementation" id="id11" name="id11">Reference Implementation</a></li>
65<li><a class="reference" href="#references" id="id12" name="id12">References</a></li> 307<li><a class="reference" href="#references" id="id12" name="id12">References</a></li>
66<li><a class="reference" href="#copyright" id="id13" name="id13">Copyright</a></li> 308<li><a class="reference" href="#copyright" id="id13" name="id13">Copyright</a></li>
67</ul> 309</ul>
68</div> 310</div>
69<div class="section" id="abstract"> 311<div class="section">
70<h1><a class="toc-backref" href="#id5" name="abstract">Abstract</a></h1> 312<h1><a class="toc-backref" href="#id5" id="abstract" name="abstract">Abstract</a></h1>
71<p>As the latest development in Gentoo and Portage added the metadata.xml file 313<p>As the latest development in Gentoo and Portage added the metadata.xml file
72to each package, which provides information about the package and it's 314to each package, which provides information about the package and it's
73maintainers, this GLEP proposes to extend this format in order to simplify 315maintainers, this GLEP proposes to extend this format in order to simplify
74the .ebuild format.</p> 316the .ebuild format.</p>
75</div> 317</div>
76<div class="section" id="status"> 318<div class="section">
77<h1><a class="toc-backref" href="#id6" name="status">Status</a></h1> 319<h1><a class="toc-backref" href="#id6" id="status" name="status">Status</a></h1>
78<p>Timed out</p> 320<p>Timed out</p>
79</div> 321</div>
80<div class="section" id="motivation"> 322<div class="section">
81<h1><a class="toc-backref" href="#id7" name="motivation">Motivation</a></h1> 323<h1><a class="toc-backref" href="#id7" id="motivation" name="motivation">Motivation</a></h1>
82<p>The metadata.xml <a class="footnote-reference" href="#id4" id="id1" name="id1">[1]</a> standard was accepted and it already contains some 324<p>The metadata.xml <a class="footnote-reference" href="#id4" id="id1" name="id1">[1]</a> standard was accepted and it already contains some
83information about the packages (longdescription).</p> 325information about the packages (longdescription).</p>
84</div> 326</div>
85<div class="section" id="specification"> 327<div class="section">
86<h1><a class="toc-backref" href="#id8" name="specification">Specification</a></h1> 328<h1><a class="toc-backref" href="#id8" id="specification" name="specification">Specification</a></h1>
87<p>Add the tags &lt;description&gt; &lt;homepage&gt; &lt;license&gt; to the metadata.xml <a class="footnote-reference" href="#id4" id="id2" name="id2">[1]</a> and 329<p>Add the tags &lt;description&gt; &lt;homepage&gt; &lt;license&gt; to the metadata.xml <a class="footnote-reference" href="#id4" id="id2" name="id2">[1]</a> and
88remove them from the .ebuild files. All ebuilds and the emerge -S feature 330remove them from the .ebuild files. All ebuilds and the emerge -S feature
89have to be changed to use the new format.</p> 331have to be changed to use the new format.</p>
90</div> 332</div>
91<div class="section" id="rationale"> 333<div class="section">
92<h1><a class="toc-backref" href="#id9" name="rationale">Rationale</a></h1> 334<h1><a class="toc-backref" href="#id9" id="rationale" name="rationale">Rationale</a></h1>
93<p>The three tags description, homepage and license are mostly the same in all 335<p>The three tags description, homepage and license are mostly the same in all
94versions of an ebuild, but they must be added to each version. In order to 336versions of an ebuild, but they must be added to each version. In order to
95simplify the .ebuild format they can be moved to the new metadata.xml <a class="footnote-reference" href="#id4" id="id3" name="id3">[1]</a> file. 337simplify the .ebuild format they can be moved to the new metadata.xml <a class="footnote-reference" href="#id4" id="id3" name="id3">[1]</a> file.
96This would also allow different descriptions for different languages (lang 338This would also allow different descriptions for different languages (lang
97attribute) and there are no problems when a programm changes it license 339attribute) and there are no problems when a programm changes it license
98(restrict attribute).</p> 340(restrict attribute).</p>
99</div> 341</div>
100<div class="section" id="backwards-compatibility"> 342<div class="section">
101<h1><a class="toc-backref" href="#id10" name="backwards-compatibility">Backwards Compatibility</a></h1> 343<h1><a class="toc-backref" href="#id10" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
102<p>As it will take some time to do the changes on every ebuild, portage should still 344<p>As it will take some time to do the changes on every ebuild, portage should still
103support the old format for some time.</p> 345support the old format for some time.</p>
104</div> 346</div>
105<div class="section" id="reference-implementation"> 347<div class="section">
106<h1><a class="toc-backref" href="#id11" name="reference-implementation">Reference Implementation</a></h1> 348<h1><a class="toc-backref" href="#id11" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
107<p>not yet ...</p> 349<p>not yet ...</p>
108</div> 350</div>
109<div class="section" id="references"> 351<div class="section">
110<h1><a class="toc-backref" href="#id12" name="references">References</a></h1> 352<h1><a class="toc-backref" href="#id12" id="references" name="references">References</a></h1>
111<table class="footnote" frame="void" id="id4" rules="none"> 353<table class="docutils footnote" frame="void" id="id4" rules="none">
112<colgroup><col class="label" /><col /></colgroup> 354<colgroup><col class="label" /><col /></colgroup>
113<tbody valign="top"> 355<tbody valign="top">
114<tr><td class="label"><a name="id4">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>)</em> Gentoo Herds Project 356<tr><td class="label"><a name="id4">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>)</em> Gentoo Herds Project
115[<a class="reference" href="http://www.gentoo.org/proj/en/metastructure/herds/#doc_chap2">http://www.gentoo.org/proj/en/metastructure/herds/#doc_chap2</a>]</td></tr> 357[<a class="reference" href="http://www.gentoo.org/proj/en/metastructure/herds/#doc_chap2">http://www.gentoo.org/proj/en/metastructure/herds/#doc_chap2</a>]</td></tr>
116</tbody> 358</tbody>
117</table> 359</table>
118</div> 360</div>
119<div class="section" id="copyright"> 361<div class="section">
120<h1><a class="toc-backref" href="#id13" name="copyright">Copyright</a></h1> 362<h1><a class="toc-backref" href="#id13" id="copyright" name="copyright">Copyright</a></h1>
121<p>This document has been placed in the public domain.</p> 363<p>This document has been placed in the public domain.</p>
122</div> 364</div>
123</div>
124 365
366</div>
367<div class="footer">
125<hr class="footer" /> 368<hr class="footer" />
126<div class="footer">
127<a class="reference" href="glep-0005.txt">View document source</a>. 369<a class="reference" href="glep-0005.txt">View document source</a>.
128Generated on: 2004-11-11 21:20 UTC. 370Generated on: 2006-10-10 20:23 UTC.
129Generated 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. 371Generated 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.
372
130</div> 373</div>
131</body> 374</body>
132</html> 375</html>
133 376
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.6
  ViewVC Help
Powered by ViewVC 1.1.13