|
|
|---|
--> | --> |
| |
<sections> | <sections> |
<version>1.0.5</version> |
<version>1.0.6</version> |
<date>2008-03-31</date> |
<date>2008-07-10</date> |
| |
<section> | <section> |
<title>Why the need for metadata.xml?</title> | <title>Why the need for metadata.xml?</title> |
|
|
|---|
<ti><brite><longdescription></brite></ti> | <ti><brite><longdescription></brite></ti> |
<ti> | <ti> |
This tag contains a description of the package. This is to augment the | This tag contains a description of the package. This is to augment the |
DESCRIPTION field in the ebuilds themselves. |
DESCRIPTION field in the ebuilds themselves. This tag has two optional |
|
subtags: <brite><pkg></brite> and <brite><cat></brite>. |
|
</ti> |
|
</tr> |
|
<tr> |
|
<ti><brite><use></brite></ti> |
|
<ti> |
|
This tag contains descriptions of <uri |
|
link="/doc/en/handbook/handbook-x86.xml?part=2&chap=2">USE flags</uri>. |
|
This tag is optional and, if specified, has one required subtag: |
|
<brite><flag></brite>. |
|
</ti> |
|
</tr> |
|
<tr> |
|
<ti><brite><flag></brite></ti> |
|
<ti> |
|
This tag contains a description of how the named USE flag affects this |
|
package. It is required if the <brite><use></brite> tag is specified. |
|
It alos requires the USE flag to be named in the <c>name</c> attribute. |
|
This tag has two optional subtags: <brite><pkg></brite> and |
|
<brite><cat></brite>. |
|
</ti> |
|
</tr> |
|
<tr> |
|
<ti><brite><pkg></brite></ti> |
|
<ti> |
|
This tag contains a valid package name in the format of a DEPEND. |
|
</ti> |
|
</tr> |
|
<tr> |
|
<ti><brite><cat></brite></ti> |
|
<ti> |
|
This tag contains a valid category name as defined in |
|
<path>profiles/categories</path>. |
</ti> | </ti> |
</tr> | </tr> |
</table> | </table> |
|
|
|---|
<tr> | <tr> |
<ti>lang</ti> | <ti>lang</ti> |
<ti> | <ti> |
<brite><description></brite>, <brite><longdescription></brite> |
<brite><description></brite>, <brite><longdescription></brite>, |
|
<brite><use></brite> |
</ti> | </ti> |
<ti> | <ti> |
In every case where a description is required, there must be at | In every case where a description is required, there must be at |
|
|
|---|
<ti>restrict</ti> | <ti>restrict</ti> |
<ti> | <ti> |
<brite><herd></brite>, <brite><maintainer></brite>, | <brite><herd></brite>, <brite><maintainer></brite>, |
<brite><longdescription></brite> |
<brite><longdescription></brite>, <brite><flag></brite> |
</ti> | </ti> |
<ti> | <ti> |
The restrict attribute allows to restrict the application of certain tags |
The restrict attribute allows one to restrict the application of certain |
to certain versions of a package. When this attribute is used, a tag |
tags to certain versions of a package. When this attribute is used, a tag |
without this attribute must also exist. That tag without the restrict | without this attribute must also exist. That tag without the restrict |
attribute will serve as the default. The format of the restrict attribute | attribute will serve as the default. The format of the restrict attribute |
is that of the DEPEND flag, except that "<" and | is that of the DEPEND flag, except that "<" and |
">" need to be specified by &lt; and &gt;.<br /> | ">" need to be specified by &lt; and &gt;.<br /> |
<br /> | <br /> |
For example in the db package |
For example, in the <c>sys-libs/db</c> package, |
<c>restrict="&gt;=sys-libs/db-3.2.9-r5"</c> |
<c>restrict="&gt;=sys-libs/db-3.2.9-r5"</c> on the |
on the maintainer tag shows that I'm currently maintaining all versions |
<brite>maintainer</brite> tag shows that I'm currently maintaining all |
bigger then 3.2.9-r5. |
versions greater then 3.2.9-r5. |
|
</ti> |
|
</tr> |
|
<tr> |
|
<ti>name</ti> |
|
<ti> |
|
<brite><name></brite> |
|
</ti> |
|
<ti> |
|
This attribute is required on the <brite><flag></brite> tag. It |
|
simply contains the USE flag. |
|
<br /><br /> |
|
For example, in the <c>sys-apps/hal</c> package, <c>>flag name='acpi'> |
|
Enables ACPI</flag></c> |
</ti> | </ti> |
</tr> | </tr> |
</table> | </table> |
|
|
|---|
| |
</body> | </body> |
</subsection> | </subsection> |
|
<subsection> |
|
<title>Third Example</title> |
|
<body> |
|
|
|
<p> |
|
For the third example, we will describe the <path>metadata.xml</path> of |
|
<c>sys-apps/hal</c>. This ebuild is maintained by the <c>gentopia</c> herd |
|
and contains USE flag descriptions. |
|
</p> |
|
|
|
<pre caption="USE flag descriptions"> |
|
<?xml version="1.0" encoding="UTF-8"> |
|
<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> |
|
<pkgmetadata> |
|
<herd>gentopia</herd> |
|
<maintainer> |
|
<email>compnerd@gentoo.org</email> |
|
</maintainer> |
|
<maintainer> |
|
<email>steev@gentoo.org</email> |
|
</maintainer> |
|
<use> |
|
<flag name='acpi'>Enables HAL to attempt to read from |
|
/proc/acpi/event, if unavailable, HAL will read events from |
|
<pkg>sys-power/acpid</pkg>. If you need multiple acpi |
|
readers, ensure acpid is in your default runlevel along with HAL. This |
|
will also enable HAL to read Toshia and IBM acpi events which do not |
|
get sent via /proc/acpi/event</flag> |
|
<flag name='crypt'>Allows HAL to mount volumes that are encrypted using |
|
LUKS. <pkg>sys-fs/cryptsetup-luks</pkg> which has recently been renamed |
|
to <pkg>sys-fs/cryptsetup</pkg> allows you to create such encrypted |
|
volumes. HAL will be able to handle volumes that are removable or |
|
fixed.</flag> |
|
<flag name='dell'>Builds an installs the Dell addon, which reads data from |
|
the Dell SM BIOS via <pkg>sys-libs/libsmbios</pkg>. It will read your |
|
service tag information and your hardware backlight data as well as |
|
allow you to modify the backlight settings on a Dell laptop.</flag> |
|
<flag name='disk-partition'>Allows HAL to use libparted from |
|
<pkg>sys-apps/parted</pkg> to read raw partition data from your disks |
|
and process that data. Future versions of HAL (possibly 0.5.11 and |
|
higher) will allow you to create, modify, delete and format partitions |
|
from a GUI interface agnostic of your desktop environment.</flag> |
|
<flag name='doc'>Generates documentation that describes HAL's fdi |
|
format.</flag> |
|
<flag name='pcmcia'>Allows HAL to process PCMCIA/CardBus slot data which |
|
includes inserts and removals and act on these events.</flag> |
|
<flag name='selinux'>Installs SELinux policies and links HAL to the SELinux |
|
libraries.</flag> |
|
</use> |
|
</pkgmetadata> |
|
</pre> |
|
|
|
</body> |
|
</subsection> |
</section> | </section> |
</sections> | </sections> |
