Metadata Examples

tag

description

attribute

tags

description

+Metadata Examples + +First Example + + +

+In this first example we provide you with the metadata.xml for +OpenOffice of which the ebuilds are completely managed by a herd called +openoffice: +

+ - <?xml version="1.0" encoding="UTF-8"?> - <!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> - <pkgmetadata> - <herd>freedesktop</herd> - <maintainer> - <email>dang@gentoo.org</email> - <name>Daniel Gryniewicz</name> +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> +<pkgmetadata> + <herd>openoffice</herd> + <longdescription> + OpenOffice is the opensource version of staroffice. + This ebuild allows you to compile it yourself. Unfortunately this + compilation can take up to a day depending on the speed of your + computer. It will however make a snappier openoffice than the binary + version. + </longdescription> +</pkgmetadata> + + +

+The openoffice herd is defined in herds.xml by the +Gentoo Metastructure Project: +

+ + +This example may be outdated when you read it. It's just an example! + + + +<herd> + <name>openoffice</name> + <email>openoffice@gentoo.org</email> + <description>Openoffice related packages</description> + <maintainer><email>pauldv@gentoo.org</email></maintainer> + <maintainer><email>suka@gentoo.org</email></maintainer> +</herd> + + +

+If you want to add (or remove) yourself from a herd, edit herds.xml +located in [gentoo]/xml/htdocs/proj/en/metastructure/herds in Gentoo's CVS repository. Make sure you +know the e-mail alias the herd listens to (for instance the "sound" herd has +sound@gentoo.org) and add yourself to the +alias (by editing /var/mail/alias/misc/<alias name> on +dev.gentoo.org). +

+ + + + +Second Example + + +

+For the second example, we will examine the metadata.xml of +app-portage/mirrorselect. This ebuild is maintained by the +tools-portage herd, but has a separate maintainer. +

+ +

+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+  <herd>tools-portage</herd>
+  <maintainer>
+    <email>johnm@gentoo.org</email>
+    <name>John Mylchreest</name>
+  </maintainer>
+  <longdescription>
+    This utility is used to select the fastest mirror (distfiles) and provide a
+    nicer front-end for mirror selection (both rsync + distfiles) to a user.
+  </longdescription>
+</pkgmetadata>
+

+ + + + +Third Example + + +

+For the third example, we will describe the metadata.xml of +sys-apps/hal. This ebuild is maintained by the gentopia herd +and contains 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> + + + + + +Fourth Example + + +

+This example demonstrates the usage of the upstream element: +

+ + +<upstream> + <maintainer status="inactive"> + <name>Foo Bar</name> + <email>foo@bar.bar</email> + </maintainer> + <maintainer status="active"> + <name>Foo Gentoo</name> + <email>foo@gentoo.org</email> </maintainer> - <longdescription lang="en"> - HAL provides a view of the various hardware attached to a system. - In addition to this, HAL keeps detailed metadata for each piece of - hardware and provide hooks such that system- and desktop-level software - can react to changes in the hardware configuration in order to maintain - system policy. - </longdescription> - <use> - <flag name="laptop">Adds support for power management scripts - (<pkg>sys-power/pm-utils</pkg>)</flag> - <flag name="selinux">Installs SELinux policies and links HAL to the SELinux - libraries.</flag> - </use> - </pkgmetadata> + <changelog>http://foo.bar/changelog.txt</changelog> + <doc lang="en">http://foo.bar/doc/index.html</doc> + <doc lang="de">http://foo.bar/doc/index.de.html</doc> + <bugs-to>https://bugs.foo.bar</bugs-to> + <remote-id type="freshmeat">foobar</remote-id> + <remote-id type="sourceforge">foobar</remote-id> +</upstream> + + + +

All new packages must include a metadata.xml file. That file should specify at least one herd or one maintainer. It is however recommended, @@ -67,7 +488,6 @@ should ensure that you have dev-libs/libxml2 installed so that the XML can be validated.