summaryrefslogtreecommitdiffstats
path: root/doc/package/ebuild/eapi/2.docbook
blob: 275ab71ef0c0e4bce3a573e159f0081adb51fff8 (plain)
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<sect1 id='package-ebuild-eapi-2_pre1'>
	<title>EAPI 2_pre1</title>
	<sect2 id='package-ebuild-eapi-2-helpers'>
	<title>Helpers</title>
	<sect3 id='package-ebuild-eapi-2-helpers-doman'>
	<title>doman</title>
	<para>
	Language codes in file names are now used for path translation.
	</para>
	<table><title>Man Page Path Translation</title>
	<tgroup cols='2' align='left' >
	<colspec colname='source'/>
	<colspec colname='destination'/>
	<thead>
	<row>
	<entry>Source</entry>
	<entry>Destination</entry>
	</row>
	</thead>
	<tbody>
	<row>
	<entry>foo.1</entry>
	<entry>/usr/share/man/man1/foo.1</entry>
	</row>
	<row>
	<entry>foo.lang.1</entry>
	<entry>/usr/share/man/lang/man1/foo.1</entry>
	</row>
	</tbody>
	</tgroup>
	</table>
	</sect3>
	</sect2>
	<sect2 id='package-ebuild-eapi-2-use-deps'>
	<title>USE Dependencies</title>
	<sect3 id='package-ebuild-eapi-2-use-deps-unconditional'>
	<title>Unconditional USE Dependencies</title>
	<table><title>Syntax Examples</title>
	<tgroup cols='2' align='left' >
	<colspec colname='example'/>
	<colspec colname='meaning'/>
	<thead>
	<row>
	<entry>Example</entry>
	<entry>Meaning</entry>
	</row>
	</thead>
	<tbody>
	<row>
	<entry>foo[bar]</entry>
	<entry>foo must have bar enabled</entry>
	</row>
	<row>
	<entry>foo[bar,baz]</entry>
	<entry>foo must have both bar and baz enabled</entry>
	</row>
	<row>
	<entry>foo[-bar,baz]</entry>
	<entry>foo must have bar disabled and baz enabled</entry>
	</row>
	</tbody>
	</tgroup>
	</table>
	</sect3>
	<sect3 id='package-ebuild-eapi-2-use-deps-conditional'>
	<title>Conditional USE Dependencies</title>
	<table><title>Syntax Examples</title>
	<tgroup cols='2' align='left' >
	<colspec colname='compact'/>
	<colspec colname='expanded'/>
	<thead>
	<row>
	<entry>Compact Form</entry>
	<entry>Equivalent Expanded Form</entry>
	</row>
	</thead>
	<tbody>
	<row>
	<entry>foo[bar?]</entry>
	<entry>bar? ( foo[bar]  ) !bar? ( foo       )</entry>
	</row>
	<row>
	<entry>foo[!bar?]</entry>
	<entry>bar? ( foo       ) !bar? ( foo[-bar] )</entry>
	</row>
	<row>
	<entry>foo[bar=]</entry>
	<entry>bar? ( foo[bar]  ) !bar? ( foo[-bar] )</entry>
	</row>
	<row>
	<entry>foo[!bar=]</entry>
	<entry>bar? ( foo[-bar] ) !bar? ( foo[bar]  )</entry>
	</row>
	</tbody>
	</tgroup>
	</table>
	</sect3>
	</sect2>
</sect1>
<sect1 id='package-ebuild-eapi-2_pre2'>
	<title>EAPI 2_pre2</title>
	<sect2 id='package-ebuild-eapi-2-phases'>
		<title>Phases</title>
		<sect3 id='package-ebuild-eapi-2-phases-src-configure'>
			<title>New src_configure Phase Function</title>
			<para>
			The configure portion of the src_compile function has been
			split into a separate function which is named src_configure. The
			src_configure function is called in between the src_unpack and
			src_compile functions.
			</para>
			<table><title>Execution Order of Phase Functions</title>
				<tgroup cols='1' align='left' >
				<colspec colname='name'/>
				<thead>
				<row>
					<entry>Phase Function Name</entry>
				</row>
				</thead>
				<tbody>
				<row>
					<entry>pkg_setup</entry>
				</row>
				<row>
					<entry>src_unpack</entry>
				</row>
				<row>
					<entry>src_configure</entry>
				</row>
				<row>
					<entry>src_compile</entry>
				</row>
				<row>
					<entry>src_test</entry>
				</row>
				<row>
					<entry>src_install</entry>
				</row>
				<row>
					<entry>pkg_preinst</entry>
				</row>
				<row>
					<entry>pkg_postinst</entry>
				</row>
				<row>
					<entry>pkg_prerm</entry>
				</row>
				<row>
					<entry>pkg_postrm</entry>
				</row>
				</tbody>
				</tgroup>
			</table>
		</sect3>
		<sect3 id='package-ebuild-eapi-2-phases-default-functions'>
			<title>Default Phase Functions</title>
			<para>
			Each of the default src_* phase functions is now accessible
			via a function having a name that begins with default_ and
			ends with the respective phase function name. For example,
			a call to a function with the name default_src_compile is
			equivalent to a call to the default src_compile
			implementation.
			</para>
		</sect3>
		<sect3 id='package-ebuild-eapi-2-phases-default-function-alias'>
			<title>Default Phase Function Alias</title>
			<para>
			A function named "default" is redefined for each phase so that it
			will call the default_* function corresponding to the current phase.
			For example, a call to the function named "default" during the
			src_compile phase is equivalent to a call to the function named
			default_src_compile.
			</para>
		</sect3>
	</sect2>
</sect1>