Gentoo Logo
Gentoo Spaceship




Note: Due to technical difficulties, the Archives are currently not up to date. GMANE provides an alternative service for most mailing lists.
c.f. bug 424647
List Archive: gentoo-commits
Navigation:
Lists: gentoo-commits: < Prev By Thread Next > < Prev By Date Next >
Headers:
To: gentoo-commits@g.o
From: "Tiziano Mueller (dev-zero)" <dev-zero@g.o>
Subject: gentoo commit in xml/htdocs/proj/en/glep: glep-0046.html glep-0046.txt
Date: Thu, 24 Jan 2008 13:00:09 +0000
dev-zero    08/01/24 13:00:09

  Modified:             glep-0046.html glep-0046.txt
  Log:
  Updated glep-0046 according to the discussion on the gentoo.devel mailinglist

Revision  Changes    Path
1.7                  xml/htdocs/proj/en/glep/glep-0046.html

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.html?rev=1.7&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.html?rev=1.7&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.html?r1=1.6&r2=1.7

Index: glep-0046.html
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/glep/glep-0046.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- glep-0046.html	14 Oct 2007 17:00:15 -0000	1.6
+++ glep-0046.html	24 Jan 2008 13:00:09 -0000	1.7
@@ -32,7 +32,7 @@
 </tr>
 <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>
 </tr>
-<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>
+<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>
 </tr>
 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Deferred</td>
 </tr>
@@ -42,7 +42,7 @@
 </tr>
 <tr class="field"><th class="field-name">Created:</th><td class="field-body">26-Dec-2005</td>
 </tr>
-<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">26-Dec-2005, 5-Mar-2006</td>
+<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">26-Dec-2005, 5-Mar-2006, 24-Jan-2008</td>
 </tr>
 </tbody>
 </table>
@@ -85,6 +85,8 @@
 useful information to end users.</li>
 <li>It will reduce the time spent by developers trying to find how to
 contact upstream.</li>
+<li>It will give treecleaners additional information to decide whether
+a package can be removed from the tree.</li>
 </ul>
 </div>
 <div class="section">
@@ -92,17 +94,31 @@
 <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>.  Inside the upstream tag, developers should be able to
 add upstream related information.</p>
-<p>This GLEP defines the following four tags for <tt class="docutils literal"><span class="pre">upstream</span></tt>:
-<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
+<p>This GLEP defines the following five tags for <tt class="docutils literal"><span class="pre">upstream</span></tt>:
+<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
 which are mandatory. Future GLEPs may extend this -- tools processing
 metadata.xml should ignore unrecognized elements.</p>
 <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 person or organization responsible for upstream maintainership of
-the package.</p>
-<p><tt class="docutils literal"><span class="pre">name</span></tt> should contain a block of text with upstream's name.</p>
-<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>
+the package. The tag may appear more than once.</p>
+<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
+<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
+shall be interpreted as <tt class="docutils literal"><span class="pre">unknown</span></tt>.</p>
+<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>
+element in cases where a developer decides to maintain the package in
+addition to/instead of the original upstream. In such cases a <tt class="docutils literal"><span class="pre">maintainer</span></tt>
+entry for the original upstream should be present.</p>
+<p><tt class="docutils literal"><span class="pre">name</span></tt> should contain a block of text with upstream's name, is mandatory
+and can only appear once.</p>
+<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>
 <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
 <tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream changelog can be found.</p>
+<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
+<tt class="docutils literal"><span class="pre">https://</span></tt> where the location of the upstream documentation can be found.
+The link must not point to any third party documentation and must be version
+independent. If the documentation is available in more than one language, a
+<tt class="docutils literal"><span class="pre">lang</span></tt> attribute can be used which follows the same rules as the one
+for <tt class="docutils literal"><span class="pre">longdescription</span></tt>.</p>
 <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 <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
 with <tt class="docutils literal"><span class="pre">mailto:</span></tt>.</p>
@@ -116,17 +132,24 @@
 which case the element content should be the <tt class="docutils literal"><span class="pre">vim.org</span></tt> script
 identifier. This GLEP does not specify a complete list of legal values
 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
-before using a new <tt class="docutils literal"><span class="pre">type</span></tt> value.</p>
+before using a new <tt class="docutils literal"><span class="pre">type</span></tt> value. The list of valid tags should be kept
+in <tt class="docutils literal"><span class="pre">metadata/dtd/remote-id-tags.dtd</span></tt>.</p>
 <p>For example, a <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> upstream snippet may look like:</p>
 <pre class="literal-block">
 &lt;upstream&gt;
