| 1 | <?xml version='1.0' encoding='UTF-8'?> |
1 | <?xml version='1.0' encoding='UTF-8'?> |
| 2 | <!DOCTYPE sections SYSTEM "/dtd/book.dtd"> |
2 | <!DOCTYPE sections SYSTEM "/dtd/book.dtd"> |
| 3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/Attic/hb-guide-metadata.xml,v 1.16 2009/10/30 17:46:11 betelgeuse Exp $--> |
3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/Attic/hb-guide-metadata.xml,v 1.18 2012/04/27 17:43:42 hwoarang Exp $--> |
| 4 | |
4 | |
| 5 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
5 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
| 6 | <!-- See http://creativecommons.org/licenses/by-sa/1.0 --> |
6 | <!-- See http://creativecommons.org/licenses/by-sa/1.0 --> |
| 7 | |
7 | |
| 8 | <!-- This document was last synced to: |
8 | <!-- This document was last synced to: |
| 9 | cvs://gentoo/gentoo/xml/htdocs/doc/en/metadata.xml :: R1.4. |
9 | cvs://gentoo/gentoo/xml/htdocs/doc/en/metadata.xml :: R1.4. |
| 10 | --> |
10 | --> |
| 11 | |
11 | |
| 12 | <sections> |
12 | <sections> |
| 13 | <version>1.0.7</version> |
13 | <version>1.0.9</version> |
| 14 | <date>2008-09-11</date> |
14 | <date>2012-04-27</date> |
| 15 | |
15 | |
| 16 | <section> |
16 | <section> |
| 17 | <title>Why the need for metadata.xml?</title> |
17 | <title>Why the need for metadata.xml?</title> |
| 18 | <subsection> |
18 | <subsection> |
| 19 | <body> |
19 | <body> |
| 20 | |
20 | |
| 21 | <p> |
21 | <p> |
| 22 | The <path>metadata.xml</path> file has as its purpose to give extra information |
22 | The <path>metadata.xml</path> file has as its purpose to give extra information |
| 23 | about ebuilds. The <path>metadata.xml</path> file should exist in every package |
23 | about ebuilds. The <path>metadata.xml</path> file should exist in every package |
| 24 | directory. A skel file can be found as <path>skel.metadata.xml</path> in the |
24 | directory. A skel file can be found as <path>skel.metadata.xml</path> in the |
| 25 | portage tree. |
25 | portage tree. |
| 26 | </p> |
26 | </p> |
| 27 | |
27 | |
| 28 | </body> |
28 | </body> |
| 29 | </subsection> |
29 | </subsection> |
| … | |
… | |
| 37 | <p> |
37 | <p> |
| 38 | A <path>metadata.xml</path> file can contain a number of tags: |
38 | A <path>metadata.xml</path> file can contain a number of tags: |
| 39 | </p> |
39 | </p> |
| 40 | |
40 | |
| 41 | <table> |
41 | <table> |
| 42 | <tr> |
42 | <tr> |
| 43 | <th>tag</th> |
43 | <th>tag</th> |
| 44 | <th>description</th> |
44 | <th>description</th> |
| 45 | </tr> |
45 | </tr> |
| 46 | <tr> |
46 | <tr> |
| 47 | <ti> |
47 | <ti> |
| 48 | <brite><pkgmetadata></brite> |
48 | <brite><pkgmetadata></brite> |
| 49 | </ti> |
49 | </ti> |
| 50 | <ti> |
50 | <ti> |
| 51 | This is the root element of the <path>metadata.xml</path> file for |
51 | This is the root element of the <path>metadata.xml</path> file for |
| 52 | packages. It has no attributes. Its required subtag is: |
52 | packages. It has no attributes. The following subtags are |
| 53 | <brite><herd></brite>. Furthermore, the following subtags are |
53 | allowed: |
| 54 | allowed: <brite><email></brite> for a general herd email address, |
54 | <brite><herd></brite>, |
| 55 | <brite><maintainer></brite>, |
55 | <brite><maintainer></brite>, |
| 56 | <brite><longdescription></brite>, |
56 | <brite><longdescription></brite>, |
| 57 | <brite><use></brite>, and |
57 | <brite><use></brite>, and |
| 58 | <brite><upstream></brite>. |
58 | <brite><upstream></brite>. |
|
|
59 | There should be at least one <brite><herd></brite> or |
|
|
60 | <brite><maintainer></brite> subtag. |
| 59 | </ti> |
61 | </ti> |
| 60 | </tr> |
62 | </tr> |
| 61 | <tr> |
63 | <tr> |
| 62 | <ti> |
64 | <ti> |
| 63 | <brite><catmetadata></brite> |
65 | <brite><catmetadata></brite> |
| 64 | </ti> |
66 | </ti> |
| 65 | <ti> |
67 | <ti> |
| 66 | This is the root element of the <path>metadata.xml</path> file for |
68 | This is the root element of the <path>metadata.xml</path> file for |
| 67 | categories as per <uri link="/proj/en/glep/glep-0034.html">GLEP 34</uri>. |
69 | categories as per <uri link="/proj/en/glep/glep-0034.html">GLEP 34</uri>. |
| 68 | It has no attributes. It contains a number of |
70 | It has no attributes. It contains a number of |
| 69 | <brite><longdescription></brite> tags, each for a different |
71 | <brite><longdescription></brite> tags, each for a different |
| 70 | language. |
72 | language. |
| 71 | </ti> |
73 | </ti> |
| 72 | </tr> |
74 | </tr> |
| 73 | <tr> |
75 | <tr> |
| 74 | <ti> |
76 | <ti> |
| 75 | <brite><herd></brite> |
77 | <brite><herd></brite> |
| 76 | </ti> |
78 | </ti> |
| 77 | <ti> |
79 | <ti> |
| 78 | There must at least be one herd subtag. The contents of this tag must be |
80 | If a package is maintained by one or more herds, names of these herds |
| 79 | the name of a herd as specified in the <uri |
81 | can be specified with the <brite><herd></brite> tag. The names |
|
|
82 | used in this tag must be the same as specified in the <uri |
| 80 | link="http://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plain&rev=HEAD">herds.xml</uri> |
83 | link="http://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plain&rev=HEAD">herds.xml</uri> |
| 81 | file or the "no-herd" herd. It must occur at least once. |
84 | file. |
| 82 | </ti> |
85 | </ti> |
| 83 | </tr> |
86 | </tr> |
| 84 | <tr> |
87 | <tr> |
| 85 | <ti> |
88 | <ti> |
| 86 | <brite><maintainer></brite> |
89 | <brite><maintainer></brite> |
| 87 | </ti> |
90 | </ti> |
| 88 | <ti> |
91 | <ti> |
| 89 | Besides being part of a herd, a package can also be maintained directly. |
92 | Besides being part of a herd, a package can also be maintained directly. |
| 90 | The maintainers of a package can be specified with the |
93 | The maintainers of a package can be specified with the |
| 91 | <brite><maintainer></brite> tag. This tag has one required subtag: |
94 | <brite><maintainer></brite> tag. This tag has one required subtag: |
| 92 | <brite><email></brite>. It has two optional subtags: |
95 | <brite><email></brite>. It has two optional subtags: |
| 93 | <brite><name></brite>, and <brite><description></brite>. |
96 | <brite><name></brite>, and <brite><description></brite>. |
| 94 | </ti> |
97 | </ti> |
| 95 | </tr> |
98 | </tr> |
| 96 | <tr> |
99 | <tr> |
| … | |
… | |
| 123 | </tr> |
126 | </tr> |
| 124 | <tr> |
127 | <tr> |
| 125 | <ti><brite><use></brite></ti> |
128 | <ti><brite><use></brite></ti> |
| 126 | <ti> |
129 | <ti> |
| 127 | This tag contains descriptions of <uri |
130 | This tag contains descriptions of <uri |
| 128 | link="/doc/en/handbook/handbook-x86.xml?part=2&chap=2">USE flags</uri>. |
131 | link="/doc/en/handbook/handbook-x86.xml?part=2&chap=2">USE flags</uri>. |
| 129 | This tag is optional and, if specified, has one required subtag: |
132 | This tag is optional and, if specified, has one required subtag: |
| 130 | <brite><flag></brite>. |
133 | <brite><flag></brite>. |
| 131 | </ti> |
134 | </ti> |
| 132 | </tr> |
135 | </tr> |
| 133 | <tr> |
136 | <tr> |
| 134 | <ti><brite><flag></brite></ti> |
137 | <ti><brite><flag></brite></ti> |
| 135 | <ti> |
138 | <ti> |
| 136 | This tag contains a description of how the named USE flag affects this |
139 | This tag contains a description of how the named USE flag affects this |
| 137 | package. It is required if the <brite><use></brite> tag is specified. |
140 | package. It is required if the <brite><use></brite> tag is specified. |
| 138 | It alos requires the USE flag to be named in the <c>name</c> attribute. |
141 | It also requires the USE flag to be named in the <c>name</c> attribute. |
| 139 | This tag has two optional subtags: <brite><pkg></brite> and |
142 | This tag has two optional subtags: <brite><pkg></brite> and |
| 140 | <brite><cat></brite>. |
143 | <brite><cat></brite>. |
| 141 | </ti> |
144 | </ti> |
| 142 | </tr> |
145 | </tr> |
| 143 | <tr> |
146 | <tr> |
| 144 | <ti><brite><upstream></brite></ti> |
147 | <ti><brite><upstream></brite></ti> |
| 145 | <ti> |
148 | <ti> |
| 146 | This tag contains information about the upstream developers/project. |
149 | This tag contains information about the upstream developers/project. |
| 147 | </ti> |
150 | </ti> |
| 148 | </tr> |
151 | </tr> |
| 149 | <tr> |
152 | <tr> |
| 150 | <ti><brite><maintainer></brite></ti> |
153 | <ti><brite><maintainer></brite></ti> |
| 151 | <ti> |
154 | <ti> |
| 152 | Name and e-mail of an upstream maintainer. May appear more than once. |
155 | Name and e-mail of an upstream maintainer. May appear more than once. |
| 153 | </ti> |
156 | </ti> |
Parent Directory
| 
Revision Log
| 
Patch