Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 199788 | Differences between
and this patch

Collapse All | Expand All

(-)hb-guide-metadata.xml (-16 / +18 lines)
Lines 19-27 Link Here
19
<body>
19
<body>
20
20
21
<p>
21
<p>
22
The <c>metadata.xml</c> file has as its purpose to give extra information about
22
The <path>metadata.xml</path> file has as its purpose to give extra information
23
ebuilds. The <c>metadata.xml</c> file should exist in every package directory.
23
about ebuilds. The <path>metadata.xml</path> file should exist in every package
24
A skel file can be found as <c>skel.metadata.xml</c> in the portage tree.
24
directory.  A skel file can be found as <path>skel.metadata.xml</path> in the
25
portage tree.
25
</p>
26
</p>
26
27
27
</body>
28
</body>
Lines 34-40 Link Here
34
<body>
35
<body>
35
36
36
<p>
37
<p>
37
A <c>metadata.xml</c> file can contain a number of tags:
38
A <path>metadata.xml</path> file can contain a number of tags:
38
</p>
39
</p>
39
40
40
<table>
41
<table>
Lines 47-56 Link Here
47
    <brite>&lt;pkgmetadata&gt;</brite>
48
    <brite>&lt;pkgmetadata&gt;</brite>
48
  </ti>
49
  </ti>
49
  <ti>
50
  <ti>
50
    This is the root element of the metadata.xml file for packages. It has 
51
    This is the root element of the <path>metadata.xml</path> file for
51
    no attributes. Its required subtag is: <brite>&lt;herd&gt;</brite>. 
52
    packages. It has no attributes. Its required subtag is:
52
    Furthermore, the following subtags are allowed: <brite>&lt;email&gt;</brite> 
53
    <brite>&lt;herd&gt;</brite>.  Furthermore, the following subtags are
53
    for a general herd email address, <brite>&lt;maintainer&gt;</brite>, and 
54
    allowed: <brite>&lt;email&gt;</brite> for a general herd email address,
55
    <brite>&lt;maintainer&gt;</brite>, and
54
    <brite>&lt;longdescription&gt;</brite>.
56
    <brite>&lt;longdescription&gt;</brite>.
55
  </ti>
57
  </ti>
56
</tr>
58
</tr>
Lines 59-67 Link Here
59
    <brite>&lt;catmetadata&gt;</brite>
61
    <brite>&lt;catmetadata&gt;</brite>
60
  </ti>
62
  </ti>
61
  <ti>
63
  <ti>
62
    This is the root element of the metadata.xml file for categories as per 
64
    This is the root element of the <path>metadata.xml</path> file for
63
    <uri link="/proj/en/glep/glep-0034.html">GLEP 34</uri>. It has 
65
    categories as per <uri link="/proj/en/glep/glep-0034.html">GLEP 34</uri>.
64
    no attributes. It contains a number of 
66
    It has no attributes. It contains a number of 
65
    <brite>&lt;longdescription&gt;</brite> tags, each for a different 
67
    <brite>&lt;longdescription&gt;</brite> tags, each for a different 
66
    language.
68
    language.
67
  </ti>
69
  </ti>
Lines 72-78 Link Here
72
  </ti>
74
  </ti>
73
  <ti>
75
  <ti>
74
    There must at least be one herd subtag. The contents of this tag must be
76
    There must at least be one herd subtag. The contents of this tag must be
75
	the name of a herd as specified in the <uri 
77
    the name of a herd as specified in the <uri 
76
    link="http://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plain&amp;rev=HEAD">herds.xml</uri>
78
    link="http://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plain&amp;rev=HEAD">herds.xml</uri>
77
    file or the "no-herd" herd. It must occur at least once.
79
    file or the "no-herd" herd. It must occur at least once.
78
  </ti>
80
  </ti>
Lines 82-88 Link Here
82
    <brite>&lt;maintainer&gt;</brite>
84
    <brite>&lt;maintainer&gt;</brite>
83
  </ti>
85
  </ti>
84
  <ti>
86
  <ti>
85
    Besides being member of a herd, a package can also be maintained directly. 
87
    Besides being part of a herd, a package can also be maintained directly. 
86
    The maintainers of a package can be specified with the 
88
    The maintainers of a package can be specified with the 
87
    <brite>&lt;maintainer&gt;</brite> tag. This tag has one required subtag: 
89
    <brite>&lt;maintainer&gt;</brite> tag. This tag has one required subtag: 
88
    <brite>&lt;email&gt;</brite>. It has two optional subtags:
90
    <brite>&lt;email&gt;</brite>. It has two optional subtags:
Lines 231-239 Link Here
231
<body>
233
<body>
232
234
233
<p>
235
<p>
234
As second example we view the <path>metadata.xml</path> of <c>mirrorselect</c>.
236
For the second example, we will examine the <path>metadata.xml</path> of
235
This ebuild is maintained by the <c>tools-portage</c> herd, but has a separate
237
<c>app-portage/mirrorselect</c>.  This ebuild is maintained by the
236
maintainer.
238
<c>tools-portage</c> herd, but has a separate maintainer.
237
</p>
239
</p>
238
240
239
<pre caption="Herd &amp; individually maintained package">
241
<pre caption="Herd &amp; individually maintained package">

Return to bug 199788