en/glep/glep-0005.txt

GLEP: 5
Title: Extending metadata.xml
Version: $Revision: 1.2 $
Last-Modified: $Date: 2003/07/03 05:38:42 $
Author: Heinrich Wendel <sysop@heinospage.de>,
Status: deferred
Type: Standards Track
Content-Type: text/x-rst
Created: 02-Jul-2003
Post-History: 02-Jul-2003, 11-Nov-2004


Abstract
========

As the latest development in Gentoo and Portage added the metadata.xml file
to each package, which provides information about the package and it's
maintainers, this GLEP proposes to extend this format in order to simplify
the .ebuild format.


Status
======

Timed out


Motivation
==========

The metadata.xml [1]_ standard was accepted and it already contains some
information about the packages (longdescription).


Specification
=============

Add the tags <description> <homepage> <license> to the metadata.xml [1]_ and
remove them from the .ebuild files.  All ebuilds and the emerge -S feature
have to be changed to use the new format.


Rationale
=========

The three tags description, homepage and license are mostly the same in all
versions of an ebuild, but they must be added to each version. In order to
simplify the .ebuild format they can be moved to the new metadata.xml [1]_ file.
This would also allow different descriptions for different languages (lang
attribute) and there are no problems when a programm changes it license
(restrict attribute).


Backwards Compatibility
=======================

As it will take some time to do the changes on every ebuild, portage should still
support the old format for some time.


Reference Implementation
========================

not yet ...


References
==========

.. [1] Gentoo Herds Project
   [http://www.gentoo.org/proj/en/metastructure/herds/#doc_chap2]

Copyright
=========

This document has been placed in the public domain.
1	GLEP: 5
2	Title: Extending metadata.xml
3	Version: $Revision: 1.2 $
4	Last-Modified: $Date: 2003/07/03 05:38:42 $
5	Author: Heinrich Wendel <sysop@heinospage.de>,
6	Status: deferred
7	Type: Standards Track
8	Content-Type: text/x-rst
9	Created: 02-Jul-2003
10	Post-History: 02-Jul-2003, 11-Nov-2004
11
12
13	Abstract
14	========
15
16	As the latest development in Gentoo and Portage added the metadata.xml file
17	to each package, which provides information about the package and it's
18	maintainers, this GLEP proposes to extend this format in order to simplify
19	the .ebuild format.
20
21
22	Status
23	======
24
25	Timed out
26
27
28	Motivation
29	==========
30
31	The metadata.xml [1]_ standard was accepted and it already contains some
32	information about the packages (longdescription).
33
34
35	Specification
36	=============
37
38	Add the tags <description> <homepage> <license> to the metadata.xml [1]_ and
39	remove them from the .ebuild files. All ebuilds and the emerge -S feature
40	have to be changed to use the new format.
41
42
43	Rationale
44	=========
45
46	The three tags description, homepage and license are mostly the same in all
47	versions of an ebuild, but they must be added to each version. In order to
48	simplify the .ebuild format they can be moved to the new metadata.xml [1]_ file.
49	This would also allow different descriptions for different languages (lang
50	attribute) and there are no problems when a programm changes it license
51	(restrict attribute).
52
53
54	Backwards Compatibility
55	=======================
56
57	As it will take some time to do the changes on every ebuild, portage should still
58	support the old format for some time.
59
60
61	Reference Implementation
62	========================
63
64	not yet ...
65
66
67	References
68	==========
69
70	.. [1] Gentoo Herds Project
71	[http://www.gentoo.org/proj/en/metastructure/herds/#doc_chap2]
72
73	Copyright
74	=========
75
76	This document has been placed in the public domain.