| 1 | <?xml version="1.0" encoding="utf-8" ?> |
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"> |
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 | 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> |
5 | <head> |
| 10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 11 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
7 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
| 12 | <title>GLEP 46 -- Allow upstream tags in metadata.xml</title> |
8 | <title>GLEP 46 -- Allow upstream tags in metadata.xml</title> |
| 13 | <style type="text/css"> |
9 | <link rel="stylesheet" href="tools/glep.css" 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.3 $ |
|
|
| 20 | :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 | </head> |
10 | </head> |
| 258 | <body bgcolor="white"> |
11 | <body bgcolor="white"> |
| 259 | <table class="navigation" cellpadding="0" cellspacing="0" |
12 | <table class="navigation" cellpadding="0" cellspacing="0" |
| 260 | width="100%" border="0"> |
13 | width="100%" border="0"> |
| 261 | <tr><td class="navicon" width="150" height="35"> |
14 | <tr><td class="navicon" width="150" height="35"> |
| 262 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
15 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
| 263 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
16 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
| 264 | border="0" width="150" height="35" /></a></td> |
17 | border="0" width="150" height="35" /></a></td> |
| 265 | <td class="textlinks" align="left"> |
18 | <td class="textlinks" align="left"> |
| 266 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
19 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
| 267 | [<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>] |
20 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
| 268 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0046.txt">GLEP Source</a></b>] |
21 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0046.txt">GLEP Source</a></b>] |
| 269 | </td></tr></table> |
22 | </td></tr></table> |
| 270 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
23 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
| 271 | <col class="field-name" /> |
24 | <col class="field-name" /> |
| 272 | <col class="field-body" /> |
25 | <col class="field-body" /> |
| 273 | <tbody valign="top"> |
26 | <tbody valign="top"> |
| 274 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">46</td> |
27 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">46</td> |
| 275 | </tr> |
28 | </tr> |
| 276 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Allow upstream tags in metadata.xml</td> |
29 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Allow upstream tags in metadata.xml</td> |
| 277 | </tr> |
30 | </tr> |
| 278 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> |
31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.5</td> |
| 279 | </tr> |
32 | </tr> |
| 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-0046.txt?cvsroot=gentoo">2006/03/06 03:17:07</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-0046.txt?cvsroot=gentoo">2008/04/03 13:35:26</a></td> |
| 281 | </tr> |
34 | </tr> |
| 282 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Marcelo Goes <vanquirius at gentoo.org>, Ciaran McCreesh <ciaranm at gentoo.org></td> |
35 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Marcelo Goes <vanquirius at gentoo.org>, Ciaran McCreesh <ciaranm at gentoo.org>, Tiziano Müller <dev-zero at gentoo.org></td> |
| 283 | </tr> |
36 | </tr> |
| 284 | <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">Deferred</td> |
| 285 | </tr> |
38 | </tr> |
| 286 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
39 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
| 287 | </tr> |
40 | </tr> |
| 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> |
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> |
| 289 | </tr> |
42 | </tr> |
| 290 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">26-Dec-2005</td> |
43 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">26-Dec-2005</td> |
| 291 | </tr> |
44 | </tr> |
| 292 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">26-Dec-2005, 5-Mar-2006</td> |
45 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">26-Dec-2005, 5-Mar-2006, 24-Jan-2008</td> |
| 293 | </tr> |
46 | </tr> |
| 294 | </tbody> |
47 | </tbody> |
| 295 | </table> |
48 | </table> |
| 296 | <hr /> |
49 | <hr /> |
| 297 | <div class="contents topic"> |
50 | <div class="contents topic"> |
| … | |
… | |
| 299 | <ul class="simple"> |
52 | <ul class="simple"> |
| 300 | <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> |
53 | <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li> |
| 301 | <li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li> |
54 | <li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li> |
| 302 | <li><a class="reference" href="#specification" id="id4" name="id4">Specification</a></li> |
55 | <li><a class="reference" href="#specification" id="id4" name="id4">Specification</a></li> |
| 303 | <li><a class="reference" href="#backwards-compatibility" id="id5" name="id5">Backwards Compatibility</a></li> |
56 | <li><a class="reference" href="#backwards-compatibility" id="id5" name="id5">Backwards Compatibility</a></li> |
|
|
57 | <li><a class="reference" href="#notes" id="id6" name="id6">Notes</a></li> |
| 304 | <li><a class="reference" href="#copyright" id="id6" name="id6">Copyright</a></li> |
58 | <li><a class="reference" href="#copyright" id="id7" name="id7">Copyright</a></li> |
| 305 | </ul> |
59 | </ul> |
| 306 | </div> |
60 | </div> |
| 307 | <div class="section"> |
61 | <div class="section"> |
| 308 | <h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1> |
62 | <h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1> |
| 309 | <p>Tree <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files are currently used to specify maintainer and |
63 | <p>Tree <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files are currently used to specify maintainer and |
| … | |
… | |
| 330 | <ul class="simple"> |
84 | <ul class="simple"> |
| 331 | <li>It will allow systems such as the Packages website to provide more |
85 | <li>It will allow systems such as the Packages website to provide more |
| 332 | useful information to end users.</li> |
86 | useful information to end users.</li> |
| 333 | <li>It will reduce the time spent by developers trying to find how to |
87 | <li>It will reduce the time spent by developers trying to find how to |
| 334 | contact upstream.</li> |
88 | contact upstream.</li> |
|
|
89 | <li>It will give treecleaners additional information to decide whether |
|
|
90 | a package can be removed from the tree.</li> |
| 335 | </ul> |
91 | </ul> |
| 336 | </div> |
92 | </div> |
| 337 | <div class="section"> |
93 | <div class="section"> |
| 338 | <h1><a class="toc-backref" href="#id4" id="specification" name="specification">Specification</a></h1> |
94 | <h1><a class="toc-backref" href="#id4" id="specification" name="specification">Specification</a></h1> |
| 339 | <p><tt class="docutils literal"><span class="pre">metadata.dtd</span></tt> should allow the use of a upstream tag in |
95 | <p><tt class="docutils literal"><span class="pre">metadata.dtd</span></tt> should allow the use of a upstream tag in |
| 340 | <tt class="docutils literal"><span class="pre">metadata.xml</span></tt>. Inside the upstream tag, developers should be able to |
96 | <tt class="docutils literal"><span class="pre">metadata.xml</span></tt>. Inside the upstream tag, developers should be able to |
| 341 | add upstream related information.</p> |
97 | add upstream related information.</p> |
| 342 | <p>This GLEP defines the following four tags for <tt class="docutils literal"><span class="pre">upstream</span></tt>: |
98 | <p>This GLEP defines the following five tags for <tt class="docutils literal"><span class="pre">upstream</span></tt>: |
| 343 | <tt class="docutils literal"><span class="pre">maintainer</span></tt>, <tt class="docutils literal"><span class="pre">changelog</span></tt>, <tt class="docutils literal"><span class="pre">bugs-to</span></tt> and <tt class="docutils literal"><span class="pre">remote-id</span></tt>, none of |
99 | <tt class="docutils literal"><span class="pre">maintainer</span></tt>, <tt class="docutils literal"><span class="pre">changelog</span></tt>, <tt class="docutils literal"><span class="pre">bugs-to</span></tt>, <tt class="docutils literal"><span class="pre">remote-id</span></tt> and <tt class="docutils literal"><span class="pre">doc</span></tt> none of |
| 344 | which are mandatory. Future GLEPs may extend this -- tools processing |
100 | which are mandatory. Future GLEPs may extend this -- tools processing |
| 345 | metadata.xml should ignore unrecognized elements.</p> |
101 | metadata.xml should ignore unrecognized elements.</p> |
| 346 | <p><tt class="docutils literal"><span class="pre">maintainer</span></tt> can contain the tags <tt class="docutils literal"><span class="pre">name</span></tt> and <tt class="docutils literal"><span class="pre">email</span></tt>, indicating |
102 | <p><tt class="docutils literal"><span class="pre">maintainer</span></tt> can contain the tags <tt class="docutils literal"><span class="pre">name</span></tt> and <tt class="docutils literal"><span class="pre">email</span></tt>, indicating |
| 347 | the person or organization responsible for upstream maintainership of |
103 | the person or organization responsible for upstream maintainership of |
| 348 | the package.</p> |
104 | the package. The tag may appear more than once.</p> |
|
|
105 | <p>The <tt class="docutils literal"><span class="pre">maintainer</span></tt> element has a <tt class="docutils literal"><span class="pre">status</span></tt> attribute, which is one of |
|
|
106 | <tt class="docutils literal"><span class="pre">active</span></tt> or <tt class="docutils literal"><span class="pre">inactive</span></tt>. This attribute is not mandatory. The absence of it |
|
|
107 | shall be interpreted as <tt class="docutils literal"><span class="pre">unknown</span></tt>.</p> |
|
|
108 | <p>The <tt class="docutils literal"><span class="pre">maintainer</span></tt> element can be the same as the top-level <tt class="docutils literal"><span class="pre">maintainer</span></tt> |
|
|
109 | element in cases where a developer decides to maintain the package in |
|
|
110 | addition to/instead of the original upstream. In such cases a <tt class="docutils literal"><span class="pre">maintainer</span></tt> |
|
|
111 | entry for the original upstream should be present.</p> |
| 349 | <p><tt class="docutils literal"><span class="pre">name</span></tt> should contain a block of text with upstream's name.</p> |
112 | <p><tt class="docutils literal"><span class="pre">name</span></tt> should contain a block of text with upstream's name, is mandatory |
|
|
113 | and can only appear once.</p> |
| 350 | <p><tt class="docutils literal"><span class="pre">email</span></tt> should contain an e-mail address in the format <a class="reference" href="mailto:foo@bar.bar">foo@bar.bar</a>.</p> |
114 | <p><tt class="docutils literal"><span class="pre">email</span></tt> should contain an e-mail address in the format <tt class="docutils literal"><span class="pre">foo@bar.bar</span></tt>.</p> |
| 351 | <p><tt class="docutils literal"><span class="pre">changelog</span></tt> should contain a URL prefixed with <tt class="docutils literal"><span class="pre">http://</span></tt> or |
115 | <p><tt class="docutils literal"><span class="pre">changelog</span></tt> should contain a URL where the location of the upstream |
| 352 | <tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream changelog can be found.</p> |
116 | changelog can be found. The URL must be version independent and must point to |
|
|
117 | a changelog which is only updated on new releases of the corresponding |
|
|
118 | package. (This also implies that one can link to an automatically updated |
|
|
119 | changelog in case of vcs snapshots only.)</p> |
|
|
120 | <p><tt class="docutils literal"><span class="pre">doc</span></tt> should contain a URL where the location of the upstream |
|
|
121 | documentation can be found. The link must not point to any third party |
|
|
122 | documentation and must be version independent. If the documentation is |
|
|
123 | available in more than one language, a <tt class="docutils literal"><span class="pre">lang</span></tt> attribute can be used |
|
|
124 | which follows the same rules as the one for <tt class="docutils literal"><span class="pre">longdescription</span></tt>.</p> |
| 353 | <p><tt class="docutils literal"><span class="pre">bugs-to</span></tt> should contain a place where bugs can be filed, a URL |
125 | <p><tt class="docutils literal"><span class="pre">bugs-to</span></tt> should contain a place where bugs can be filed, a URL or an |
| 354 | prefixed with <tt class="docutils literal"><span class="pre">http://</span></tt> or <tt class="docutils literal"><span class="pre">https://</span></tt> or an e-mail address prefixed |
|
|
| 355 | with <tt class="docutils literal"><span class="pre">mailto:</span></tt>.</p> |
126 | e-mail address prefixed with <tt class="docutils literal"><span class="pre">mailto:</span></tt>.</p> |
| 356 | <p><tt class="docutils literal"><span class="pre">remote-id</span></tt> should specify a type of package identification tracker |
127 | <p><tt class="docutils literal"><span class="pre">remote-id</span></tt> should specify a type of package identification tracker |
| 357 | and the identification that corresponds to the package in question. |
128 | and the identification that corresponds to the package in question. |
| 358 | <tt class="docutils literal"><span class="pre">remote-id</span></tt> should make it easier to index information such as its |
129 | <tt class="docutils literal"><span class="pre">remote-id</span></tt> should make it easier to index information such as its |
| 359 | Freshmeat ID or its CPAN name.</p> |
130 | Freshmeat ID or its CPAN name.</p> |
| 360 | <p>The <tt class="docutils literal"><span class="pre">remote-id</span></tt> element has a <tt class="docutils literal"><span class="pre">type</span></tt> attribute, which is a string |
131 | <p>The <tt class="docutils literal"><span class="pre">remote-id</span></tt> element has a <tt class="docutils literal"><span class="pre">type</span></tt> attribute, which is a string |
| 361 | identifying the type of upstream source. Examples are <tt class="docutils literal"><span class="pre">freshmeat</span></tt>, in |
132 | identifying the type of upstream source. Examples are <tt class="docutils literal"><span class="pre">freshmeat</span></tt>, in |
| 362 | which case the element content should be the Freshmeat ID or <tt class="docutils literal"><span class="pre">vim</span></tt>, in |
133 | which case the element content should be the Freshmeat ID or <tt class="docutils literal"><span class="pre">vim</span></tt>, in |
| 363 | which case the element content should be the <tt class="docutils literal"><span class="pre">vim.org</span></tt> script |
134 | which case the element content should be the <tt class="docutils literal"><span class="pre">vim.org</span></tt> script |
| 364 | identifier. This GLEP does not specify a complete list of legal values |
135 | identifier. This GLEP does not specify a complete list of legal values |
| 365 | for <tt class="docutils literal"><span class="pre">type</span></tt> -- developers should email the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing list |
136 | for <tt class="docutils literal"><span class="pre">type</span></tt> -- developers should email the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing list |
| 366 | before using a new <tt class="docutils literal"><span class="pre">type</span></tt> value.</p> |
137 | before using a new <tt class="docutils literal"><span class="pre">type</span></tt> value. The list of valid tags should be kept |
|
|
138 | in <tt class="docutils literal"><span class="pre">metadata/dtd/remote-id-tags.dtd</span></tt> or <tt class="docutils literal"><span class="pre">metadata/dtd/metadata.dtd</span></tt>.</p> |
| 367 | <p>For example, a <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> upstream snippet may look like:</p> |
139 | <p>For example, a <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> upstream snippet may look like:</p> |
| 368 | <pre class="literal-block"> |
140 | <pre class="literal-block"> |
| 369 | <upstream> |
141 | <upstream> |
| 370 | <maintainer> |
142 | <maintainer status="inactive"> |
| 371 | <name>Foo Bar</name> |
143 | <name>Foo Bar</name> |
| 372 | <email>foo@bar.bar</email> |
144 | <email>foo@bar.bar</email> |
| 373 | </maintainer> |
145 | </maintainer> |
|
|
146 | <maintainer status="active"> |
|
|
147 | <name>Foo Gentoo</name> |
|
|
148 | <email>foo@gentoo.org</email> |
|
|
149 | </maintainer> |
| 374 | <changelog>http://foo.bar/changelog.txt</changelog> |
150 | <changelog>http://foo.bar/changelog.txt</changelog> |
|
|
151 | <doc lang="en">http://foo.bar/doc/index.html</doc> |
|
|
152 | <doc lang="de">http://foo.bar/doc/index.de.html</doc> |
| 375 | <bugs-to>https://bugs.foo.bar</bugs-to> |
153 | <bugs-to>https://bugs.foo.bar</bugs-to> |
| 376 | <remote-id type="freshmeat">12345</remote-id> |
154 | <remote-id type="freshmeat">foobar</remote-id> |
| 377 | <remote-id type="sourceforge">foobar</remote-id> |
155 | <remote-id type="sourceforge">foobar</remote-id> |
| 378 | </upstream> |
156 | </upstream> |
| 379 | </pre> |
157 | </pre> |
| 380 | </div> |
158 | </div> |
| 381 | <div class="section"> |
159 | <div class="section"> |
| 382 | <h1><a class="toc-backref" href="#id5" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
160 | <h1><a class="toc-backref" href="#id5" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
| 383 | <p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files. Information |
161 | <p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files. Information |
| 384 | in the new tags is not be mandatory. Any sane tool that currently |
162 | in the new tags is not mandatory. Tools that currently read |
| 385 | handles <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files will simply ignore unrecognised elements.</p> |
163 | <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files may break if written poorly; well written tools |
|
|
164 | should just ignore the additional elements.</p> |
| 386 | </div> |
165 | </div> |
| 387 | <div class="section"> |
166 | <div class="section"> |
|
|
167 | <h1><a class="toc-backref" href="#id6" id="notes" name="notes">Notes</a></h1> |
|
|
168 | <p>The specified URLs must include a protocol as described in <a class="reference" href="http://www.faqs.org/rfcs/rfc3986.html">RFC 3986</a>. |
|
|
169 | Furthermore the most common protocol should be used in case of several |
|
|
170 | possibilities (http should be favoured over https or ftp over gopher or svn, |
|
|
171 | etc).</p> |
|
|
172 | </div> |
|
|
173 | <div class="section"> |
| 388 | <h1><a class="toc-backref" href="#id6" id="copyright" name="copyright">Copyright</a></h1> |
174 | <h1><a class="toc-backref" href="#id7" id="copyright" name="copyright">Copyright</a></h1> |
| 389 | <p>This document has been placed in the public domain.</p> |
175 | <p>This document has been placed in the public domain.</p> |
| 390 | <!-- vim: set ft=glep tw=72 : --> |
176 | <!-- vim: set ft=glep tw=72 : --> |
| 391 | </div> |
177 | </div> |
| 392 | |
178 | |
| 393 | </div> |
179 | </div> |
| 394 | <div class="footer"> |
180 | <div class="footer"> |
| 395 | <hr class="footer" /> |
181 | <hr class="footer" /> |
| 396 | <a class="reference" href="glep-0046.txt">View document source</a>. |
182 | <a class="reference" href="glep-0046.txt">View document source</a>. |
| 397 | Generated on: 2006-10-10 20:23 UTC. |
183 | Generated on: 2008-04-03 13:35 UTC. |
| 398 | 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. |
184 | 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. |
| 399 | |
185 | |
| 400 | </div> |
186 | </div> |
| 401 | </body> |
187 | </body> |
| 402 | </html> |
188 | </html> |