--- xml/htdocs/proj/en/glep/glep-0046.txt 2008/01/24 13:00:09 1.4 +++ xml/htdocs/proj/en/glep/glep-0046.txt 2008/04/03 13:35:26 1.5 @@ -1,7 +1,7 @@ GLEP: 46 Title: Allow upstream tags in metadata.xml -Version: $Revision: 1.4 $ -Last-Modified: $Date: 2008/01/24 13:00:09 $ +Version: $Revision: 1.5 $ +Last-Modified: $Date: 2008/04/03 13:35:26 $ Author: Marcelo Goes , Ciaran McCreesh , Tiziano Müller Status: Deferred Type: Standards Track @@ -77,19 +77,20 @@ ``email`` should contain an e-mail address in the format ``foo@bar.bar``. -``changelog`` should contain a URL prefixed with ``http://`` or -``https://`` where the location of the upstream changelog can be found. +``changelog`` 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.) + +``doc`` 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``. -``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:``. +``bugs-to`` should contain a place where bugs can be filed, a URL or an +e-mail address prefixed with ``mailto:``. ``remote-id`` should specify a type of package identification tracker and the identification that corresponds to the package in question. @@ -103,7 +104,7 @@ 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. The list of valid tags should be kept -in ``metadata/dtd/remote-id-tags.dtd``. +in ``metadata/dtd/remote-id-tags.dtd`` or ``metadata/dtd/metadata.dtd``. For example, a ``metadata.xml`` upstream snippet may look like:: @@ -118,7 +119,7 @@ http://foo.bar/changelog.txt http://foo.bar/doc/index.html - http://foo.bar./doc/index.de.html + http://foo.bar/doc/index.de.html https://bugs.foo.bar foobar foobar @@ -133,6 +134,15 @@ ``metadata.xml`` files may break if written poorly; well written tools should just ignore the additional elements. +Notes +===== + +The specified URLs must include a protocol as described in RFC 3986. +Furthermore the most common protocol should be used in case of several +possibilities (http should be favoured over https or ftp over gopher or svn, +etc). + + Copyright =========