Lines 10-17
Link Here
|
10 |
--> |
10 |
--> |
11 |
|
11 |
|
12 |
<sections> |
12 |
<sections> |
13 |
<version>1.0.5</version> |
13 |
<version>1.0.6</version> |
14 |
<date>2008-03-31</date> |
14 |
<date>2008-07-10</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> |
Lines 115-121
Link Here
|
115 |
<ti><brite><longdescription></brite></ti> |
115 |
<ti><brite><longdescription></brite></ti> |
116 |
<ti> |
116 |
<ti> |
117 |
This tag contains a description of the package. This is to augment the |
117 |
This tag contains a description of the package. This is to augment the |
118 |
DESCRIPTION field in the ebuilds themselves. |
118 |
DESCRIPTION field in the ebuilds themselves. This tag has two optional |
|
|
119 |
subtags: <brite><pkg></brite> and <brite><cat></brite>. |
120 |
</ti> |
121 |
</tr> |
122 |
<tr> |
123 |
<ti><brite><use></brite></ti> |
124 |
<ti> |
125 |
This tag contains descriptions of <uri |
126 |
link="/doc/en/handbook/handbook-x86.xml?part=2&chap=2">USE flags</uri>. |
127 |
This tag is optional and, if specified, has one required subtag: |
128 |
<brite><flag></brite>. |
129 |
</ti> |
130 |
</tr> |
131 |
<tr> |
132 |
<ti><brite><flag></brite></ti> |
133 |
<ti> |
134 |
This tag contains a description of how the named USE flag affects this |
135 |
package. It is required if the <brite><use></brite> tag is specified. |
136 |
It alos requires the USE flag to be named in the <c>name</c> attribute. |
137 |
This tag has two optional subtags: <brite><pkg></brite> and |
138 |
<brite><cat></brite>. |
139 |
</ti> |
140 |
</tr> |
141 |
<tr> |
142 |
<ti><brite><pkg></brite></ti> |
143 |
<ti> |
144 |
This tag contains a valid package name in the format of a DEPEND. |
145 |
</ti> |
146 |
</tr> |
147 |
<tr> |
148 |
<ti><brite><cat></brite></ti> |
149 |
<ti> |
150 |
This tag contains a valid category name as defined in |
151 |
<path>profiles/categories</path>. |
119 |
</ti> |
152 |
</ti> |
120 |
</tr> |
153 |
</tr> |
121 |
</table> |
154 |
</table> |
Lines 134-140
Link Here
|
134 |
<tr> |
167 |
<tr> |
135 |
<ti>lang</ti> |
168 |
<ti>lang</ti> |
136 |
<ti> |
169 |
<ti> |
137 |
<brite><description></brite>, <brite><longdescription></brite> |
170 |
<brite><description></brite>, <brite><longdescription></brite>, |
|
|
171 |
<brite><use></brite> |
138 |
</ti> |
172 |
</ti> |
139 |
<ti> |
173 |
<ti> |
140 |
In every case where a description is required, there must be at |
174 |
In every case where a description is required, there must be at |
Lines 149-168
Link Here
|
149 |
<ti>restrict</ti> |
183 |
<ti>restrict</ti> |
150 |
<ti> |
184 |
<ti> |
151 |
<brite><herd></brite>, <brite><maintainer></brite>, |
185 |
<brite><herd></brite>, <brite><maintainer></brite>, |
152 |
<brite><longdescription></brite> |
186 |
<brite><longdescription></brite>, <brite><flag></brite> |
153 |
</ti> |
187 |
</ti> |
154 |
<ti> |
188 |
<ti> |
155 |
The restrict attribute allows to restrict the application of certain tags |
189 |
The restrict attribute allows one to restrict the application of certain |
156 |
to certain versions of a package. When this attribute is used, a tag |
190 |
tags to certain versions of a package. When this attribute is used, a tag |
157 |
without this attribute must also exist. That tag without the restrict |
191 |
without this attribute must also exist. That tag without the restrict |
158 |
attribute will serve as the default. The format of the restrict attribute |
192 |
attribute will serve as the default. The format of the restrict attribute |
159 |
is that of the DEPEND flag, except that "<" and |
193 |
is that of the DEPEND flag, except that "<" and |
160 |
">" need to be specified by &lt; and &gt;.<br /> |
194 |
">" need to be specified by &lt; and &gt;.<br /> |
161 |
<br /> |
195 |
<br /> |
162 |
For example in the db package |
196 |
For example, in the <c>sys-libs/db</c> package, |
163 |
<c>restrict="&gt;=sys-libs/db-3.2.9-r5"</c> |
197 |
<c>restrict="&gt;=sys-libs/db-3.2.9-r5"</c> on the |
164 |
on the maintainer tag shows that I'm currently maintaining all versions |
198 |
<brite>maintainer</brite> tag shows that I'm currently maintaining all |
165 |
bigger then 3.2.9-r5. |
199 |
versions greater then 3.2.9-r5. |
|
|
200 |
</ti> |
201 |
</tr> |
202 |
<tr> |
203 |
<ti>name</ti> |
204 |
<ti> |
205 |
<brite><name></brite> |
206 |
</ti> |
207 |
<ti> |
208 |
This attribute is required on the <brite><flag></brite> tag. It |
209 |
simply contains the USE flag. |
210 |
<br /><br /> |
211 |
For example, in the <c>sys-apps/hal</c> package, <c>>flag name='acpi'> |
212 |
Enables ACPI</flag></c> |
166 |
</ti> |
213 |
</ti> |
167 |
</tr> |
214 |
</tr> |
168 |
</table> |
215 |
</table> |
Lines 256-260
Link Here
|
256 |
|
303 |
|
257 |
</body> |
304 |
</body> |
258 |
</subsection> |
305 |
</subsection> |
|
|
306 |
<subsection> |
307 |
<title>Third Example</title> |
308 |
<body> |
309 |
|
310 |
<p> |
311 |
For the third example, we will describe the <path>metadata.xml</path> of |
312 |
<c>sys-apps/hal</c>. This ebuild is maintained by the <c>gentopia</c> herd |
313 |
and contains USE flag descriptions. |
314 |
</p> |
315 |
|
316 |
<pre caption="USE flag descriptions"> |
317 |
<?xml version="1.0" encoding="UTF-8"> |
318 |
<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> |
319 |
<pkgmetadata> |
320 |
<herd>gentopia</herd> |
321 |
<maintainer> |
322 |
<email>compnerd@gentoo.org</email> |
323 |
</maintainer> |
324 |
<maintainer> |
325 |
<email>steev@gentoo.org</email> |
326 |
</maintainer> |
327 |
<use> |
328 |
<flag name='acpi'>Enables HAL to attempt to read from |
329 |
/proc/acpi/event, if unavailable, HAL will read events from |
330 |
<pkg>sys-power/acpid</pkg>. If you need multiple acpi |
331 |
readers, ensure acpid is in your default runlevel along with HAL. This |
332 |
will also enable HAL to read Toshia and IBM acpi events which do not |
333 |
get sent via /proc/acpi/event</flag> |
334 |
<flag name='crypt'>Allows HAL to mount volumes that are encrypted using |
335 |
LUKS. <pkg>sys-fs/cryptsetup-luks</pkg> which has recently been renamed |
336 |
to <pkg>sys-fs/cryptsetup</pkg> allows you to create such encrypted |
337 |
volumes. HAL will be able to handle volumes that are removable or |
338 |
fixed.</flag> |
339 |
<flag name='dell'>Builds an installs the Dell addon, which reads data from |
340 |
the Dell SM BIOS via <pkg>sys-libs/libsmbios</pkg>. It will read your |
341 |
service tag information and your hardware backlight data as well as |
342 |
allow you to modify the backlight settings on a Dell laptop.</flag> |
343 |
<flag name='disk-partition'>Allows HAL to use libparted from |
344 |
<pkg>sys-apps/parted</pkg> to read raw partition data from your disks |
345 |
and process that data. Future versions of HAL (possibly 0.5.11 and |
346 |
higher) will allow you to create, modify, delete and format partitions |
347 |
from a GUI interface agnostic of your desktop environment.</flag> |
348 |
<flag name='doc'>Generates documentation that describes HAL's fdi |
349 |
format.</flag> |
350 |
<flag name='pcmcia'>Allows HAL to process PCMCIA/CardBus slot data which |
351 |
includes inserts and removals and act on these events.</flag> |
352 |
<flag name='selinux'>Installs SELinux policies and links HAL to the SELinux |
353 |
libraries.</flag> |
354 |
</use> |
355 |
</pkgmetadata> |
356 |
</pre> |
357 |
|
358 |
</body> |
359 |
</subsection> |
259 |
</section> |
360 |
</section> |
260 |
</sections> |
361 |
</sections> |