--- xml/htdocs/proj/en/glep/glep-0056.html 2008/07/10 18:24:24 1.2 +++ xml/htdocs/proj/en/glep/glep-0056.html 2008/07/10 22:14:40 1.3 @@ -6,7 +6,250 @@ GLEP 56 -- USE flag descriptions in metadata - + - + - + - + @@ -42,7 +285,7 @@ - + @@ -50,22 +293,22 @@

Contents

-

Abstract

+

Abstract

This GLEP proposes to add per-package USE flag descriptions to each package's metadata.

-

Motivation

+

Motivation

Gives Gentoo users the ability to better identify how USE flags affect their installations of a given package. For example, many global USE flags have very generic descriptions but no specifics on how it affects a certain package. @@ -80,7 +323,7 @@

-

Specification

+

Specification

This GLEP proposes the addition of <use> XML tag that is only allowed to appear inside of a <pkgmetadata> XML tag.

@@ -109,7 +352,7 @@
  • Each <flag> XML tag allows 0 or more nested <pkg> XML tags whose character data is a valid CP or CPV as defined by the -Gentoo Development Guide - Ebuild File Format [5].

    +Gentoo Development Manual - Ebuild File Format [5].

  • Each <flag> XML tag allows 0 or more nested <cat> XML tags whose character data is a valid category.

    @@ -124,10 +367,11 @@
  • -

    Documentation for the Developer Manual and the metadata.dtd can be found in -Gentoo's Bugzilla [1] bug #199788.

    -

    The following are two concrete examples in tree, [2] -and [3].

    +

    Documentation for the Gentoo Developer Handbook [4] and the +metadata.dtd can be found in Gentoo's Bugzilla [1] +bug #199788.

    +

    The following are two concrete examples in tree, [2] +and [3].

    And the following is an embedded example and not from a real package:

     <use>
    @@ -144,36 +388,36 @@
     
    -

    Credits

    +

    Credits

    Thanks to the following persons for their input on or related to this GLEP (even though they might not have known it): Diego Pettenò (flameeyes), Alec Warner (antarus), Joshua Nichols (nichoj), Steve Dibb (beandog), and Tiziano Müller (dev-zero)

    -

    References

    +

    References

    - +
    [1]http://bugs.gentoo.org/show_bug.cgi?id=199788
    [1]http://bugs.gentoo.org/show_bug.cgi?id=199788
    - +
    [2]http://sources.gentoo.org/viewcvs.py/gentoo-x86/sys-apps/hal/metadata.xml?view=markup
    [2]http://sources.gentoo.org/viewcvs.py/gentoo-x86/sys-apps/hal/metadata.xml?view=markup
    - +
    [3]http://sources.gentoo.org/viewcvs.py/gentoo-x86/media-tv/mythtv/metadata.xml?view=markup
    [3]http://sources.gentoo.org/viewcvs.py/gentoo-x86/media-tv/mythtv/metadata.xml?view=markup
    - +
    [4](1, 2) http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4
    [4](1, 2, 3) http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4
    @@ -208,7 +452,7 @@
    -

    Backwards Compatibility

    +

    Backwards Compatibility

    No changes are necessary to existing metadata.xml files. Information in the new tags is not mandatory. Tools that currently read metadata.xml files may break if written poorly, while well written tools should just ignore @@ -226,7 +470,7 @@ in use.local.desc.

    -

    Copyright

    +

    Copyright

    This document is placed into the public domain.

    @@ -235,7 +479,7 @@