-        &lt;maintainer&gt;
+        &lt;maintainer status=&quot;inactive&quot;&gt;
                 &lt;name&gt;Foo Bar&lt;/name&gt;
                 &lt;email&gt;foo&#64;bar.bar&lt;/email&gt;
         &lt;/maintainer&gt;
+        &lt;maintainer status=&quot;active&quot;&gt;
+                &lt;name&gt;Foo Gentoo&lt;/name&gt;
+                &lt;email&gt;foo&#64;gentoo.org&lt;/email&gt;
+        &lt;/maintainer&gt;
         &lt;changelog&gt;http://foo.bar/changelog.txt&lt;/changelog&gt;
+        &lt;doc lang=&quot;en&quot;&gt;http://foo.bar/doc/index.html&lt;/doc&gt;
+        &lt;doc lang=&quot;de&quot;&gt;http://foo.bar./doc/index.de.html&lt;/doc&gt;
         &lt;bugs-to&gt;https://bugs.foo.bar&lt;/bugs-to&gt;
-        &lt;remote-id type=&quot;freshmeat&quot;&gt;12345&lt;/remote-id&gt;
+        &lt;remote-id type=&quot;freshmeat&quot;&gt;foobar&lt;/remote-id&gt;
         &lt;remote-id type=&quot;sourceforge&quot;&gt;foobar&lt;/remote-id&gt;
 &lt;/upstream&gt;
 </pre>
@@ -134,8 +157,9 @@
 <div class="section">
 <h1><a class="toc-backref" href="#id5" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
 <p>No changes are necessary to existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files. Information
-in the new tags is not be mandatory. Any sane tool that currently
-handles <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files will simply ignore unrecognised elements.</p>
+in the new tags is not mandatory. Tools that currently read
+<tt class="docutils literal"><span class="pre">metadata.xml</span></tt> files may break if written poorly; well written tools
+should just ignore the additional elements.</p>
 </div>
 <div class="section">
 <h1><a class="toc-backref" href="#id6" id="copyright" name="copyright">Copyright</a></h1>
@@ -147,7 +171,7 @@
 <div class="footer">
 <hr class="footer" />
 <a class="reference" href="glep-0046.txt">View document source</a>.
-Generated on: 2007-10-13 13:39 UTC.
+Generated on: 2008-01-24 12:57 UTC.
 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.
 
 </div>



1.4                  xml/htdocs/proj/en/glep/glep-0046.txt

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt?rev=1.4&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt?rev=1.4&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt?r1=1.3&r2=1.4

Index: glep-0046.txt
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- glep-0046.txt	21 Apr 2007 03:13:16 -0000	1.3
+++ glep-0046.txt	24 Jan 2008 13:00:09 -0000	1.4
@@ -1,13 +1,13 @@
 GLEP: 46
 Title: Allow upstream tags in metadata.xml
-Version: $Revision: 1.3 $
-Last-Modified: $Date: 2007/04/21 03:13:16 $
-Author: Marcelo Goes <vanquirius@g.o>, Ciaran McCreesh <ciaranm@g.o>
+Version: $Revision: 1.4 $
+Last-Modified: $Date: 2008/01/24 13:00:09 $
+Author: Marcelo Goes <vanquirius@g.o>, Ciaran McCreesh <ciaranm@g.o>, Tiziano Müller <dev-zero@g.o>
 Status: Deferred
 Type: Standards Track
 Content-Type: text/x-rst
 Created: 26-Dec-2005
-Post-History: 26-Dec-2005, 5-Mar-2006
+Post-History: 26-Dec-2005, 5-Mar-2006, 24-Jan-2008
 
 Abstract
 ========
@@ -44,6 +44,9 @@
 * It will reduce the time spent by developers trying to find how to
   contact upstream.
 
+* It will give treecleaners additional information to decide whether
+  a package can be removed from the tree.
+
 Specification
 =============
 
@@ -51,22 +54,39 @@
 ``metadata.xml``.  Inside the upstream tag, developers should be able to
 add upstream related information.
 
