--- xml/htdocs/proj/en/glep/glep-0034.html 2005/11/07 22:26:59 1.5 +++ xml/htdocs/proj/en/glep/glep-0034.html 2006/10/10 20:25:14 1.6 @@ -8,9 +8,252 @@ --> - + GLEP 34 -- Per-Category metadata.xml Files - + @@ -32,17 +275,17 @@ - + - + - + @@ -51,8 +294,8 @@
Title:Per-Category metadata.xml Files
Version:1.4
Version:1.5
Author:Ciaran McCreesh <ciaranm at gentoo.org>
Last-Modified:2005/05/02 20:30:24
Last-Modified:2005/11/07 22:26:59
Status:Final
Type:Standards Track
Content-Type:text/x-rst
Content-Type:text/x-rst
Created:11-Mar-2005

-
-

Contents

+
+

Contents

-
-

Abstract

+
+

Abstract

A metadata.xml file [1] is currently used to provide extra metadata (long descriptions, herd and maintainer information) about a package. It is proposed that these files also be used to describe the purpose of a category.

-
-

Motivation

+
+

Motivation

Category names are short and not entirely clear. Adding arbitrary length long descriptions to categories would provide several advantages:

    @@ -90,8 +333,8 @@ in scope, making any future category splits easier.
-
-

Specification

+
+

Specification

It is proposed that the existing metadata.xml format [1] be used. Even though XML sucks, there is already a framework in place for these files. The filename will be blah-misc/metadata.xml. The character set @@ -109,8 +352,8 @@ the category level. They may be specified as a fall-back "assume that everything in this category is maintained by these people", but this must not be used as a replacement for proper per-package metadata.

-
-

Examples

+
+

Examples

The app-vim category could use a metadata.xml file like the following:

@@ -128,8 +371,8 @@
 </catmetadata>
 
-
-

Implementation Requirements

+
+

Implementation Requirements

The DTD file would need to be updated to include the <catmetadata> element.

A metadata file would have to be added to every category in the tree. This @@ -141,14 +384,14 @@

The metadata documentation [1] would require some additions.

-
-

Backwards Compatibility

+
+

Backwards Compatibility

The metadata DTD will remain backwards compatible.

The category metadata files will need to be considered "optional until implemented" rather than immediately becoming mandatory.

-
-

References

+
+

References

@@ -171,8 +414,8 @@
-