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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.8 - (show annotations) (download) (as text)
Sun Oct 14 17:00:15 2007 UTC (11 years, 6 months ago) by antarus
Branch: MAIN
Changes since 1.7: +4 -251 lines
File MIME type: text/html
the canary on 53 went well, changing the rest

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">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
8 <title>GLEP 34 -- Per-Category metadata.xml Files</title>
9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
10 </head>
11 <body bgcolor="white">
12 <table class="navigation" cellpadding="0" cellspacing="0"
13 width="100%" border="0">
14 <tr><td class="navicon" width="150" height="35">
15 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
16 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
17 border="0" width="150" height="35" /></a></td>
18 <td class="textlinks" align="left">
19 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
20 [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
21 [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0034.txt">GLEP Source</a></b>]
22 </td></tr></table>
23 <table class="rfc2822 docutils field-list" frame="void" rules="none">
24 <col class="field-name" />
25 <col class="field-body" />
26 <tbody valign="top">
27 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">34</td>
28 </tr>
29 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Per-Category metadata.xml Files</td>
30 </tr>
31 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.5</td>
32 </tr>
33 <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>
34 </tr>
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>
36 </tr>
37 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
38 </tr>
39 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
40 </tr>
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>
42 </tr>
43 <tr class="field"><th class="field-name">Created:</th><td class="field-body">11-Mar-2005</td>
44 </tr>
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>
46 </tr>
47 </tbody>
48 </table>
49 <hr />
50 <div class="contents topic">
51 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
52 <ul class="simple">
53 <li><a class="reference" href="#abstract" id="id9" name="id9">Abstract</a></li>
54 <li><a class="reference" href="#motivation" id="id10" name="id10">Motivation</a></li>
55 <li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul>
56 <li><a class="reference" href="#examples" id="id12" name="id12">Examples</a></li>
57 <li><a class="reference" href="#implementation-requirements" id="id13" name="id13">Implementation Requirements</a></li>
58 </ul>
59 </li>
60 <li><a class="reference" href="#backwards-compatibility" id="id14" name="id14">Backwards Compatibility</a></li>
61 <li><a class="reference" href="#references" id="id15" name="id15">References</a></li>
62 <li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li>
63 </ul>
64 </div>
65 <div class="section">
66 <h1><a class="toc-backref" href="#id9" id="abstract" name="abstract">Abstract</a></h1>
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
68 (long descriptions, herd and maintainer information) about a package. It
69 is proposed that these files also be used to describe the purpose of a
70 category.</p>
71 </div>
72 <div class="section">
73 <h1><a class="toc-backref" href="#id10" id="motivation" name="motivation">Motivation</a></h1>
74 <p>Category names are short and not entirely clear. Adding arbitrary length
75 long descriptions to categories would provide several advantages:</p>
76 <ul class="simple">
77 <li>It would clarify the meaning of categories for users, who may not be
78 aware of some of the abbreviations or acronyms we use.</li>
79 <li>With the use of XML <tt class="docutils literal"><span class="pre">lang=&quot;&quot;</span></tt> attributes, it would allow for
80 additional non-English descriptions (simply using longer category names
81 would not allow this).</li>
82 <li>It would help developers better select a relevant category for their
83 package, rather than dumping everything into <tt class="docutils literal"><span class="pre">sys-apps</span></tt> and
84 <tt class="docutils literal"><span class="pre">app-misc</span></tt> as is done currently.</li>
85 <li>It would help illustrate which categories are too broad or badly defined
86 in scope, making any future category splits easier.</li>
87 </ul>
88 </div>
89 <div class="section">
90 <h1><a class="toc-backref" href="#id11" id="specification" name="specification">Specification</a></h1>
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.
92 Even though XML sucks, there is already a framework in place for these
93 files. The filename will be <tt class="docutils literal"><span class="pre">blah-misc/metadata.xml</span></tt>. The character set
94 used shall be UTF-8 for consistency with GLEP 31 <a class="footnote-reference" href="#id7" id="id3" name="id3">[2]</a>.</p>
95 <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
96 is necessary because the existing <tt class="docutils literal"><span class="pre">&lt;pkgmetadata&gt;</span></tt> element is not
97 appropriately named, and doing a global rename would be impractical. Using
98 a different element would also permit additional category-specific data to
99 be added at a later date.</p>
100 <p>The existing <tt class="docutils literal"><span class="pre">&lt;longdescription&gt;</span></tt> elements shall be used for
101 descriptions. The <tt class="docutils literal"><span class="pre">lang</span></tt> attribute shall be used to indicate the human
102 language of the description -- all categories must have at least an
103 English (<tt class="docutils literal"><span class="pre">en</span></tt>) description.</p>
104 <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
105 the category level. They may be specified as a fall-back &quot;assume that
106 everything in this category is maintained by these people&quot;, but this must
107 not be used as a replacement for proper per-package metadata.</p>
108 <div class="section">
109 <h2><a class="toc-backref" href="#id12" id="examples" name="examples">Examples</a></h2>
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
111 following:</p>
112 <pre class="literal-block">
113 &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
114 &lt;!DOCTYPE catmetadata SYSTEM &quot;http://www.gentoo.org/dtd/metadata.dtd&quot;&gt;
115 &lt;catmetadata&gt;
116 &lt;longdescription lang=&quot;en&quot;&gt;
117 The app-vim category contains plugins and syntax file
118 packages for the Vim text editor.
119 &lt;/longdescription&gt;
120 &lt;longdescription lang=&quot;de&quot;&gt;
121 Die Kategorie app-vim enthält Plugins und Syntax-Pakete
122 für den Vim Texteditor.
123 &lt;/longdescription&gt;
124 &lt;/catmetadata&gt;
125 </pre>
126 </div>
127 <div class="section">
128 <h2><a class="toc-backref" href="#id13" id="implementation-requirements" name="implementation-requirements">Implementation Requirements</a></h2>
129 <p>The DTD file would need to be updated to include the <tt class="docutils literal"><span class="pre">&lt;catmetadata&gt;</span></tt>
130 element.</p>
131 <p>A metadata file would have to be added to every category in the tree. This
132 could be done over a period of time.</p>
133 <p><tt class="docutils literal"><span class="pre">repoman</span></tt> would need a few small changes to be able to handle
134 per-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
136 updated 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>
138 </div>
139 </div>
140 <div class="section">
141 <h1><a class="toc-backref" href="#id14" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
142 <p>The metadata DTD will remain backwards compatible.</p>
143 <p>The category metadata files will need to be considered &quot;optional until
144 implemented&quot; rather than immediately becoming mandatory.</p>
145 </div>
146 <div class="section">
147 <h1><a class="toc-backref" href="#id15" id="references" name="references">References</a></h1>
148 <table class="docutils footnote" frame="void" id="id6" rules="none">
149 <colgroup><col class="label" /><col /></colgroup>
150 <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,
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>
153 </tbody>
154 </table>
155 <table class="docutils footnote" frame="void" id="id7" rules="none">
156 <colgroup><col class="label" /><col /></colgroup>
157 <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
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>
160 </tbody>
161 </table>
162 <table class="docutils footnote" frame="void" id="id8" rules="none">
163 <colgroup><col class="label" /><col /></colgroup>
164 <tbody valign="top">
165 <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>
167 </tbody>
168 </table>
169 </div>
170 <div class="section">
171 <h1><a class="toc-backref" href="#id16" id="copyright" name="copyright">Copyright</a></h1>
172 <p>This document has been placed in the public domain.</p>
173 <!-- vim: set tw=74 fileencoding=utf-8 : -->
174 </div>
176 </div>
177 <div class="footer">
178 <hr class="footer" />
179 <a class="reference" href="glep-0034.txt">View document source</a>.
180 Generated on: 2007-10-13 13:39 UTC.
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.
183 </div>
184 </body>
185 </html>

  ViewVC Help
Powered by ViewVC 1.1.20