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