From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from lists.gentoo.org ([140.105.134.102] helo=robin.gentoo.org) by nuthatch.gentoo.org with esmtp (Exim 4.54) id 1FFy3X-0005wW-7m for garchives@archives.gentoo.org; Sun, 05 Mar 2006 18:34:11 +0000 Received: from robin.gentoo.org (localhost [127.0.0.1]) by robin.gentoo.org (8.13.5/8.13.5) with SMTP id k25IWxNV004259; Sun, 5 Mar 2006 18:32:59 GMT Received: from smtp.gentoo.org (smtp.gentoo.org [134.68.220.30]) by robin.gentoo.org (8.13.5/8.13.5) with ESMTP id k25ITx6V016236 for ; Sun, 5 Mar 2006 18:29:59 GMT Received: from wproxy.gmail.com ([64.233.184.201]) by smtp.gentoo.org with esmtp (Exim 4.54) id 1FFxzS-00038q-SW for gentoo-dev@lists.gentoo.org; Sun, 05 Mar 2006 18:29:58 +0000 Received: by wproxy.gmail.com with SMTP id 69so995589wra for ; Sun, 05 Mar 2006 10:29:58 -0800 (PST) DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:message-id:date:from:sender:to:subject:mime-version:content-type; b=OnnhsuTsjdsokwMqyCR85AY8g+/y1R/inJSRVf2SLln1pgwyVQk5/RScNjg7dLFS7K766PZWR0J8LR2Fyc+aTW/gJL+n6nIdV/DrTWl8DbQbSEyUPUPBSvf70O1teuFvWJwKbupapKqE7vRQtizjrh7W+zwCO7wipgC0v5lFum4= Received: by 10.54.140.20 with SMTP id n20mr3059217wrd; Sun, 05 Mar 2006 10:29:58 -0800 (PST) Received: by 10.54.122.18 with HTTP; Sun, 5 Mar 2006 10:29:58 -0800 (PST) Message-ID: <9e83288a0603051029nf7504bl3692885566d5e147@mail.gmail.com> Date: Sun, 5 Mar 2006 15:29:58 -0300 From: "=?ISO-8859-1?Q?Marcelo_G=F3es?=" Sender: marcelogoes@gmail.com To: gentoo-dev@lists.gentoo.org Subject: [gentoo-dev] New Glep 46 Draft: Allow upstream tags in metadata.xml Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@gentoo.org Reply-to: gentoo-dev@lists.gentoo.org MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="----=_Part_13618_8360489.1141583398423" X-Archives-Salt: d84f4484-a97a-40fc-a298-c1f340c81986 X-Archives-Hash: 64edc6e2ca4cd0ba9eb296d503699cfe ------=_Part_13618_8360489.1141583398423 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable Content-Disposition: inline Hello, I am basically mailing this new draft on behalf of Ciaran, I just ok'd it := -). Please read and comment. Cheers, Marcelo -- Marcelo G=F3es marcelogoes@gmail.com vanquirius@gentoo.org ------=_Part_13618_8360489.1141583398423 Content-Type: text/plain; name=glep-0046.txt; charset=us-ascii Content-Transfer-Encoding: 7bit X-Attachment-Id: f_ekfpawy6 Content-Disposition: attachment; filename="glep-0046.txt" GLEP: 46 Title: Allow upstream tags in metadata.xml Version: $Revision: 1.1 $ Last-Modified: $Date: 2005/12/27 00:26:58 $ Author: Marcelo Goes , Ciaran McCreesh Status: Draft Type: Standards Track Content-Type: text/x-rst Created: 26-Dec-2005 Abstract ======== Tree ``metadata.xml`` files are currently used to specify maintainer and description information for packages. This GLEP proposes extensions to ``metadata.xml`` to allow storage of information about upstream. Motivation ========== The range of upstream-related data currently available to developers and tool authors is currently limited to ``DESCRIPTION`` and ``HOMEPAGE`` in ebuilds. There have been several attempts at creating tools that check a package's versions against Freshmeat to see whether an ebuild version bump is required. Currently identifying a package's Freshmeat entry is a matter of guesswork, and not something that can reliably be automated. Similarly, various scripts exist to check a package's status against a specialist external data source. One of the authors, for example, has a shell script hack that tries to determine whether any ``app-vim`` packages need bumping by checking the associated ``vim.org`` script page. Again, tying packages to external data source entries is not particulaly straight forward. Making additional upstream-related data easily available will have other benefits: * It will allow systems such as the Packages website to provide more useful information to end users. * It will reduce the time spent by developers trying to find how to contact upstream. Specification ============= ``metadata.dtd`` should allow the use of a upstream tag in ``metadata.xml``. Inside the upstream tag, developers should be able to add upstream related information. This GLEP defines the following four tags for ``upstream``: ``maintainer``, ``changelog``, ``bugs-to`` and ``remote-id``, none of which are mandatory. Future GLEPs may extend this -- tools processing metadata.xml should ignore unrecognized elements. ``maintainer`` can contain the tags ``name`` and ``email``, indicating the person or organization responsible for upstream maintainership of the package. ``name`` should contain a block of text with upstream's name. ``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. ``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:``. ``remote-id`` 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. The ``remote-id`` element has a ``type`` attribute, which is a string identifying the type of upstream source. Examples are ``freshmeat``, in which case the element content should be the Freshmeat ID or ``vim``, in which case the element content should be the ``vim.org`` script 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. For example, a ``metadata.xml`` upstream snippet may look like:: Foo Bar foo@bar.bar http://foo.bar/changelog.txt https://bugs.foo.bar 12345 foobar Backwards Compatibility ======================= No changes are necessary to existing ``metadata.xml`` files. Information in the new tags is not be mandatory. Any sane tool that currently handles ``metadata.xml`` files will simply ignore unrecognised elements. Copyright ========= This document has been placed in the public domain. .. vim: set ft=glep tw=72 : ------=_Part_13618_8360489.1141583398423-- -- gentoo-dev@gentoo.org mailing list