Go to:
Gentoo Home
Documentation
Forums
Lists
Bugs
Planet
Store
Wiki
Get Gentoo!
Gentoo's Bugzilla – Attachment 137127 Details for
Bug 199788
GLEP56: metadata DTD updates for USE flag descriptions & validate metadata.xml at commit
Home
|
New
–
[Ex]
|
Browse
|
Search
|
Privacy Policy
|
[?]
|
Reports
|
Requests
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Developer Handbook Metadata.xml Documentation Updates
hb-guide-metadata.diff (text/plain), 8.14 KB, created by
Doug Goldstein (RETIRED)
on 2007-11-27 16:49:05 UTC
(
hide
)
Description:
Developer Handbook Metadata.xml Documentation Updates
Filename:
MIME Type:
Creator:
Doug Goldstein (RETIRED)
Created:
2007-11-27 16:49:05 UTC
Size:
8.14 KB
patch
obsolete
>--- hb-guide-metadata.xml?rev=1.9 2007-11-27 10:08:28.000000000 -0500 >+++ hb-guide-metadata.xml 2007-11-27 11:28:51.000000000 -0500 >@@ -10,8 +10,8 @@ > --> > > <sections> >-<version>1.0.4</version> >-<date>2007-07-31</date> >+<version>1.0.5</version> >+<date>2007-11-27</date> > > <section> > <title>Why the need for metadata.xml?</title> >@@ -19,14 +19,14 @@ > <body> > > <p> >-The <c>metadata.xml</c> file has as its purpose to give extra information about >-ebuilds. The <c>metadata.xml</c> file should exist in every package directory. >-A skel file can be found as <c>skel.metadata.xml</c> in the portage tree. >+The <path>metadata.xml</path> file has as its purpose to give extra information about >+ebuilds. The <path>metadata.xml</path> file should exist in every package directory. >+A skel file can be found as <path>skel.metadata.xml</path> in the root of the portage tree. > </p> > > <note> >-Please run <c>xmllint --valid metadata.xml</c> before committing a >-<c>metadata.xml</c> file. We hope to add support for <c>metadata.xml</c> to >+Please run <c>xmllint --valid --noout metadata.xml</c> before committing a >+<path>metadata.xml</path> file. We hope to add support for <path>metadata.xml</path> to > repoman soon. > </note> > >@@ -40,7 +40,7 @@ > <body> > > <p> >-A <c>metadata.xml</c> file can contain a number of tags: >+A <path>metadata.xml</path> file can contain a number of tags: > </p> > > <table> >@@ -53,7 +53,7 @@ > <brite><pkgmetadata></brite> > </ti> > <ti> >- This is the root element of the metadata.xml file for packages. It has >+ This is the root element of the <path>metadata.xml</path> file for packages. It has > no attributes. Its required subtag is: <brite><herd></brite>. > Furthermore, the following subtags are allowed: <brite><email></brite> > for a general herd email address, <brite><maintainer></brite>, and >@@ -65,7 +65,7 @@ > <brite><catmetadata></brite> > </ti> > <ti> >- This is the root element of the metadata.xml file for categories as per >+ This is the root element of the <path>metadata.xml</path> file for categories as per > <uri link="/proj/en/glep/glep-0034.html">GLEP 34</uri>. It has > no attributes. It contains a number of > <brite><longdescription></brite> tags, each for a different >@@ -119,7 +119,33 @@ > <ti><brite><longdescription></brite></ti> > <ti> > 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 one optional >+ subtag: <brite><pkg></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 also requires the USE flag to be named in the <c>name</c> attribute. >+ This tag has one optional subtag: <brite><pkg></brite>. >+ </ti> >+</tr> >+<tr> >+ <ti><brite><pkg></brite></ti> >+ <ti> >+ This tag contains a package name in the format of category/package. For >+ example, <c><pkg>sys-apps/hal</pkg></c>. > </ti> > </tr> > </table> >@@ -138,7 +164,7 @@ > <tr> > <ti>lang</ti> > <ti> >- <brite><description></brite>, <brite><longdescription></brite> >+ <brite><description></brite>, <brite><longdescription></brite>, <brite><use></brite> > </ti> > <ti> > In every case where a description is required, there must be at >@@ -153,7 +179,7 @@ > <ti>restrict</ti> > <ti> > <brite><herd></brite>, <brite><maintainer></brite>, >- <brite><longdescription></brite> >+ <brite><longdescription></brite>, <brite><flag></brite> > </ti> > <ti> > The restrict attribute allows to restrict the application of certain tags >@@ -163,10 +189,23 @@ > is that of the DEPEND flag, except that "<" and > ">" need to be specified by &lt; and &gt;.<br /> > <br /> >- For example in the db package >- <c>restrict="&gt;=sys-libs/db-3.2.9-r5"</c> >- on the maintainer tag shows that I'm currently maintaining all versions >- bigger then 3.2.9-r5. >+ For example in the <c>sys-libs/db</c> package, >+ <c>restrict=">=sys-libs/db-3.2.9-r5"</c> >+ on the <brite><maintainer></brite> tag shows that I'm currently maintaining all versions >+ greater than <c>3.2.9-r5</c>. >+ </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 sys-apps/hal package, >+ <c><flag name='acpi'>Enables ACPI (longer description in the actual file)</flag></c> > </ti> > </tr> > </table> >@@ -237,7 +276,7 @@ > <body> > > <p> >-As second example we view the <path>metadata.xml</path> of <c>mirrorselect</c>. >+For the second example, we view the <path>metadata.xml</path> of <c>app-portage/mirrorselect</c>. > This ebuild is maintained by the <c>tools-portage</c> herd, but has a separate > maintainer. > </p> >@@ -260,5 +299,61 @@ > > </body> > </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>cardoe@gentoo.org</email> >+</maintainer> >+<maintainer> >+ <email>steev@gentoo.org</email> >+</maintainer> >+<maintainer> >+ <email>compnerd@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 (rc-update add acpid default) along with HAL. This will also >+ enable HAL to read Toshiba 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> > </sections>
<b>You cannot view the attachment while viewing its details because your browser does not support IFRAMEs. <a href="attachment.cgi?id=137127">View the attachment on a separate page</a>.</b>
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
Attachments on
bug 199788
:
136492
|
137127
|
137138
|
160085
|
160087
|
160144
|
160145
|
160377
|
160458
|
160472
|
160476
