Gentoo Archives: gentoo-commits

From: "Tiziano Mueller (dev-zero)" <dev-zero@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] gentoo commit in xml/htdocs/proj/en/glep: glep-0046.txt
Date: Thu, 03 Apr 2008 13:35:30
Message-Id: E1JhPbC-0004xV-LD@stork.gentoo.org
1 dev-zero 08/04/03 13:35:26
2
3 Modified: glep-0046.txt
4 Log:
5 Changed as announced in message to the gentoo.dev mailinglist at 03/25/2008
6
7 Revision Changes Path
8 1.5 xml/htdocs/proj/en/glep/glep-0046.txt
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt?rev=1.5&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt?rev=1.5&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt?r1=1.4&r2=1.5
13
14 Index: glep-0046.txt
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/glep/glep-0046.txt,v
17 retrieving revision 1.4
18 retrieving revision 1.5
19 diff -u -r1.4 -r1.5
20 --- glep-0046.txt 24 Jan 2008 13:00:09 -0000 1.4
21 +++ glep-0046.txt 3 Apr 2008 13:35:26 -0000 1.5
22 @@ -1,7 +1,7 @@
23 GLEP: 46
24 Title: Allow upstream tags in metadata.xml
25 -Version: $Revision: 1.4 $
26 -Last-Modified: $Date: 2008/01/24 13:00:09 $
27 +Version: $Revision: 1.5 $
28 +Last-Modified: $Date: 2008/04/03 13:35:26 $
29 Author: Marcelo Goes <vanquirius@g.o>, Ciaran McCreesh <ciaranm@g.o>, Tiziano Müller <dev-zero@g.o>
30 Status: Deferred
31 Type: Standards Track
32 @@ -77,19 +77,20 @@
33
34 ``email`` should contain an e-mail address in the format ``foo@×××.bar``.
35
36 -``changelog`` should contain a URL prefixed with ``http://`` or
37 -``https://`` where the location of the upstream changelog can be found.
38 +``changelog`` should contain a URL where the location of the upstream
39 +changelog can be found. The URL must be version independent and must point to
40 +a changelog which is only updated on new releases of the corresponding
41 +package. (This also implies that one can link to an automatically updated
42 +changelog in case of vcs snapshots only.)
43 +
44 +``doc`` should contain a URL where the location of the upstream
45 +documentation can be found. The link must not point to any third party
46 +documentation and must be version independent. If the documentation is
47 +available in more than one language, a ``lang`` attribute can be used
48 +which follows the same rules as the one for ``longdescription``.
49
50 -``doc`` should contain a URL prefixed with with ``http://`` or
51 -``https://`` where the location of the upstream documentation can be found.
52 -The link must not point to any third party documentation and must be version
53 -independent. If the documentation is available in more than one language, a
54 -``lang`` attribute can be used which follows the same rules as the one
55 -for ``longdescription``.
56 -
57 -``bugs-to`` should contain a place where bugs can be filed, a URL
58 -prefixed with ``http://`` or ``https://`` or an e-mail address prefixed
59 -with ``mailto:``.
60 +``bugs-to`` should contain a place where bugs can be filed, a URL or an
61 +e-mail address prefixed with ``mailto:``.
62
63 ``remote-id`` should specify a type of package identification tracker
64 and the identification that corresponds to the package in question.
65 @@ -103,7 +104,7 @@
66 identifier. This GLEP does not specify a complete list of legal values
67 for ``type`` -- developers should email the ``gentoo-dev`` mailing list
68 before using a new ``type`` value. The list of valid tags should be kept
69 -in ``metadata/dtd/remote-id-tags.dtd``.
70 +in ``metadata/dtd/remote-id-tags.dtd`` or ``metadata/dtd/metadata.dtd``.
71
72 For example, a ``metadata.xml`` upstream snippet may look like::
73
74 @@ -118,7 +119,7 @@
75 </maintainer>
76 <changelog>http://foo.bar/changelog.txt</changelog>
77 <doc lang="en">http://foo.bar/doc/index.html</doc>
78 - <doc lang="de">http://foo.bar./doc/index.de.html</doc>
79 + <doc lang="de">http://foo.bar/doc/index.de.html</doc>
80 <bugs-to>https://bugs.foo.bar</bugs-to>
81 <remote-id type="freshmeat">foobar</remote-id>
82 <remote-id type="sourceforge">foobar</remote-id>
83 @@ -133,6 +134,15 @@
84 ``metadata.xml`` files may break if written poorly; well written tools
85 should just ignore the additional elements.
86
87 +Notes
88 +=====
89 +
90 +The specified URLs must include a protocol as described in RFC 3986.
91 +Furthermore the most common protocol should be used in case of several
92 +possibilities (http should be favoured over https or ftp over gopher or svn,
93 +etc).
94 +
95 +
96 Copyright
97 =========
98
99
100
101
102 --
103 gentoo-commits@l.g.o mailing list