| 1 |
GLEP: 46
|
| 2 |
Title: Allow upstream tags in metadata.xml
|
| 3 |
Version: $Revision: 1.0 $
|
| 4 |
Last-Modified: $Date: 2005/12/26 20:00:00 $
|
| 5 |
Author: Marcelo Goes <vanquirius@gentoo.org>, Ciaran McCreesh <ciaranm@gentoo.org>
|
| 6 |
Status: Draft
|
| 7 |
Type: Standards Track
|
| 8 |
Content-Type: text/x-rst
|
| 9 |
Created: 26-Dec-2005
|
| 10 |
|
| 11 |
Abstract
|
| 12 |
========
|
| 13 |
|
| 14 |
``metadata.xml`` should allow the use of tags to add information related to
|
| 15 |
upstream, such as who the upstream maintainers are, the upstream changelog and
|
| 16 |
where to report bugs.
|
| 17 |
|
| 18 |
|
| 19 |
Motivation
|
| 20 |
==========
|
| 21 |
|
| 22 |
Allowing developers to add upstream information in ``metadata.xml`` will make it
|
| 23 |
easier, faster and more reliable to share it with other developers. Having
|
| 24 |
information from upstream should avoid duplicated work in tasks such as browsing
|
| 25 |
upstream's Homepage and mailing lists.
|
| 26 |
|
| 27 |
|
| 28 |
Specification
|
| 29 |
=============
|
| 30 |
|
| 31 |
``metadata.dtd`` should allow the use of a upstream tag in ``metadata.xml``.
|
| 32 |
Inside the upstream tag, developers should be able to add upstream information
|
| 33 |
in the tags named ``maintainer, ``changelog``, ``bugs-to`` and ``remote-id``.
|
| 34 |
|
| 35 |
This GLEP defines the following four tags for ``upstream``:
|
| 36 |
``maintainer``, ``changelog``, ``bugs-to`` and ``remote-id``, none of which are
|
| 37 |
mandatory. Future GLEPs may extend this -- tools processing metadata.xml should
|
| 38 |
ignore unrecognized elements.
|
| 39 |
|
| 40 |
``maintainer`` can contain the tags ``name`` and ``email``, indicating the
|
| 41 |
person/organization responsible for upstream maintainership of the package.
|
| 42 |
|
| 43 |
``name`` should contain a block of text with upstream's name.
|
| 44 |
|
| 45 |
``email`` should contain an e-mail address in the format foo@bar.bar.
|
| 46 |
|
| 47 |
``changelog`` should contain a URL prefixed with http or https where the
|
| 48 |
location of the upstream changelog can be found.
|
| 49 |
|
| 50 |
``bugs-to`` should contain a place where bugs can be filed, a URL prefixed with
|
| 51 |
http or https or an e-mail address.
|
| 52 |
|
| 53 |
``remote-id`` should specify a type of package identification tracker and the
|
| 54 |
identification that corresponds to the package in question. ``remote-id`` should
|
| 55 |
make it easier to index information like its identification in freshmeat or its
|
| 56 |
cpan identification.
|
| 57 |
|
| 58 |
For example::
|
| 59 |
|
| 60 |
<upstream>
|
| 61 |
<maintainer>
|
| 62 |
<name>Foo Bar</name>
|
| 63 |
<email>foo@bar.bar</email>
|
| 64 |
</maintainer>
|
| 65 |
<changelog>http://foo.bar/changelog.txt</changelog>
|
| 66 |
<bugs-to>https://bugs.foo.bar</bugs-to>
|
| 67 |
<remote-id type="freshmeat">12345</remote-id>
|
| 68 |
<remote-id type="sourceforge">foobar</remote-id>
|
| 69 |
</upstream>
|
| 70 |
|
| 71 |
|
| 72 |
Backwards Compatibility
|
| 73 |
=======================
|
| 74 |
|
| 75 |
No changes are necessary to existing ``metadata.xml``. Information in the new
|
| 76 |
tags should not be mandatory.
|
| 77 |
|
| 78 |
|
| 79 |
Copyright
|
| 80 |
=========
|
| 81 |
|
| 82 |
This document has been placed in the public domain.
|
| 83 |
|
Parent Directory
| 
Revision Log