1 | <?xml version="1.0" encoding="utf-8" ?> |
1 | <?xml version="1.0" encoding="utf-8" ?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
4 | <!-- |
4 | |
5 | This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new |
|
|
6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
|
|
7 | to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
|
|
8 | --> |
|
|
9 | <head> |
5 | <head> |
10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
11 | <meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" /> |
7 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
12 | <title>GLEP 34 -- Per-Category metadata.xml Files</title> |
8 | <title>GLEP 34 -- Per-Category metadata.xml Files</title> |
13 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
9 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
14 | </head> |
10 | </head> |
15 | <body bgcolor="white"> |
11 | <body bgcolor="white"> |
16 | <table class="navigation" cellpadding="0" cellspacing="0" |
12 | <table class="navigation" cellpadding="0" cellspacing="0" |
… | |
… | |
20 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
16 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
21 | border="0" width="150" height="35" /></a></td> |
17 | border="0" width="150" height="35" /></a></td> |
22 | <td class="textlinks" align="left"> |
18 | <td class="textlinks" align="left"> |
23 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
19 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
24 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
20 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
25 | [<b><a href="./glep-0034.txt">GLEP Source</a></b>] |
21 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0034.txt">GLEP Source</a></b>] |
26 | </td></tr></table> |
22 | </td></tr></table> |
27 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
23 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
28 | <col class="field-name" /> |
24 | <col class="field-name" /> |
29 | <col class="field-body" /> |
25 | <col class="field-body" /> |
30 | <tbody valign="top"> |
26 | <tbody valign="top"> |
31 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">34</td> |
27 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">34</td> |
32 | </tr> |
28 | </tr> |
33 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Per-Category metadata.xml Files</td> |
29 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Per-Category metadata.xml Files</td> |
34 | </tr> |
30 | </tr> |
35 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td> |
31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.5</td> |
36 | </tr> |
32 | </tr> |
37 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org></td> |
33 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org></td> |
38 | </tr> |
34 | </tr> |
39 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0034.txt?cvsroot=gentoo">2005/05/02 20:30:24</a></td> |
35 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0034.txt?cvsroot=gentoo">2005/11/07 22:26:59</a></td> |
40 | </tr> |
36 | </tr> |
41 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td> |
37 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td> |
42 | </tr> |
38 | </tr> |
43 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
39 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
44 | </tr> |
40 | </tr> |
45 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> |
41 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> |
46 | </tr> |
42 | </tr> |
47 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">11-March-2005</td> |
43 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">11-Mar-2005</td> |
48 | </tr> |
44 | </tr> |
49 | <tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">11-March-2005, 13-March-2005, 2-May-2005</td> |
45 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">11-Mar-2005, 13-Mar-2005, 2-May-2005</td> |
50 | </tr> |
46 | </tr> |
51 | </tbody> |
47 | </tbody> |
52 | </table> |
48 | </table> |
53 | <hr /> |
49 | <hr /> |
54 | <div class="contents topic" id="contents"> |
50 | <div class="contents topic"> |
55 | <p class="topic-title first"><a name="contents">Contents</a></p> |
51 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
56 | <ul class="simple"> |
52 | <ul class="simple"> |
57 | <li><a class="reference" href="#abstract" id="id9" name="id9">Abstract</a></li> |
53 | <li><a class="reference" href="#abstract" id="id9" name="id9">Abstract</a></li> |
58 | <li><a class="reference" href="#motivation" id="id10" name="id10">Motivation</a></li> |
54 | <li><a class="reference" href="#motivation" id="id10" name="id10">Motivation</a></li> |
59 | <li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul> |
55 | <li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul> |
60 | <li><a class="reference" href="#examples" id="id12" name="id12">Examples</a></li> |
56 | <li><a class="reference" href="#examples" id="id12" name="id12">Examples</a></li> |
… | |
… | |
64 | <li><a class="reference" href="#backwards-compatibility" id="id14" name="id14">Backwards Compatibility</a></li> |
60 | <li><a class="reference" href="#backwards-compatibility" id="id14" name="id14">Backwards Compatibility</a></li> |
65 | <li><a class="reference" href="#references" id="id15" name="id15">References</a></li> |
61 | <li><a class="reference" href="#references" id="id15" name="id15">References</a></li> |
66 | <li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li> |
62 | <li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li> |
67 | </ul> |
63 | </ul> |
68 | </div> |
64 | </div> |
69 | <div class="section" id="abstract"> |
65 | <div class="section"> |
70 | <h1><a class="toc-backref" href="#id9" name="abstract">Abstract</a></h1> |
66 | <h1><a class="toc-backref" href="#id9" id="abstract" name="abstract">Abstract</a></h1> |
71 | <p>A <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> file <a class="footnote-reference" href="#id6" id="id1" name="id1">[1]</a> is currently used to provide extra metadata |
67 | <p>A <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> file <a class="footnote-reference" href="#id6" id="id1" name="id1">[1]</a> is currently used to provide extra metadata |
72 | (long descriptions, herd and maintainer information) about a package. It |
68 | (long descriptions, herd and maintainer information) about a package. It |
73 | is proposed that these files also be used to describe the purpose of a |
69 | is proposed that these files also be used to describe the purpose of a |
74 | category.</p> |
70 | category.</p> |
75 | </div> |
71 | </div> |
76 | <div class="section" id="motivation"> |
72 | <div class="section"> |
77 | <h1><a class="toc-backref" href="#id10" name="motivation">Motivation</a></h1> |
73 | <h1><a class="toc-backref" href="#id10" id="motivation" name="motivation">Motivation</a></h1> |
78 | <p>Category names are short and not entirely clear. Adding arbitrary length |
74 | <p>Category names are short and not entirely clear. Adding arbitrary length |
79 | long descriptions to categories would provide several advantages:</p> |
75 | long descriptions to categories would provide several advantages:</p> |
80 | <ul class="simple"> |
76 | <ul class="simple"> |
81 | <li>It would clarify the meaning of categories for users, who may not be |
77 | <li>It would clarify the meaning of categories for users, who may not be |
82 | aware of some of the abbreviations or acronyms we use.</li> |
78 | aware of some of the abbreviations or acronyms we use.</li> |
… | |
… | |
88 | <tt class="docutils literal"><span class="pre">app-misc</span></tt> as is done currently.</li> |
84 | <tt class="docutils literal"><span class="pre">app-misc</span></tt> as is done currently.</li> |
89 | <li>It would help illustrate which categories are too broad or badly defined |
85 | <li>It would help illustrate which categories are too broad or badly defined |
90 | in scope, making any future category splits easier.</li> |
86 | in scope, making any future category splits easier.</li> |
91 | </ul> |
87 | </ul> |
92 | </div> |
88 | </div> |
93 | <div class="section" id="specification"> |
89 | <div class="section"> |
94 | <h1><a class="toc-backref" href="#id11" name="specification">Specification</a></h1> |
90 | <h1><a class="toc-backref" href="#id11" id="specification" name="specification">Specification</a></h1> |
95 | <p>It is proposed that the existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> format <a class="footnote-reference" href="#id6" id="id2" name="id2">[1]</a> be used. |
91 | <p>It is proposed that the existing <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> format <a class="footnote-reference" href="#id6" id="id2" name="id2">[1]</a> be used. |
96 | Even though XML sucks, there is already a framework in place for these |
92 | Even though XML sucks, there is already a framework in place for these |
97 | files. The filename will be <tt class="docutils literal"><span class="pre">blah-misc/metadata.xml</span></tt>. The character set |
93 | files. The filename will be <tt class="docutils literal"><span class="pre">blah-misc/metadata.xml</span></tt>. The character set |
98 | used shall be UTF-8 for consistency with GLEP 31 <a class="footnote-reference" href="#id7" id="id3" name="id3">[2]</a>.</p> |
94 | used shall be UTF-8 for consistency with GLEP 31 <a class="footnote-reference" href="#id7" id="id3" name="id3">[2]</a>.</p> |
99 | <p>A new top level <tt class="docutils literal"><span class="pre"><catmetadata></span></tt> element shall be added to the DTD. This |
95 | <p>A new top level <tt class="docutils literal"><span class="pre"><catmetadata></span></tt> element shall be added to the DTD. This |
… | |
… | |
107 | English (<tt class="docutils literal"><span class="pre">en</span></tt>) description.</p> |
103 | English (<tt class="docutils literal"><span class="pre">en</span></tt>) description.</p> |
108 | <p>The <tt class="docutils literal"><span class="pre"><herd></span></tt> and <tt class="docutils literal"><span class="pre"><maintainer></span></tt> elements are not generally relevant at |
104 | <p>The <tt class="docutils literal"><span class="pre"><herd></span></tt> and <tt class="docutils literal"><span class="pre"><maintainer></span></tt> elements are not generally relevant at |
109 | the category level. They may be specified as a fall-back "assume that |
105 | the category level. They may be specified as a fall-back "assume that |
110 | everything in this category is maintained by these people", but this must |
106 | everything in this category is maintained by these people", but this must |
111 | not be used as a replacement for proper per-package metadata.</p> |
107 | not be used as a replacement for proper per-package metadata.</p> |
112 | <div class="section" id="examples"> |
108 | <div class="section"> |
113 | <h2><a class="toc-backref" href="#id12" name="examples">Examples</a></h2> |
109 | <h2><a class="toc-backref" href="#id12" id="examples" name="examples">Examples</a></h2> |
114 | <p>The <tt class="docutils literal"><span class="pre">app-vim</span></tt> category could use a <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> file like the |
110 | <p>The <tt class="docutils literal"><span class="pre">app-vim</span></tt> category could use a <tt class="docutils literal"><span class="pre">metadata.xml</span></tt> file like the |
115 | following:</p> |
111 | following:</p> |
116 | <pre class="literal-block"> |
112 | <pre class="literal-block"> |
117 | <?xml version="1.0" encoding="UTF-8"?> |
113 | <?xml version="1.0" encoding="UTF-8"?> |
118 | <!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> |
114 | <!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> |
… | |
… | |
126 | für den Vim Texteditor. |
122 | für den Vim Texteditor. |
127 | </longdescription> |
123 | </longdescription> |
128 | </catmetadata> |
124 | </catmetadata> |
129 | </pre> |
125 | </pre> |
130 | </div> |
126 | </div> |
131 | <div class="section" id="implementation-requirements"> |
127 | <div class="section"> |
132 | <h2><a class="toc-backref" href="#id13" name="implementation-requirements">Implementation Requirements</a></h2> |
128 | <h2><a class="toc-backref" href="#id13" id="implementation-requirements" name="implementation-requirements">Implementation Requirements</a></h2> |
133 | <p>The DTD file would need to be updated to include the <tt class="docutils literal"><span class="pre"><catmetadata></span></tt> |
129 | <p>The DTD file would need to be updated to include the <tt class="docutils literal"><span class="pre"><catmetadata></span></tt> |
134 | element.</p> |
130 | element.</p> |
135 | <p>A metadata file would have to be added to every category in the tree. This |
131 | <p>A metadata file would have to be added to every category in the tree. This |
136 | could be done over a period of time.</p> |
132 | could be done over a period of time.</p> |
137 | <p><tt class="docutils literal"><span class="pre">repoman</span></tt> would need a few small changes to be able to handle |
133 | <p><tt class="docutils literal"><span class="pre">repoman</span></tt> would need a few small changes to be able to handle |
… | |
… | |
139 | <p>The "packages.gentoo.org metadata" bug <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a> would need to be |
135 | <p>The "packages.gentoo.org metadata" bug <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a> would need to be |
140 | updated to ask for category descriptions as well.</p> |
136 | updated to ask for category descriptions as well.</p> |
141 | <p>The metadata documentation <a class="footnote-reference" href="#id6" id="id5" name="id5">[1]</a> would require some additions.</p> |
137 | <p>The metadata documentation <a class="footnote-reference" href="#id6" id="id5" name="id5">[1]</a> would require some additions.</p> |
142 | </div> |
138 | </div> |
143 | </div> |
139 | </div> |
144 | <div class="section" id="backwards-compatibility"> |
140 | <div class="section"> |
145 | <h1><a class="toc-backref" href="#id14" name="backwards-compatibility">Backwards Compatibility</a></h1> |
141 | <h1><a class="toc-backref" href="#id14" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
146 | <p>The metadata DTD will remain backwards compatible.</p> |
142 | <p>The metadata DTD will remain backwards compatible.</p> |
147 | <p>The category metadata files will need to be considered "optional until |
143 | <p>The category metadata files will need to be considered "optional until |
148 | implemented" rather than immediately becoming mandatory.</p> |
144 | implemented" rather than immediately becoming mandatory.</p> |
149 | </div> |
145 | </div> |
150 | <div class="section" id="references"> |
146 | <div class="section"> |
151 | <h1><a class="toc-backref" href="#id15" name="references">References</a></h1> |
147 | <h1><a class="toc-backref" href="#id15" id="references" name="references">References</a></h1> |
152 | <table class="docutils footnote" frame="void" id="id6" rules="none"> |
148 | <table class="docutils footnote" frame="void" id="id6" rules="none"> |
153 | <colgroup><col class="label" /><col /></colgroup> |
149 | <colgroup><col class="label" /><col /></colgroup> |
154 | <tbody valign="top"> |
150 | <tbody valign="top"> |
155 | <tr><td class="label"><a name="id6">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id5">3</a>)</em> Gentoo Metadata, |
151 | <tr><td class="label"><a name="id6">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id5">3</a>)</em> Gentoo Metadata, |
156 | (<a class="reference" href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4</a>)</td></tr> |
152 | (<a class="reference" href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4</a>)</td></tr> |
… | |
… | |
169 | <tr><td class="label"><a class="fn-backref" href="#id4" name="id8">[3]</a></td><td>Gentoo bug 66917 |
165 | <tr><td class="label"><a class="fn-backref" href="#id4" name="id8">[3]</a></td><td>Gentoo bug 66917 |
170 | (<a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=66917">http://bugs.gentoo.org/show_bug.cgi?id=66917</a>)</td></tr> |
166 | (<a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=66917">http://bugs.gentoo.org/show_bug.cgi?id=66917</a>)</td></tr> |
171 | </tbody> |
167 | </tbody> |
172 | </table> |
168 | </table> |
173 | </div> |
169 | </div> |
174 | <div class="section" id="copyright"> |
170 | <div class="section"> |
175 | <h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1> |
171 | <h1><a class="toc-backref" href="#id16" id="copyright" name="copyright">Copyright</a></h1> |
176 | <p>This document has been placed in the public domain.</p> |
172 | <p>This document has been placed in the public domain.</p> |
177 | <!-- vim: set tw=74 fileencoding=utf-8 : --> |
173 | <!-- vim: set tw=74 fileencoding=utf-8 : --> |
178 | </div> |
174 | </div> |
179 | |
175 | |
180 | </div> |
176 | </div> |
181 | <hr class="docutils footer" /> |
|
|
182 | <div class="footer"> |
177 | <div class="footer"> |
|
|
178 | <hr class="footer" /> |
183 | <a class="reference" href="glep-0034.txt">View document source</a>. |
179 | <a class="reference" href="glep-0034.txt">View document source</a>. |
184 | Generated on: 2005-05-02 20:34 UTC. |
180 | Generated on: 2007-10-13 13:39 UTC. |
185 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
181 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
|
|
182 | |
186 | </div> |
183 | </div> |
187 | </body> |
184 | </body> |
188 | </html> |
185 | </html> |
189 | |
186 | |