ebuild-writing/functions/pkg_info/text.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<?xml version="1.0" encoding="UTF-8"?>
<guide self="ebuild-writing/functions/pkg_info/">
<chapter>
<title>pkg_info</title>

<body>
<table>
  <tr>
    <th>Function</th>
    <ti><c>pkg_info</c></ti>
  </tr>
  <tr>
    <th>Purpose</th>
    <ti>display information about a package</ti>
  </tr>
  <tr>
    <th>Sandbox</th>
    <ti>?</ti>
  </tr>
  <tr>
    <th>Privilege</th>
    <ti>root</ti>
  </tr>
  <tr>
    <th>Called for</th>
    <ti>ebuild</ti>
  </tr>
</table>
</body>

<section>
<title>Default <c>pkg_info</c></title>
<body>
<codesample lang="ebuild">
pkg_info() {
	return
}
</codesample>
</body>
</section>

<section>
<title>Sample <c>pkg_info</c></title>
<body>
<codesample lang="ebuild">
pkg_info() {
	"${ROOT}"/usr/bin/mythfrontend --version
}
</codesample>
</body>
</section>

<section>
<title>Notes on <c>pkg_info</c></title>
<body>

<p>
This phase will be called when a package manager displays information about
a package.
</p>

<p>
The <c>pkg_info</c> function may also be called by the package manager for
non-installed packages. Ebuild writers should note that dependencies may not be
available.
</p>

</body>
</section>
</chapter>
</guide>