ebuild-writing/functions/pkg_prerm/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

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

<body>
<table>
  <tr>
    <th>Function</th>
    <ti><c>pkg_prerm</c></ti>
  </tr>
  <tr>
    <th>Purpose</th>
    <ti>Called before a package is unmerged</ti>
  </tr>
  <tr>
    <th>Sandbox</th>
    <ti>Disabled</ti>
  </tr>
  <tr>
    <th>Privilege</th>
    <ti>root</ti>
  </tr>
  <tr>
    <th>Called for</th>
    <ti>ebuild, binary</ti>
  </tr>
</table>
</body>

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

<section>
<title>Sample <c>pkg_prerm</c></title>
<body>
<codesample lang="ebuild">
pkg_prerm() {
	# clean up temp files
	[[ -d "${ROOT}/var/tmp/foo" ]] &amp;&amp; rm -rf "${ROOT}/var/tmp/foo"
}
</codesample>
</body>
</section>

<section>
<title>Common <c>pkg_prerm</c> tasks</title>
<body>
<p>
<c>pkg_prerm</c> is used to clean up any files that would otherwise prevent
a clean unmerge.
</p>
</body>
</section>

</chapter>
</guide>