/[gentoo]/xml/htdocs/proj/en/glep/glep-0046.txt
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0046.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.4 Revision 1.5
1GLEP: 46 1GLEP: 46
2Title: Allow upstream tags in metadata.xml 2Title: Allow upstream tags in metadata.xml
3Version: $Revision: 1.4 $ 3Version: $Revision: 1.5 $
4Last-Modified: $Date: 2008/01/24 13:00:09 $ 4Last-Modified: $Date: 2008/04/03 13:35:26 $
5Author: Marcelo Goes <vanquirius@gentoo.org>, Ciaran McCreesh <ciaranm@gentoo.org>, Tiziano Müller <dev-zero@gentoo.org> 5Author: Marcelo Goes <vanquirius@gentoo.org>, Ciaran McCreesh <ciaranm@gentoo.org>, Tiziano Müller <dev-zero@gentoo.org>
6Status: Deferred 6Status: Deferred
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 26-Dec-2005 9Created: 26-Dec-2005
75``name`` should contain a block of text with upstream's name, is mandatory 75``name`` should contain a block of text with upstream's name, is mandatory
76and can only appear once. 76and can only appear once.
77 77
78``email`` should contain an e-mail address in the format ``foo@bar.bar``. 78``email`` should contain an e-mail address in the format ``foo@bar.bar``.
79 79
80``changelog`` should contain a URL prefixed with ``http://`` or 80``changelog`` should contain a URL where the location of the upstream
81``https://`` where the location of the upstream changelog can be found. 81changelog can be found. The URL must be version independent and must point to
82a changelog which is only updated on new releases of the corresponding
83package. (This also implies that one can link to an automatically updated
84changelog in case of vcs snapshots only.)
82 85
83``doc`` should contain a URL prefixed with with ``http://`` or 86``doc`` should contain a URL where the location of the upstream
84``https://`` where the location of the upstream documentation can be found. 87documentation can be found. The link must not point to any third party
85The link must not point to any third party documentation and must be version 88documentation and must be version independent. If the documentation is
86independent. If the documentation is available in more than one language, a 89available in more than one language, a ``lang`` attribute can be used
87``lang`` attribute can be used which follows the same rules as the one 90which follows the same rules as the one for ``longdescription``.
88for ``longdescription``.
89 91
90``bugs-to`` should contain a place where bugs can be filed, a URL 92``bugs-to`` should contain a place where bugs can be filed, a URL or an
91prefixed with ``http://`` or ``https://`` or an e-mail address prefixed 93e-mail address prefixed with ``mailto:``.
92with ``mailto:``.
93 94
94``remote-id`` should specify a type of package identification tracker 95``remote-id`` should specify a type of package identification tracker
95and the identification that corresponds to the package in question. 96and the identification that corresponds to the package in question.
96``remote-id`` should make it easier to index information such as its 97``remote-id`` should make it easier to index information such as its
97Freshmeat ID or its CPAN name. 98Freshmeat ID or its CPAN name.
101which case the element content should be the Freshmeat ID or ``vim``, in 102which case the element content should be the Freshmeat ID or ``vim``, in
102which case the element content should be the ``vim.org`` script 103which case the element content should be the ``vim.org`` script
103identifier. This GLEP does not specify a complete list of legal values 104identifier. This GLEP does not specify a complete list of legal values
104for ``type`` -- developers should email the ``gentoo-dev`` mailing list 105for ``type`` -- developers should email the ``gentoo-dev`` mailing list
105before using a new ``type`` value. The list of valid tags should be kept 106before using a new ``type`` value. The list of valid tags should be kept
106in ``metadata/dtd/remote-id-tags.dtd``. 107in ``metadata/dtd/remote-id-tags.dtd`` or ``metadata/dtd/metadata.dtd``.
107 108
108For example, a ``metadata.xml`` upstream snippet may look like:: 109For example, a ``metadata.xml`` upstream snippet may look like::
109 110
110 <upstream> 111 <upstream>
111 <maintainer status="inactive"> 112 <maintainer status="inactive">
116 <name>Foo Gentoo</name> 117 <name>Foo Gentoo</name>
117 <email>foo@gentoo.org</email> 118 <email>foo@gentoo.org</email>
118 </maintainer> 119 </maintainer>
119 <changelog>http://foo.bar/changelog.txt</changelog> 120 <changelog>http://foo.bar/changelog.txt</changelog>
120 <doc lang="en">http://foo.bar/doc/index.html</doc> 121 <doc lang="en">http://foo.bar/doc/index.html</doc>
121 <doc lang="de">http://foo.bar./doc/index.de.html</doc> 122 <doc lang="de">http://foo.bar/doc/index.de.html</doc>
122 <bugs-to>https://bugs.foo.bar</bugs-to> 123 <bugs-to>https://bugs.foo.bar</bugs-to>
123 <remote-id type="freshmeat">foobar</remote-id> 124 <remote-id type="freshmeat">foobar</remote-id>
124 <remote-id type="sourceforge">foobar</remote-id> 125 <remote-id type="sourceforge">foobar</remote-id>
125 </upstream> 126 </upstream>
126 127
131No changes are necessary to existing ``metadata.xml`` files. Information 132No changes are necessary to existing ``metadata.xml`` files. Information
132in the new tags is not mandatory. Tools that currently read 133in the new tags is not mandatory. Tools that currently read
133``metadata.xml`` files may break if written poorly; well written tools 134``metadata.xml`` files may break if written poorly; well written tools
134should just ignore the additional elements. 135should just ignore the additional elements.
135 136
137Notes
138=====
139
140The specified URLs must include a protocol as described in RFC 3986.
141Furthermore the most common protocol should be used in case of several
142possibilities (http should be favoured over https or ftp over gopher or svn,
143etc).
144
145
136Copyright 146Copyright
137========= 147=========
138 148
139This document has been placed in the public domain. 149This document has been placed in the public domain.
140 150

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5

  ViewVC Help
Powered by ViewVC 1.1.20