-This GLEP defines the following four tags for ``upstream``:
-``maintainer``, ``changelog``, ``bugs-to`` and ``remote-id``, none of
+This GLEP defines the following five tags for ``upstream``:
+``maintainer``, ``changelog``, ``bugs-to``, ``remote-id`` and ``doc`` none of
 which are mandatory. Future GLEPs may extend this -- tools processing
 metadata.xml should ignore unrecognized elements.
 
 ``maintainer`` can contain the tags ``name`` and ``email``, indicating
 the person or organization responsible for upstream maintainership of
-the package.
+the package. The tag may appear more than once.
+
+The ``maintainer`` element has a ``status`` attribute, which is one of
+``active`` or ``inactive``. This attribute is not mandatory. The absence of it
+shall be interpreted as ``unknown``.
+
+The ``maintainer`` element can be the same as the top-level ``maintainer``
+element in cases where a developer decides to maintain the package in
+addition to/instead of the original upstream. In such cases a ``maintainer``
+entry for the original upstream should be present.
 
-``name`` should contain a block of text with upstream's name.
+``name`` should contain a block of text with upstream's name, is mandatory
+and can only appear once.
 
-``email`` should contain an e-mail address in the format foo@...
+``email`` should contain an e-mail address in the format ``foo@...``.
 
 ``changelog`` should contain a URL prefixed with ``http://`` or
 ``https://`` where the location of the upstream changelog can be found.
 
+``doc`` should contain a URL prefixed with  with ``http://`` or
+``https://`` where the location of the upstream documentation can be found.
+The link must not point to any third party documentation and must be version
+independent. If the documentation is available in more than one language, a
+``lang`` attribute can be used which follows the same rules as the one
+for ``longdescription``.
+
 ``bugs-to`` should contain a place where bugs can be filed, a URL
 prefixed with ``http://`` or ``https://`` or an e-mail address prefixed
 with ``mailto:``.
@@ -82,18 +102,25 @@
 which case the element content should be the ``vim.org`` script
 identifier. This GLEP does not specify a complete list of legal values
 for ``type`` -- developers should email the ``gentoo-dev`` mailing list
-before using a new ``type`` value.
+before using a new ``type`` value. The list of valid tags should be kept
+in ``metadata/dtd/remote-id-tags.dtd``.
 
 For example, a ``metadata.xml`` upstream snippet may look like::
 
 	<upstream>
-		<maintainer>
+		<maintainer status="inactive">
 			<name>Foo Bar</name>
 			<email>foo@...</email>
 		</maintainer>
+		<maintainer status="active">
+			<name>Foo Gentoo</name>
+			<email>foo@g.o</email>
+		</maintainer>
 		<changelog>http://foo.bar/changelog.txt</changelog>
+		<doc lang="en">http://foo.bar/doc/index.html</doc>
+		<doc lang="de">http://foo.bar./doc/index.de.html</doc>
 		<bugs-to>https://bugs.foo.bar</bugs-to>
-		<remote-id type="freshmeat">12345</remote-id>
+		<remote-id type="freshmeat">foobar</remote-id>
 		<remote-id type="sourceforge">foobar</remote-id>
 	</upstream>
 
@@ -102,8 +129,9 @@
 =======================
 
 No changes are necessary to existing ``metadata.xml`` files. Information
-in the new tags is not be mandatory. Any sane tool that currently
-handles ``metadata.xml`` files will simply ignore unrecognised elements.
+in the new tags is not mandatory. Tools that currently read
+``metadata.xml`` files may break if written poorly; well written tools
+should just ignore the additional elements.
 
 Copyright
 =========



-- 
gentoo-commits@g.o mailing list


Navigation:
Lists: gentoo-commits: < Prev By Thread Next > < Prev By Date Next >
Previous by thread:
gentoo-x86 commit in x11-drivers/xf86-video-i810: ChangeLog xf86-video-i810-2.2.1_pre20080123.ebuild
Next by thread:
gentoo commit in xml/htdocs/proj/en/glep: glep-0046.html
Previous by date:
gentoo-x86 commit in x11-drivers/xf86-video-i810: ChangeLog xf86-video-i810-2.2.1_pre20080123.ebuild
Next by date:
gentoo commit in xml/htdocs/proj/en/glep: glep-0046.html


Updated Jul 13, 2010

Summary: Archive of the gentoo-commits mailing list.

Donate to support our development efforts.

Copyright 2001-2013 Gentoo Foundation, Inc. Questions, Comments? Contact us.