| 1 |
ciaranm |
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 |
|
|
<meta name="generator" content="Docutils 0.3.9: http://docutils.sourceforge.net/" />
|
| 12 |
|
|
<title>GLEP 46 -- Allow upstream tags in metadata.xml</title>
|
| 13 |
|
|
<link rel="stylesheet" href="tools/glep.css" type="text/css" />
|
| 14 |
|
|
</head>
|
| 15 |
|
|
<body bgcolor="white">
|
| 16 |
|
|
<table class="navigation" cellpadding="0" cellspacing="0"
|
| 17 |
|
|
width="100%" border="0">
|
| 18 |
|
|
<tr><td class="navicon" width="150" height="35">
|
| 19 |
|
|
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
|
| 20 |
|
|
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
|
| 21 |
|
|
border="0" width="150" height="35" /></a></td>
|
| 22 |
|
|
<td class="textlinks" align="left">
|
| 23 |
|
|
[<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>]
|
| 25 |
|
|
[<b><a href="./glep-0046.txt">GLEP Source</a></b>]
|
| 26 |
|
|
</td></tr></table>
|
| 27 |
|
|
<table class="rfc2822 docutils field-list" frame="void" rules="none">
|
| 28 |
|
|
<col class="field-name" />
|
| 29 |
|
|
<col class="field-body" />
|
| 30 |
|
|
<tbody valign="top">
|
| 31 |
|
|
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">46</td>
|
| 32 |
|
|
</tr>
|
| 33 |
|
|
<tr class="field"><th class="field-name">Title:</th><td class="field-body">Allow upstream tags in metadata.xml</td>
|
| 34 |
|
|
</tr>
|
| 35 |
|
|
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.0</td>
|
| 36 |
|
|
</tr>
|
| 37 |
|
|
<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-0046.txt?cvsroot=gentoo">2005/12/26 20:00:00</a></td>
|
| 38 |
|
|
</tr>
|
| 39 |
|
|
<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>
|
| 40 |
|
|
</tr>
|
| 41 |
|
|
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
|
| 42 |
|
|
</tr>
|
| 43 |
|
|
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
|
| 44 |
|
|
</tr>
|
| 45 |
|
|
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="http://www.python.org/peps/glep-0012.html">text/x-rst</a></td>
|
| 46 |
|
|
</tr>
|
| 47 |
|
|
<tr class="field"><th class="field-name">Created:</th><td class="field-body">26-Dec-2005</td>
|
| 48 |
|
|
</tr>
|
| 49 |
|
|
</tbody>
|
| 50 |
|
|
</table>
|
| 51 |
|
|
<hr />
|
| 52 |
|
|
<div class="contents topic" id="contents">
|
| 53 |
|
|
<p class="topic-title first"><a name="contents">Contents</a></p>
|
| 54 |
|
|
<ul class="simple">
|
| 55 |
|
|
<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
|
| 56 |
|
|
<li><a class="reference" href="#motivation" id="id3" name="id3">Motivation</a></li>
|
| 57 |
|
|
<li><a class="reference" href="#specification" id="id4" name="id4">Specification</a></li>
|
| 58 |
|
|
<li><a class="reference" href="#backwards-compatibility" id="id5" name="id5">Backwards Compatibility</a></li>
|
| 59 |
|
|
<li><a class="reference" href="#copyright" id="id6" name="id6">Copyright</a></li>
|
| 60 |
|
|
</ul>
|
| 61 |
|
|
</div>
|
| 62 |
|
|
<div class="section" id="abstract">
|
| 63 |
|
|
<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
|
| 64 |
|
|
<p><tt class="docutils literal"><span class="pre">metadata.xml</span></tt> should allow the use of tags to add information related to
|
| 65 |
|
|
upstream, such as who the upstream maintainers are, the upstream changelog and
|
| 66 |
|
|
where to report bugs.</p>
|
| 67 |
|
|
</div>
|
| 68 |
|
|
<div class="section" id="motivation">
|
| 69 |
|
|
<h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1>
|
| 70 |
|
|
<p>Allowing developers to add upstream information in <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> will make it
|
| 71 |
|
|
easier, faster and more reliable to share it with other developers. Having
|
| 72 |
|
|
information from upstream should avoid duplicated work in tasks such as browsing
|
| 73 |
|
|
upstream's Homepage and mailing lists.</p>
|
| 74 |
|
|
</div>
|
| 75 |
|
|
<div class="section" id="specification">
|
| 76 |
|
|
<h1><a class="toc-backref" href="#id4" name="specification">Specification</a></h1>
|
| 77 |
|
|
<p><tt class="docutils literal"><span class="pre">metadata.dtd</span></tt> should allow the use of a upstream tag in <tt class="docutils literal"><span class="pre">metadata.xml</span></tt>.
|
| 78 |
|
|
Inside the upstream tag, developers should be able to add upstream information
|
| 79 |
|
|
in the tags named <tt class="docutils literal"><span class="pre">maintainer,</span> <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>.</p>
|
| 80 |
|
|
<p>This GLEP defines the following four tags for <tt class="docutils literal"><span class="pre">upstream</span></tt>:
|
| 81 |
|
|
<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 which are
|
| 82 |
|
|
mandatory. Future GLEPs may extend this -- tools processing metadata.xml should
|
| 83 |
|
|
ignore unrecognized elements.</p>
|
| 84 |
|
|
<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 the
|
| 85 |
|
|
person/organization responsible for upstream maintainership of the package.</p>
|
| 86 |
|
|
<p><tt class="docutils literal"><span class="pre">name</span></tt> should contain a block of text with upstream's name.</p>
|
| 87 |
|
|
<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>
|
| 88 |
|
|
<p><tt class="docutils literal"><span class="pre">changelog</span></tt> should contain a URL prefixed with http or https where the
|
| 89 |
|
|
location of the upstream changelog can be found.</p>
|
| 90 |
|
|
<p><tt class="docutils literal"><span class="pre">bugs-to</span></tt> should contain a place where bugs can be filed, a URL prefixed with
|
| 91 |
|
|
http or https or an e-mail address.</p>
|
| 92 |
|
|
<p><tt class="docutils literal"><span class="pre">remote-id</span></tt> should specify a type of package identification tracker and the
|
| 93 |
|
|
identification that corresponds to the package in question. <tt class="docutils literal"><span class="pre">remote-id</span></tt> should
|
| 94 |
|
|
make it easier to index information like its identification in freshmeat or its
|
| 95 |
|
|
cpan identification.</p>
|
| 96 |
|
|
<p>For example:</p>
|
| 97 |
|
|
<pre class="literal-block">
|
| 98 |
|
|
<upstream>
|
| 99 |
|
|
<maintainer>
|
| 100 |
|
|
<name>Foo Bar</name>
|
| 101 |
|
|
<email>foo@bar.bar</email>
|
| 102 |
|
|
</maintainer>
|
| 103 |
|
|
<changelog>http://foo.bar/changelog.txt</changelog>
|
| 104 |
|
|
<bugs-to>https://bugs.foo.bar</bugs-to>
|
| 105 |
|
|
<remote-id type="freshmeat">12345</remote-id>
|
| 106 |
|
|
<remote-id type="sourceforge">foobar</remote-id>
|
| 107 |
|
|
</upstream>
|
| 108 |
|
|
</pre>
|
| 109 |
|
|
</div>
|
| 110 |
|
|
<div class="section" id="backwards-compatibility">
|
| 111 |
|
|
<h1><a class="toc-backref" href="#id5" name="backwards-compatibility">Backwards Compatibility</a></h1>
|
| 112 |
|
|
<p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt>. Information in the new
|
| 113 |
|
|
tags should not be mandatory.</p>
|
| 114 |
|
|
</div>
|
| 115 |
|
|
<div class="section" id="copyright">
|
| 116 |
|
|
<h1><a class="toc-backref" href="#id6" name="copyright">Copyright</a></h1>
|
| 117 |
|
|
<p>This document has been placed in the public domain.</p>
|
| 118 |
|
|
</div>
|
| 119 |
|
|
|
| 120 |
|
|
</div>
|
| 121 |
|
|
<div class="footer">
|
| 122 |
|
|
<hr class="footer" />
|
| 123 |
|
|
<a class="reference" href="glep-0046.txt">View document source</a>.
|
| 124 |
|
|
Generated on: 2005-12-27 00:24 UTC.
|
| 125 |
|
|
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.
|
| 126 |
|
|
|
| 127 |
|
|
</div>
|
| 128 |
|
|
</body>
|
| 129 |
|
|
</html>
|
| 130 |
|
|
|
Parent Directory
| 
Revision Log
