ebuild-writing/functions/src_prepare/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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

<?xml version="1.0"?>
<guide self="ebuild-writing/functions/src_prepare/">
<chapter>
<title>src_prepare</title>

<body>
<table>
  <tr>
    <th>Function</th>
    <ti><c>src_prepare</c></ti>
  </tr>
  <tr>
    <th>Purpose</th>
    <ti>Prepare source packages and do any necessary patching or fixes.</ti>
  </tr>
  <tr>
    <th>Sandbox</th>
    <ti>Enabled</ti>
  </tr>
  <tr>
    <th>Privilege</th>
    <ti>user</ti>
  </tr>
  <tr>
    <th>Called for</th>
    <ti>ebuild</ti>
  </tr>
</table>
</body>

<section>
<title>Default <c>src_prepare</c></title>
<body>

<p>
Before EAPI 6, the default implementation did nothing:
</p>

<codesample lang="ebuild">
src_prepare() {
	true
}
</codesample>

<p>
Beginning with EAPI 6, the src_prepare function gained a new default
implementation:
</p>

<codesample lang="ebuild">
src_prepare() {
	if [[ $(declare -p PATCHES 2&gt;/dev/null) == "declare -a"* ]]; then
		[[ -n ${PATCHES[@]} ]] &amp;&amp; eapply "${PATCHES[@]}"
	else
		[[ -n ${PATCHES} ]] &amp;&amp; eapply ${PATCHES}
	fi
	eapply_user
}
</codesample>

<note>
With EAPI 6, you must call <c>eapply_user</c> or <c>default</c> if you define
<c>src_prepare</c>!
</note>

</body>
</section>

<section>
<title>Sample <c>src_prepare</c></title>
<body>
<codesample lang="ebuild">
src_prepare() {
	eapply "${FILESDIR}/${PV}/${P}-fix-bogosity.patch"
	eapply "${FILESDIR}/${PV}/${P}-pam.patch"

	eapply_user

	sed -i -e 's/"ispell"/"aspell"/' src/defaults.h || die "Sed failed!"
}
</codesample>
</body>
</section>

<section>
<title><c>src_prepare</c> Processes</title>
<body>
<p>
The following subsections cover different topics which often occur
when writing <c>src_prepare</c> functions.
</p>

<contentsTree/>
</body>
</section>

</chapter>
<include href="epatch/"/>
<include href="autopackage/"/>
</guide>