/[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.3
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.3: 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"
31<tbody valign="top"> 31<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">34</td> 32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">34</td>
33</tr> 33</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Per-Category metadata.xml Files</td> 34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Per-Category metadata.xml Files</td>
35</tr> 35</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td>
37</tr> 37</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> 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>
39</tr> 39</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> 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/17 23:57:56</a></td>
41</tr> 41</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Accepted</td>
43</tr> 43</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr> 45</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> 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>
47</tr> 47</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">03-March-2005</td> 48<tr class="field"><th class="field-name">Created:</th><td class="field-body">11-March-2005</td>
49</tr> 49</tr>
50<tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">03-March-2005</td> 50<tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">11-March-2005, 13-March-2005</td>
51</tr> 51</tr>
52</tbody> 52</tbody>
53</table> 53</table>
54<hr /> 54<hr />
55<div class="contents topic" id="contents"> 55<div class="contents topic" id="contents">
60<li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul> 60<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> 61<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> 62<li><a class="reference" href="#implementation-requirements" id="id13" name="id13">Implementation Requirements</a></li>
63</ul> 63</ul>
64</li> 64</li>
65<li><a class="reference" href="#backwards-compatability" id="id14" name="id14">Backwards Compatability</a></li> 65<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> 66<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> 67<li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li>
68</ul> 68</ul>
69</div> 69</div>
70<div class="section" id="abstract"> 70<div class="section" id="abstract">
95<h1><a class="toc-backref" href="#id11" name="specification">Specification</a></h1> 95<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. 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.
97Even though XML sucks, there is already a framework in place for these 97Even 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 98files. The filename will be <tt class="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> 99used 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 100<p>A new top level <tt class="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> 101is necessary because the existing <tt class="literal"><span class="pre">&lt;pkgmetadata&gt;</span></tt> element is not
102elements.</p> 102appropriately named, and doing a global rename would be impractical. Using
103a different element would also permit additional category-specific data to
104be 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 105<p>The existing <tt class="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 106descriptions. The <tt class="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 107language of the description -- all categories must have at least an
106English (<tt class="literal"><span class="pre">en</span></tt>) description.</p> 108English (<tt class="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 109<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
108the category level.</p> 110the category level. They may be specified as a fall-back &quot;assume that
111everything in this category is maintained by these people&quot;, but this must
112not be used as a replacement for proper per-package metadata.</p>
109<div class="section" id="examples"> 113<div class="section" id="examples">
110<h2><a class="toc-backref" href="#id12" name="examples">Examples</a></h2> 114<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 115<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
112following:</p> 116following:</p>
113<pre class="literal-block"> 117<pre class="literal-block">
129<h2><a class="toc-backref" href="#id13" name="implementation-requirements">Implementation Requirements</a></h2> 133<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> 134<p>The DTD file would need to be updated to include the <tt class="literal"><span class="pre">&lt;catmetadata&gt;</span></tt>
131element.</p> 135element.</p>
132<p>A metadata file would have to be added to every category in the tree. This 136<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> 137could 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> 138<p><tt class="literal"><span class="pre">repoman</span></tt> would need a few small changes to be able to handle
139per-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 140<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> 141updated 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> 142<p>The metadata documentation <a class="footnote-reference" href="#id6" id="id5" name="id5">[1]</a> would require some additions.</p>
138</div> 143</div>
139</div> 144</div>
140<div class="section" id="backwards-compatability"> 145<div class="section" id="backwards-compatibility">
141<h1><a class="toc-backref" href="#id14" name="backwards-compatability">Backwards Compatability</a></h1> 146<h1><a class="toc-backref" href="#id14" name="backwards-compatibility">Backwards Compatibility</a></h1>
142<p>The metadata DTD will remain backwards compatible.</p> 147<p>The metadata DTD will remain backwards compatible.</p>
143<p>The category metadata files will need to be considered &quot;optional until 148<p>The category metadata files will need to be considered &quot;optional until
144implemented&quot; rather than immediately becoming mandatory.</p> 149implemented&quot; rather than immediately becoming mandatory.</p>
145</div> 150</div>
146<div class="section" id="references"> 151<div class="section" id="references">
168</table> 173</table>
169</div> 174</div>
170<div class="section" id="copyright"> 175<div class="section" id="copyright">
171<h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1> 176<h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1>
172<p>This document has been placed in the public domain.</p> 177<p>This document has been placed in the public domain.</p>
173<blockquote>
174vim: set tw=74 fileencoding=utf-8 :</blockquote> 178<!-- vim: set tw=74 fileencoding=utf-8 : -->
175</div> 179</div>
176</div> 180</div>
177 181
178<hr class="footer" /> 182<hr class="footer" />
179<div class="footer"> 183<div class="footer">
180<a class="reference" href="glep-0034.txt">View document source</a>. 184<a class="reference" href="glep-0034.txt">View document source</a>.
181Generated on: 2005-03-11 19:08 UTC. 185Generated on: 2005-03-17 23:58 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. 186Generated 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> 187</div>
184</body> 188</body>
185</html> 189</html>
186 190

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

  ViewVC Help
Powered by ViewVC 1.1.20