[gentoo-commits] gentoo commit in xml/htdocs/proj/en/devrel/handbook: hb-guide-metadata.xml

[Joshua Saddler (nightmorph)]

nightmorph    08/09/11 09:22:03

  Modified:             hb-guide-metadata.xml
  Log:
  adding more tags stuff, this time to the developer handbook. bug 234730. with calchan's blessing.

Revision  Changes    Path
1.14                 xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?rev=1.14&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?rev=1.14&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?r1=1.13&r2=1.14

Index: hb-guide-metadata.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- hb-guide-metadata.xml	15 Jul 2008 19:31:51 -0000	1.13
+++ hb-guide-metadata.xml	11 Sep 2008 09:22:03 -0000	1.14
@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <!DOCTYPE sections SYSTEM "/dtd/book.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml,v 1.13 2008/07/15 19:31:51 betelgeuse Exp $-->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml,v 1.14 2008/09/11 09:22:03 nightmorph Exp $-->
 
 <!-- The content of this document is licensed under the CC-BY-SA license -->
 <!-- See http://creativecommons.org/licenses/by-sa/1.0 -->
@@ -10,8 +10,8 @@
 -->
 
 <sections>
-<version>1.0.6</version>
-<date>2008-07-10</date>
+<version>1.0.7</version>
+<date>2008-09-11</date>
 
 <section>
 <title>Why the need for metadata.xml?</title>
@@ -139,6 +139,66 @@
   </ti>
 </tr>
 <tr>
+  <ti><brite>&lt;upstream&gt;</brite></ti>
+  <ti>
+    This tag contains information about the upstream developers/project.
+  </ti>
+</tr>
+<tr>
+  <ti><brite>&lt;maintainer&gt;</brite></ti>
+  <ti>
+    Name and e-mail of an upstream maintainer. May appear more than once.
+  </ti>
+</tr>
+<tr>
+  <ti><brite>&lt;name&gt;</brite></ti>
+  <ti>
+    The name of an usptream maintainer should contain a block of text with upstream's name.
+    This element is mandatory for an upstream maintainer and must appear only once.
+  </ti>
+</tr>
+<tr>
+  <ti><brite>&lt;email&gt;</brite></ti>
+  <ti>
+    The email address of an upstream may appear only once.
+  </ti>
+</tr>
+<tr>
+  <ti><brite>&lt;changelog&gt;</brite></ti>
+  <ti>
+    Should contain a URL where the location of the upstream changelog can be found.
+    The URL must be version independent and must point to a changelog which is only
+    updated on new releases of the corresponding package. (This also implies that
+    one can link to an automatically updated changelog in case of vcs snapshots
+    only.)
+  </ti>
+</tr>
+<tr>
+  <ti><brite>&lt;doc&gt;</brite></ti>
+  <ti>
+    Should contain a URL 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.
+  </ti>
+</tr>
+<tr>
+  <ti><brite>&lt;bugs-to&gt;</brite></ti>
+  <ti>
+    Should contain a place where bugs can be filed, a URL or an e-mail address prefixed
+    with mailto:.
+  </ti>
+</tr>
+<tr>
+  <ti><brite>&lt;remote-id&gt;</brite></ti>
+  <ti>
+    Should specify a type of package identification tracker and the identification that
+    corresponds to the package in question. remote-id should make it easier to index
+    information such as its Freshmeat ID or its CPAN name.
+  </ti>
+</tr>
+<tr>
   <ti><brite>&lt;pkg&gt;</brite></ti>
   <ti>
     This tag contains a valid package name in the format of a DEPEND.
@@ -168,7 +228,7 @@
   <ti>lang</ti>
   <ti>
     <brite>&lt;description&gt;</brite>, <brite>&lt;longdescription&gt;</brite>,
-    <brite>&lt;use&gt;</brite>
+    <brite>&lt;use&gt;</brite>, <brite>&lt;doc&gt;</brite>
   </ti>
   <ti>
     In every case where a description is required, there must be at
@@ -212,6 +272,28 @@
     Enables ACPI&lt;/flag&gt;</c>
   </ti>
 </tr>
+<tr>
+  <ti>status</ti>
+  <ti>
+    <brite>&lt;maintainer&gt;</brite>
+  </ti>
+  <ti>
+    The upstream 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.
+    Please note: This attribute is only allowed in the &lt;upstream&gt; &lt;maintainer&gt; element!
+  </ti>
+</tr>
+<tr>
+  <ti>type</ti>
+  <ti>
+    <brite>&lt;remote-id&gt;</brite>
+  </ti>
+  <ti>
+    A string identifying the type of upstream source. A list of valid strings are kept in metadata.dtd.
+    Developers should email the gentoo-dev mailing list before using a new type value. 
+  </ti>
+</tr>
+
 </table>
 
 </body>
@@ -357,5 +439,34 @@
 
 </body>
 </subsection>
+<subsection>
+<title>Fourth Example</title>
+<body>
+
+<p>
+This example demonstrates the usage of the upstream element:
+</p>
+
+<pre caption="Upstream description">
+&lt;upstream&gt;
+        &lt;maintainer status="inactive"&gt;
+                &lt;name&gt;Foo Bar&lt;/name&gt;
+                &lt;email&gt;foo@×××.bar&lt;/email&gt;
+        &lt;/maintainer&gt;
+        &lt;maintainer status="active"&gt;
+                &lt;name&gt;Foo Gentoo&lt;/name&gt;
+                &lt;email&gt;foo@g.o&lt;/email&gt;
+        &lt;/maintainer&gt;
+        &lt;changelog&gt;http://foo.bar/changelog.txt&lt;/changelog&gt;
+        &lt;doc lang="en"&gt;http://foo.bar/doc/index.html&lt;/doc&gt;
+        &lt;doc lang="de"&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="freshmeat"&gt;foobar&lt;/remote-id&gt;
+        &lt;remote-id type="sourceforge"&gt;foobar&lt;/remote-id&gt;
+&lt;/upstream&gt;
+</pre>
+
+</body>
+</subsection>
 </section>
 </sections>