/[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.7 Revision 1.10
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.6</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/05/10 07:50:43</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;, Tiziano Müller &lt;dev-zero&#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">Accepted</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, 24-Jan-2008</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, 10-May-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">
52<ul class="simple"> 52<ul class="simple">
53<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>
54<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>
55<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>
56<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>
57<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>
58</ul> 59</ul>
59</div> 60</div>
60<div class="section"> 61<div class="section">
61<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>
62<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
109addition to/instead of the original upstream. In such cases a <tt class="docutils literal"><span class="pre">maintainer</span></tt> 110addition 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> 111entry for the original upstream should be present.</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 112<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> 113and can only appear once.</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> 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&#64;bar.bar</span></tt>.</p>
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 115<p><tt class="docutils literal"><span class="pre">changelog</span></tt> should contain a URL where the location of the upstream
115<tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream changelog can be found.</p> 116changelog can be found. The URL must be version independent and must point to
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 117a changelog which is only updated on new releases of the corresponding
117<tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream documentation can be found. 118package. (This also implies that one can link to an automatically updated
118The link must not point to any third party documentation and must be version 119changelog in case of vcs snapshots only.)</p>
119independent. If the documentation is available in more than one language, a 120<p><tt class="docutils literal"><span class="pre">doc</span></tt> should contain a URL where the location of the upstream
120<tt class="docutils literal"><span class="pre">lang</span></tt> attribute can be used which follows the same rules as the one 121documentation can be found. The link must not point to any third party
122documentation and must be version independent. If the documentation is
123available in more than one language, a <tt class="docutils literal"><span class="pre">lang</span></tt> attribute can be used
121for <tt class="docutils literal"><span class="pre">longdescription</span></tt>.</p> 124which follows the same rules as the one for <tt class="docutils literal"><span class="pre">longdescription</span></tt>.</p>
122<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
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
124with <tt class="docutils literal"><span class="pre">mailto:</span></tt>.</p> 126e-mail address prefixed with <tt class="docutils literal"><span class="pre">mailto:</span></tt>.</p>
125<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
126and the identification that corresponds to the package in question. 128and the identification that corresponds to the package in question.
127<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
128Freshmeat ID or its CPAN name.</p> 130Freshmeat ID or its CPAN name.</p>
129<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
131which case the element content should be the Freshmeat ID or <tt class="docutils literal"><span class="pre">vim</span></tt>, in 133which case the element content should be the Freshmeat ID or <tt class="docutils literal"><span class="pre">vim</span></tt>, in
132which case the element content should be the <tt class="docutils literal"><span class="pre">vim.org</span></tt> script 134which case the element content should be the <tt class="docutils literal"><span class="pre">vim.org</span></tt> script
133identifier. This GLEP does not specify a complete list of legal values 135identifier. This GLEP does not specify a complete list of legal values
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 136for <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
135before using a new <tt class="docutils literal"><span class="pre">type</span></tt> value. The list of valid tags should be kept 137before 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> 138in <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>
137<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>
138<pre class="literal-block"> 140<pre class="literal-block">
139&lt;upstream&gt; 141&lt;upstream&gt;
140 &lt;maintainer status=&quot;inactive&quot;&gt; 142 &lt;maintainer status=&quot;inactive&quot;&gt;
141 &lt;name&gt;Foo Bar&lt;/name&gt; 143 &lt;name&gt;Foo Bar&lt;/name&gt;
145 &lt;name&gt;Foo Gentoo&lt;/name&gt; 147 &lt;name&gt;Foo Gentoo&lt;/name&gt;
146 &lt;email&gt;foo&#64;gentoo.org&lt;/email&gt; 148 &lt;email&gt;foo&#64;gentoo.org&lt;/email&gt;
147 &lt;/maintainer&gt; 149 &lt;/maintainer&gt;
148 &lt;changelog&gt;http://foo.bar/changelog.txt&lt;/changelog&gt; 150 &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; 151 &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; 152 &lt;doc lang=&quot;de&quot;&gt;http://foo.bar/doc/index.de.html&lt;/doc&gt;
151 &lt;bugs-to&gt;https://bugs.foo.bar&lt;/bugs-to&gt; 153 &lt;bugs-to&gt;https://bugs.foo.bar&lt;/bugs-to&gt;
152 &lt;remote-id type=&quot;freshmeat&quot;&gt;foobar&lt;/remote-id&gt; 154 &lt;remote-id type=&quot;freshmeat&quot;&gt;foobar&lt;/remote-id&gt;
153 &lt;remote-id type=&quot;sourceforge&quot;&gt;foobar&lt;/remote-id&gt; 155 &lt;remote-id type=&quot;sourceforge&quot;&gt;foobar&lt;/remote-id&gt;
154&lt;/upstream&gt; 156&lt;/upstream&gt;
155</pre> 157</pre>
160in the new tags is not mandatory. Tools that currently read 162in the new tags is not mandatory. Tools that currently read
161<tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files may break if written poorly; well written tools 163<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> 164should just ignore the additional elements.</p>
163</div> 165</div>
164<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>.
169Furthermore the most common protocol should be used in case of several
170possibilities (http should be favoured over https or ftp over gopher or svn,
171etc).</p>
172</div>
173<div class="section">
165<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>
166<p>This document has been placed in the public domain.</p> 175<p>This document has been placed in the public domain.</p>
167<!-- vim: set ft=glep tw=72 : --> 176<!-- vim: set ft=glep tw=72 : -->
168</div> 177</div>
169 178
170</div> 179</div>
171<div class="footer"> 180<div class="footer">
172<hr class="footer" /> 181<hr class="footer" />
173<a class="reference" href="glep-0046.txt">View document source</a>. 182<a class="reference" href="glep-0046.txt">View document source</a>.
174Generated on: 2008-01-24 12:57 UTC. 183Generated on: 2008-05-10 07:51 UTC.
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. 184Generated 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.
176 185
177</div> 186</div>
178</body> 187</body>
179</html> 188</html>

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.10

  ViewVC Help
Powered by ViewVC 1.1.20