Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 199788 | Differences between
and this patch

Collapse All | Expand All

(-)hb-guide-metadata.xml (-3 / +79 lines)
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-123 Link Here
115
  <ti><brite>&lt;longdescription&gt;</brite></ti>
115
  <ti><brite>&lt;longdescription&gt;</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>&lt;pkg&gt;</brite> and <brite>&lt;cat&gt;</brite>.
119
  </ti>
120
  </ti>
120
</tr>
121
</tr>
122
<tr>
123
  <ti><brite>&lt;use&gt;</brite></ti>
124
  <ti>
125
    This tag contains descriptions of <uri
126
    link="/doc/en/handbook/handbook-x86.xml?part=2&amp;chap=2">USE flags</uri>.
127
    This tag is optional and, if specified, has one required subtag:
128
    <brite>&lt;flag&gt;</brite>.
129
  </ti>
130
</tr>
131
<tr>
132
  <ti><brite>&lt;flag&gt;</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>&lt;use&gt;</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>&lt;pkg&gt;</brite> and
138
    <brite>&lt;cat&gt;</brite>.
139
  </ti>
140
</tr>
141
<tr>
142
  <ti><brite>&lt;pkg&gt;</brite></ti>
121
</table>
143
</table>
122
144
123
<p>
145
<p>
Lines 256-260 Link Here
256
278
257
</body>
279
</body>
258
</subsection>
280
</subsection>
281
<subsection>
282
<title>Third Example</title>
283
<body>
284
285
<p>
286
For the third example, we will describe the <path>metadata.xml</path> of
287
<c>sys-apps/hal</c>. This ebuild is maintained by the <c>gentopia</c> herd
288
and contains USE flag descriptions.
289
</p>
290
291
<pre caption="USE flag descriptions">
292
&lt;?xml version="1.0" encoding="UTF-8"&gt;
293
&lt;!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"&gt;
294
&lt;pkgmetadata&gt;
295
&lt;herd&gt;gentopia&lt;/herd&gt;
296
&lt;maintainer&gt;
297
	&lt;email&gt;compnerd@gentoo.org&lt;/email&gt;
298
&lt;/maintainer&gt;
299
&lt;maintainer&gt;
300
	&lt;email&gt;steev@gentoo.org&lt;/email&gt;
301
&lt;/maintainer&gt;
302
&lt;use&gt;
303
	&lt;flag name='acpi'&gt;Enables HAL to attempt to read from
304
	/proc/acpi/event, if unavailable, HAL will read events from
305
	&lt;pkg&gt;sys-power/acpid&lt;/pkg&gt;. If you need multiple acpi
306
	readers, ensure acpid is in your default runlevel along with HAL. This
307
	will also enable HAL to read Toshia and IBM acpi events which do not
308
	get sent via /proc/acpi/event&lt;/flag&gt;
309
	&lt;flag name='crypt'&gt;Allows HAL to mount volumes that are encrypted using
310
	LUKS. &lt;pkg&gt;sys-fs/cryptsetup-luks&lt;/pkg&gt; which has recently been renamed
311
	to &lt;pkg&gt;sys-fs/cryptsetup&lt;/pkg&gt; allows you to create such encrypted
312
	volumes. HAL will be able to handle volumes that are removable or
313
	fixed.&lt;/flag&gt;
314
	&lt;flag name='dell'&gt;Builds an installs the Dell addon, which reads data from
315
	the Dell SM BIOS via &lt;pkg&gt;sys-libs/libsmbios&lt;/pkg&gt;. It will read your
316
	service tag information and your hardware backlight data as well as
317
	allow you to modify the backlight settings on a Dell laptop.&lt;/flag&gt;
318
	&lt;flag name='disk-partition'&gt;Allows HAL to use libparted from
319
	&lt;pkg&gt;sys-apps/parted&lt;/pkg&gt; to read raw partition data from your disks
320
	and process that data. Future versions of HAL (possibly 0.5.11 and
321
	higher) will allow you to create, modify, delete and format partitions
322
	from a GUI interface agnostic of your desktop environment.&lt;/flag&gt;
323
	&lt;flag name='doc'&gt;Generates documentation that describes HAL's fdi
324
	format.&lt;/flag&gt;
325
	&lt;flag name='pcmcia'&gt;Allows HAL to process PCMCIA/CardBus slot data which
326
	includes inserts and removals and act on these events.&lt;/flag&gt;
327
	&lt;flag name='selinux'&gt;Installs SELinux policies and links HAL to the SELinux
328
	libraries.&lt;/flag&gt;
329
&lt;/use&gt;
330
&lt;/pkgmetadata&gt;
331
</pre>
332
333
</body>
334
</subsection>
259
</section>
335
</section>
260
</sections>
336
</sections>

Return to bug 199788