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

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

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

Revision 1.6 Revision 1.8
26<tbody valign="top"> 26<tbody valign="top">
27<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>
28</tr> 28</tr>
29<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>
30</tr> 30</tr>
31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</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-0046.txt?cvsroot=gentoo">2007/04/21 03:13:16</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/01/24 13:00:09</a></td>
34</tr> 34</tr>
35<tr class="field"><th class="field-name">Author:</th><td class="field-body">Marcelo Goes &lt;vanquirius&#32;&#97;t&#32;gentoo.org&gt;, Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td> 35<tr class="field"><th class="field-name">Author:</th><td class="field-body">Marcelo Goes &lt;vanquirius&#32;&#97;t&#32;gentoo.org&gt;, Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;, Tiziano Müller &lt;dev-zero&#32;&#97;t&#32;gentoo.org&gt;</td>
36</tr> 36</tr>
37<tr class="field"><th class="field-name">Status:</th><td class="field-body">Deferred</td> 37<tr class="field"><th class="field-name">Status:</th><td class="field-body">Deferred</td>
38</tr> 38</tr>
39<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>
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">26-Dec-2005</td> 43<tr class="field"><th class="field-name">Created:</th><td class="field-body">26-Dec-2005</td>
44</tr> 44</tr>
45<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>
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">
83<ul class="simple"> 83<ul class="simple">
84<li>It will allow systems such as the Packages website to provide more 84<li>It will allow systems such as the Packages website to provide more
85useful information to end users.</li> 85useful information to end users.</li>
86<li>It will reduce the time spent by developers trying to find how to 86<li>It will reduce the time spent by developers trying to find how to
87contact upstream.</li> 87contact upstream.</li>
88<li>It will give treecleaners additional information to decide whether
89a package can be removed from the tree.</li>
88</ul> 90</ul>
89</div> 91</div>
90<div class="section"> 92<div class="section">
91<h1><a class="toc-backref" href="#id4" id="specification" name="specification">Specification</a></h1> 93<h1><a class="toc-backref" href="#id4" id="specification" name="specification">Specification</a></h1>
92<p><tt class="docutils literal"><span class="pre">metadata.dtd</span></tt> should allow the use of a upstream tag in 94<p><tt class="docutils literal"><span class="pre">metadata.dtd</span></tt> should allow the use of a upstream tag in
93<tt class="docutils literal"><span class="pre">metadata.xml</span></tt>. Inside the upstream tag, developers should be able to 95<tt class="docutils literal"><span class="pre">metadata.xml</span></tt>. Inside the upstream tag, developers should be able to
94add upstream related information.</p> 96add upstream related information.</p>
95<p>This GLEP defines the following four tags for <tt class="docutils literal"><span class="pre">upstream</span></tt>: 97<p>This GLEP defines the following five tags for <tt class="docutils literal"><span class="pre">upstream</span></tt>:
96<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 98<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
97which are mandatory. Future GLEPs may extend this -- tools processing 99which are mandatory. Future GLEPs may extend this -- tools processing
98metadata.xml should ignore unrecognized elements.</p> 100metadata.xml should ignore unrecognized elements.</p>
99<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 101<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
100the person or organization responsible for upstream maintainership of 102the person or organization responsible for upstream maintainership of
101the package.</p> 103the package. The tag may appear more than once.</p>
104<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
105<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
106shall be interpreted as <tt class="docutils literal"><span class="pre">unknown</span></tt>.</p>
107<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>
108element in cases where a developer decides to maintain the package in
109addition to/instead of the original upstream. In such cases a <tt class="docutils literal"><span class="pre">maintainer</span></tt>
110entry for the original upstream should be present.</p>
102<p><tt class="docutils literal"><span class="pre">name</span></tt> should contain a block of text with upstream's name.</p> 111<p><tt class="docutils literal"><span class="pre">name</span></tt> should contain a block of text with upstream's name, is mandatory
112and can only appear once.</p>
103<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&#64;bar.bar">foo&#64;bar.bar</a>.</p> 113<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&#64;bar.bar</span></tt>.</p>
104<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 114<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
105<tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream changelog can be found.</p> 115<tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream changelog can be found.</p>
116<p><tt class="docutils literal"><span class="pre">doc</span></tt> should contain a URL prefixed with with <tt class="docutils literal"><span class="pre">http://</span></tt> or
117<tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream documentation can be found.
118The link must not point to any third party documentation and must be version
119independent. If the documentation is available in more than one language, a
120<tt class="docutils literal"><span class="pre">lang</span></tt> attribute can be used which follows the same rules as the one
121for <tt class="docutils literal"><span class="pre">longdescription</span></tt>.</p>
106<p><tt class="docutils literal"><span class="pre">bugs-to</span></tt> should contain a place where bugs can be filed, a URL 122<p><tt class="docutils literal"><span class="pre">bugs-to</span></tt> should contain a place where bugs can be filed, a URL
107prefixed 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 123prefixed 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
108with <tt class="docutils literal"><span class="pre">mailto:</span></tt>.</p> 124with <tt class="docutils literal"><span class="pre">mailto:</span></tt>.</p>
109<p><tt class="docutils literal"><span class="pre">remote-id</span></tt> should specify a type of package identification tracker 125<p><tt class="docutils literal"><span class="pre">remote-id</span></tt> should specify a type of package identification tracker
110and the identification that corresponds to the package in question. 126and the identification that corresponds to the package in question.
114identifying the type of upstream source. Examples are <tt class="docutils literal"><span class="pre">freshmeat</span></tt>, in 130identifying the type of upstream source. Examples are <tt class="docutils literal"><span class="pre">freshmeat</span></tt>, in
115which case the element content should be the Freshmeat ID or <tt class="docutils literal"><span class="pre">vim</span></tt>, in 131which case the element content should be the Freshmeat ID or <tt class="docutils literal"><span class="pre">vim</span></tt>, in
116which case the element content should be the <tt class="docutils literal"><span class="pre">vim.org</span></tt> script 132which case the element content should be the <tt class="docutils literal"><span class="pre">vim.org</span></tt> script
117identifier. This GLEP does not specify a complete list of legal values 133identifier. This GLEP does not specify a complete list of legal values
118for <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 134for <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
119before using a new <tt class="docutils literal"><span class="pre">type</span></tt> value.</p> 135before using a new <tt class="docutils literal"><span class="pre">type</span></tt> value. The list of valid tags should be kept
136in <tt class="docutils literal"><span class="pre">metadata/dtd/remote-id-tags.dtd</span></tt>.</p>
120<p>For example, a <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> upstream snippet may look like:</p> 137<p>For example, a <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> upstream snippet may look like:</p>
121<pre class="literal-block"> 138<pre class="literal-block">
122&lt;upstream&gt; 139&lt;upstream&gt;
123 &lt;maintainer&gt; 140 &lt;maintainer status=&quot;inactive&quot;&gt;
124 &lt;name&gt;Foo Bar&lt;/name&gt; 141 &lt;name&gt;Foo Bar&lt;/name&gt;
125 &lt;email&gt;foo&#64;bar.bar&lt;/email&gt; 142 &lt;email&gt;foo&#64;bar.bar&lt;/email&gt;
126 &lt;/maintainer&gt; 143 &lt;/maintainer&gt;
144 &lt;maintainer status=&quot;active&quot;&gt;
145 &lt;name&gt;Foo Gentoo&lt;/name&gt;
146 &lt;email&gt;foo&#64;gentoo.org&lt;/email&gt;
147 &lt;/maintainer&gt;
127 &lt;changelog&gt;http://foo.bar/changelog.txt&lt;/changelog&gt; 148 &lt;changelog&gt;http://foo.bar/changelog.txt&lt;/changelog&gt;
149 &lt;doc lang=&quot;en&quot;&gt;http://foo.bar/doc/index.html&lt;/doc&gt;
150 &lt;doc lang=&quot;de&quot;&gt;http://foo.bar./doc/index.de.html&lt;/doc&gt;
128 &lt;bugs-to&gt;https://bugs.foo.bar&lt;/bugs-to&gt; 151 &lt;bugs-to&gt;https://bugs.foo.bar&lt;/bugs-to&gt;
129 &lt;remote-id type=&quot;freshmeat&quot;&gt;12345&lt;/remote-id&gt; 152 &lt;remote-id type=&quot;freshmeat&quot;&gt;foobar&lt;/remote-id&gt;
130 &lt;remote-id type=&quot;sourceforge&quot;&gt;foobar&lt;/remote-id&gt; 153 &lt;remote-id type=&quot;sourceforge&quot;&gt;foobar&lt;/remote-id&gt;
131&lt;/upstream&gt; 154&lt;/upstream&gt;
132</pre> 155</pre>
133</div> 156</div>
134<div class="section"> 157<div class="section">
135<h1><a class="toc-backref" href="#id5" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> 158<h1><a class="toc-backref" href="#id5" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
136<p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files. Information 159<p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files. Information
137in the new tags is not be mandatory. Any sane tool that currently 160in the new tags is not mandatory. Tools that currently read
138handles <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files will simply ignore unrecognised elements.</p> 161<tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files may break if written poorly; well written tools
162should just ignore the additional elements.</p>
139</div> 163</div>
140<div class="section"> 164<div class="section">
141<h1><a class="toc-backref" href="#id6" id="copyright" name="copyright">Copyright</a></h1> 165<h1><a class="toc-backref" href="#id6" id="copyright" name="copyright">Copyright</a></h1>
142<p>This document has been placed in the public domain.</p> 166<p>This document has been placed in the public domain.</p>
143<!-- vim: set ft=glep tw=72 : --> 167<!-- vim: set ft=glep tw=72 : -->
145 169
146</div> 170</div>
147<div class="footer"> 171<div class="footer">
148<hr class="footer" /> 172<hr class="footer" />
149<a class="reference" href="glep-0046.txt">View document source</a>. 173<a class="reference" href="glep-0046.txt">View document source</a>.
150Generated on: 2007-10-13 13:39 UTC. 174Generated on: 2008-01-24 13:00 UTC.
151Generated 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. 175Generated 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.
152 176
153</div> 177</div>
154</body> 178</body>
155</html> 179</html>

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.8

  ViewVC Help
Powered by ViewVC 1.1.20