/[gentoo]/xml/htdocs/proj/en/glep/glep-0034.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0034.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.4
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.5: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
12 <title>GLEP 34 -- Per-Category metadata.xml Files</title> 12 <title>GLEP 34 -- Per-Category metadata.xml Files</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 14</head>
15<body bgcolor="white"> 15<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 16<table class="navigation" cellpadding="0" cellspacing="0"
22<td class="textlinks" align="left"> 22<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 23[<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>] 24[<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>] 25[<b><a href="./glep-0034.txt">GLEP Source</a></b>]
26</td></tr></table> 26</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 27<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 28<col class="field-name" />
30<col class="field-body" /> 29<col class="field-body" />
31<tbody valign="top"> 30<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">34</td> 31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">34</td>
33</tr> 32</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Per-Category metadata.xml Files</td> 33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Per-Category metadata.xml Files</td>
35</tr> 34</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 35<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
37</tr> 36</tr>
38<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td> 37<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td>
39</tr> 38</tr>
40<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/03/11 19:07:16</a></td> 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>
41</tr> 40</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
43</tr> 42</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr> 44</tr>
46<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> 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>
47</tr> 46</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">03-March-2005</td> 47<tr class="field"><th class="field-name">Created:</th><td class="field-body">11-March-2005</td>
49</tr> 48</tr>
50<tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">03-March-2005</td> 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>
51</tr> 50</tr>
52</tbody> 51</tbody>
53</table> 52</table>
54<hr /> 53<hr />
55<div class="contents topic" id="contents"> 54<div class="contents topic" id="contents">
60<li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul> 59<li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul>
61<li><a class="reference" href="#examples" id="id12" name="id12">Examples</a></li> 60<li><a class="reference" href="#examples" id="id12" name="id12">Examples</a></li>
62<li><a class="reference" href="#implementation-requirements" id="id13" name="id13">Implementation Requirements</a></li> 61<li><a class="reference" href="#implementation-requirements" id="id13" name="id13">Implementation Requirements</a></li>
63</ul> 62</ul>
64</li> 63</li>
65<li><a class="reference" href="#backwards-compatability" id="id14" name="id14">Backwards Compatability</a></li> 64<li><a class="reference" href="#backwards-compatibility" id="id14" name="id14">Backwards Compatibility</a></li>
66<li><a class="reference" href="#references" id="id15" name="id15">References</a></li> 65<li><a class="reference" href="#references" id="id15" name="id15">References</a></li>
67<li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li> 66<li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li>
68</ul> 67</ul>
69</div> 68</div>
70<div class="section" id="abstract"> 69<div class="section" id="abstract">
71<h1><a class="toc-backref" href="#id9" name="abstract">Abstract</a></h1> 70<h1><a class="toc-backref" href="#id9" name="abstract">Abstract</a></h1>
72<p>A <tt class="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 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
73(long descriptions, herd and maintainer information) about a package. It 72(long descriptions, herd and maintainer information) about a package. It
74is proposed that these files also be used to describe the purpose of a 73is proposed that these files also be used to describe the purpose of a
75category.</p> 74category.</p>
76</div> 75</div>
77<div class="section" id="motivation"> 76<div class="section" id="motivation">
79<p>Category names are short and not entirely clear. Adding arbitrary length 78<p>Category names are short and not entirely clear. Adding arbitrary length
80long descriptions to categories would provide several advantages:</p> 79long descriptions to categories would provide several advantages:</p>
81<ul class="simple"> 80<ul class="simple">
82<li>It would clarify the meaning of categories for users, who may not be 81<li>It would clarify the meaning of categories for users, who may not be
83aware of some of the abbreviations or acronyms we use.</li> 82aware of some of the abbreviations or acronyms we use.</li>
84<li>With the use of XML <tt class="literal"><span class="pre">lang=&quot;&quot;</span></tt> attributes, it would allow for 83<li>With the use of XML <tt class="docutils literal"><span class="pre">lang=&quot;&quot;</span></tt> attributes, it would allow for
85additional non-English descriptions (simply using longer category names 84additional non-English descriptions (simply using longer category names
86would not allow this).</li> 85would not allow this).</li>
87<li>It would help developers better select a relevant category for their 86<li>It would help developers better select a relevant category for their
88package, rather than dumping everything into <tt class="literal"><span class="pre">sys-apps</span></tt> and 87package, rather than dumping everything into <tt class="docutils literal"><span class="pre">sys-apps</span></tt> and
89<tt class="literal"><span class="pre">app-misc</span></tt> as is done currently.</li> 88<tt class="docutils literal"><span class="pre">app-misc</span></tt> as is done currently.</li>
90<li>It would help illustrate which categories are too broad or badly defined 89<li>It would help illustrate which categories are too broad or badly defined
91in scope, making any future category splits easier.</li> 90in scope, making any future category splits easier.</li>
92</ul> 91</ul>
93</div> 92</div>
94<div class="section" id="specification"> 93<div class="section" id="specification">
95<h1><a class="toc-backref" href="#id11" name="specification">Specification</a></h1> 94<h1><a class="toc-backref" href="#id11" name="specification">Specification</a></h1>
96<p>It is proposed that the existing <tt class="literal"><span class="pre">metadata.xml</span></tt> format <a class="footnote-reference" href="#id6" id="id2" name="id2">[1]</a> be used. 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.
97Even though XML sucks, there is already a framework in place for these 96Even though XML sucks, there is already a framework in place for these
98files. The filename will be <tt class="literal"><span class="pre">blah-misc/metadata.xml</span></tt>. The character set 97files. The filename will be <tt class="docutils literal"><span class="pre">blah-misc/metadata.xml</span></tt>. The character set
99used shall be UTF-8 for consistency with GLEP 31 <a class="footnote-reference" href="#id7" id="id3" name="id3">[2]</a>.</p> 98used shall be UTF-8 for consistency with GLEP 31 <a class="footnote-reference" href="#id7" id="id3" name="id3">[2]</a>.</p>
100<p>A new top level <tt class="literal"><span class="pre">&lt;catmetadata&gt;</span></tt> element shall be added to the DTD to 99<p>A new top level <tt class="docutils literal"><span class="pre">&lt;catmetadata&gt;</span></tt> element shall be added to the DTD. This
101distinguish category metadata elements from the existing <tt class="literal"><span class="pre">&lt;pkgmetadata&gt;</span></tt> 100is necessary because the existing <tt class="docutils literal"><span class="pre">&lt;pkgmetadata&gt;</span></tt> element is not
102elements.</p> 101appropriately named, and doing a global rename would be impractical. Using
102a different element would also permit additional category-specific data to
103be added at a later date.</p>
103<p>The existing <tt class="literal"><span class="pre">&lt;longdescription&gt;</span></tt> elements shall be used for 104<p>The existing <tt class="docutils literal"><span class="pre">&lt;longdescription&gt;</span></tt> elements shall be used for
104descriptions. The <tt class="literal"><span class="pre">lang</span></tt> attribute shall be used to indicate the human 105descriptions. The <tt class="docutils literal"><span class="pre">lang</span></tt> attribute shall be used to indicate the human
105language of the description -- all categories must have at least an 106language of the description -- all categories must have at least an
106English (<tt class="literal"><span class="pre">en</span></tt>) description.</p> 107English (<tt class="docutils literal"><span class="pre">en</span></tt>) description.</p>
107<p>The <tt class="literal"><span class="pre">&lt;herd&gt;</span></tt> and <tt class="literal"><span class="pre">&lt;maintainer&gt;</span></tt> elements are not generally relevant at 108<p>The <tt class="docutils literal"><span class="pre">&lt;herd&gt;</span></tt> and <tt class="docutils literal"><span class="pre">&lt;maintainer&gt;</span></tt> elements are not generally relevant at
108the category level.</p> 109the category level. They may be specified as a fall-back &quot;assume that
110everything in this category is maintained by these people&quot;, but this must
111not be used as a replacement for proper per-package metadata.</p>
109<div class="section" id="examples"> 112<div class="section" id="examples">
110<h2><a class="toc-backref" href="#id12" name="examples">Examples</a></h2> 113<h2><a class="toc-backref" href="#id12" name="examples">Examples</a></h2>
111<p>The <tt class="literal"><span class="pre">app-vim</span></tt> category could use a <tt class="literal"><span class="pre">metadata.xml</span></tt> file like the 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
112following:</p> 115following:</p>
113<pre class="literal-block"> 116<pre class="literal-block">
114&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt; 117&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
115&lt;!DOCTYPE catmetadata SYSTEM &quot;http://www.gentoo.org/dtd/metadata.dtd&quot;&gt; 118&lt;!DOCTYPE catmetadata SYSTEM &quot;http://www.gentoo.org/dtd/metadata.dtd&quot;&gt;
116&lt;catmetadata&gt; 119&lt;catmetadata&gt;
125&lt;/catmetadata&gt; 128&lt;/catmetadata&gt;
126</pre> 129</pre>
127</div> 130</div>
128<div class="section" id="implementation-requirements"> 131<div class="section" id="implementation-requirements">
129<h2><a class="toc-backref" href="#id13" name="implementation-requirements">Implementation Requirements</a></h2> 132<h2><a class="toc-backref" href="#id13" name="implementation-requirements">Implementation Requirements</a></h2>
130<p>The DTD file would need to be updated to include the <tt class="literal"><span class="pre">&lt;catmetadata&gt;</span></tt> 133<p>The DTD file would need to be updated to include the <tt class="docutils literal"><span class="pre">&lt;catmetadata&gt;</span></tt>
131element.</p> 134element.</p>
132<p>A metadata file would have to be added to every category in the tree. This 135<p>A metadata file would have to be added to every category in the tree. This
133could be done over a period of time.</p> 136could be done over a period of time.</p>
134<p><tt class="literal"><span class="pre">repoman</span></tt> checks for category metadata files would not be necessary.</p> 137<p><tt class="docutils literal"><span class="pre">repoman</span></tt> would need a few small changes to be able to handle
138per-category metadata files.</p>
135<p>The &quot;packages.gentoo.org metadata&quot; bug <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a> would need to be 139<p>The &quot;packages.gentoo.org metadata&quot; bug <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a> would need to be
136updated to ask for category descriptions as well.</p> 140updated to ask for category descriptions as well.</p>
137<p>The metadata documentation <a class="footnote-reference" href="#id6" id="id5" name="id5">[1]</a> would require some additions.</p> 141<p>The metadata documentation <a class="footnote-reference" href="#id6" id="id5" name="id5">[1]</a> would require some additions.</p>
138</div> 142</div>
139</div> 143</div>
140<div class="section" id="backwards-compatability"> 144<div class="section" id="backwards-compatibility">
141<h1><a class="toc-backref" href="#id14" name="backwards-compatability">Backwards Compatability</a></h1> 145<h1><a class="toc-backref" href="#id14" name="backwards-compatibility">Backwards Compatibility</a></h1>
142<p>The metadata DTD will remain backwards compatible.</p> 146<p>The metadata DTD will remain backwards compatible.</p>
143<p>The category metadata files will need to be considered &quot;optional until 147<p>The category metadata files will need to be considered &quot;optional until
144implemented&quot; rather than immediately becoming mandatory.</p> 148implemented&quot; rather than immediately becoming mandatory.</p>
145</div> 149</div>
146<div class="section" id="references"> 150<div class="section" id="references">
147<h1><a class="toc-backref" href="#id15" name="references">References</a></h1> 151<h1><a class="toc-backref" href="#id15" name="references">References</a></h1>
148<table class="footnote" frame="void" id="id6" rules="none"> 152<table class="docutils footnote" frame="void" id="id6" rules="none">
149<colgroup><col class="label" /><col /></colgroup> 153<colgroup><col class="label" /><col /></colgroup>
150<tbody valign="top"> 154<tbody valign="top">
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, 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,
152(<a class="reference" href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4</a>)</td></tr> 156(<a class="reference" href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&amp;chap=4</a>)</td></tr>
153</tbody> 157</tbody>
154</table> 158</table>
155<table class="footnote" frame="void" id="id7" rules="none"> 159<table class="docutils footnote" frame="void" id="id7" rules="none">
156<colgroup><col class="label" /><col /></colgroup> 160<colgroup><col class="label" /><col /></colgroup>
157<tbody valign="top"> 161<tbody valign="top">
158<tr><td class="label"><a class="fn-backref" href="#id3" name="id7">[2]</a></td><td>GLEP 31: Character Sets for Portage Tree Items 162<tr><td class="label"><a class="fn-backref" href="#id3" name="id7">[2]</a></td><td>GLEP 31: Character Sets for Portage Tree Items
159(<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a>)</td></tr> 163(<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a>)</td></tr>
160</tbody> 164</tbody>
161</table> 165</table>
162<table class="footnote" frame="void" id="id8" rules="none"> 166<table class="docutils footnote" frame="void" id="id8" rules="none">
163<colgroup><col class="label" /><col /></colgroup> 167<colgroup><col class="label" /><col /></colgroup>
164<tbody valign="top"> 168<tbody valign="top">
165<tr><td class="label"><a class="fn-backref" href="#id4" name="id8">[3]</a></td><td>Gentoo bug 66917 169<tr><td class="label"><a class="fn-backref" href="#id4" name="id8">[3]</a></td><td>Gentoo bug 66917
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> 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>
167</tbody> 171</tbody>
168</table> 172</table>
169</div> 173</div>
170<div class="section" id="copyright"> 174<div class="section" id="copyright">
171<h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1> 175<h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1>
172<p>This document has been placed in the public domain.</p> 176<p>This document has been placed in the public domain.</p>
173<blockquote>
174vim: set tw=74 fileencoding=utf-8 :</blockquote> 177<!-- vim: set tw=74 fileencoding=utf-8 : -->
175</div>
176</div> 178</div>
177 179
180</div>
178<hr class="footer" /> 181<hr class="docutils footer" />
179<div class="footer"> 182<div class="footer">
180<a class="reference" href="glep-0034.txt">View document source</a>. 183<a class="reference" href="glep-0034.txt">View document source</a>.
181Generated on: 2005-03-11 19:08 UTC. 184Generated on: 2005-05-02 20:34 UTC.
182Generated 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. 185Generated 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.
183</div> 186</div>
184</body> 187</body>
185</html> 188</html>
186 189

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4

  ViewVC Help
Powered by ViewVC 1.1.20