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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.5 - (hide annotations) (download) (as text)
Mon Nov 7 22:26:59 2005 UTC (8 years, 8 months ago) by ciaranm
Branch: MAIN
Changes since 1.4: +7 -6 lines
File MIME type: text/html
Fix header typos, GLEP 1 compliance

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

  ViewVC Help
Powered by ViewVC 1.1.20