1 | # Copyright 1999-2011 Gentoo Foundation |
1 | # Copyright 1999-2012 Gentoo Foundation |
2 | # Distributed under the terms of the GNU General Public License v2 |
2 | # Distributed under the terms of the GNU General Public License v2 |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.26 2011/11/26 20:42:02 mgorny Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.44 2012/01/19 21:49:38 mgorny Exp $ |
4 | |
4 | |
5 | # @ECLASS: autotools-utils.eclass |
5 | # @ECLASS: autotools-utils.eclass |
6 | # @MAINTAINER: |
6 | # @MAINTAINER: |
7 | # Maciej Mrozowski <reavertm@gentoo.org> |
7 | # Maciej Mrozowski <reavertm@gentoo.org> |
8 | # Michał Górny <mgorny@gentoo.org> |
8 | # Michał Górny <mgorny@gentoo.org> |
9 | # @BLURB: common ebuild functions for autotools-based packages |
9 | # @BLURB: common ebuild functions for autotools-based packages |
10 | # @DESCRIPTION: |
10 | # @DESCRIPTION: |
11 | # autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper |
11 | # autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper |
12 | # providing all inherited features along with econf arguments as Bash array, |
12 | # providing all inherited features along with econf arguments as Bash array, |
13 | # out of source build with overridable build dir location, static archives |
13 | # out of source build with overridable build dir location, static archives |
14 | # handling, libtool files removal, enable/disable debug handling. |
14 | # handling, libtool files removal. |
|
|
15 | # |
|
|
16 | # Please note note that autotools-utils does not support mixing of its phase |
|
|
17 | # functions with regular econf/emake calls. If necessary, please call |
|
|
18 | # autotools-utils_src_compile instead of the latter. |
15 | # |
19 | # |
16 | # @EXAMPLE: |
20 | # @EXAMPLE: |
17 | # Typical ebuild using autotools-utils.eclass: |
21 | # Typical ebuild using autotools-utils.eclass: |
18 | # |
22 | # |
19 | # @CODE |
23 | # @CODE |
… | |
… | |
87 | case ${EAPI:-0} in |
91 | case ${EAPI:-0} in |
88 | 2|3|4) ;; |
92 | 2|3|4) ;; |
89 | *) die "EAPI=${EAPI} is not supported" ;; |
93 | *) die "EAPI=${EAPI} is not supported" ;; |
90 | esac |
94 | esac |
91 | |
95 | |
|
|
96 | # @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF |
|
|
97 | # @DEFAULT_UNSET |
|
|
98 | # @DESCRIPTION: |
|
|
99 | # Set to a non-empty value in order to enable running autoreconf |
|
|
100 | # in src_prepare() and adding autotools dependencies. |
|
|
101 | # |
|
|
102 | # This is usually necessary when using live sources or applying patches |
|
|
103 | # modifying configure.ac or Makefile.am files. Note that in the latter case |
|
|
104 | # setting this variable is obligatory even though the eclass will work without |
|
|
105 | # it (to add the necessary dependencies). |
|
|
106 | # |
|
|
107 | # The eclass will try to determine the correct autotools to run including a few |
|
|
108 | # external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare. |
|
|
109 | # If your tool is not supported, please open a bug and we'll add support for it. |
|
|
110 | # |
|
|
111 | # Note that dependencies are added for autoconf, automake and libtool only. |
|
|
112 | # If your package needs one of the external tools listed above, you need to add |
|
|
113 | # appropriate packages to DEPEND yourself. |
|
|
114 | [[ ${AUTOTOOLS_AUTORECONF} ]] || _autotools_auto_dep=no |
|
|
115 | |
|
|
116 | AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \ |
92 | inherit autotools base eutils libtool |
117 | inherit autotools eutils libtool |
93 | |
118 | |
94 | EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test |
119 | EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test |
95 | |
120 | |
|
|
121 | unset _autotools_auto_dep |
|
|
122 | |
96 | # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR |
123 | # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR |
|
|
124 | # @DEFAULT_UNSET |
97 | # @DESCRIPTION: |
125 | # @DESCRIPTION: |
98 | # Build directory, location where all autotools generated files should be |
126 | # Build directory, location where all autotools generated files should be |
99 | # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build. |
127 | # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build. |
100 | |
128 | |
101 | # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD |
129 | # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD |
|
|
130 | # @DEFAULT_UNSET |
102 | # @DESCRIPTION: |
131 | # @DESCRIPTION: |
103 | # Set to enable in-source build. |
132 | # Set to enable in-source build. |
104 | |
133 | |
105 | # @ECLASS-VARIABLE: ECONF_SOURCE |
134 | # @ECLASS-VARIABLE: ECONF_SOURCE |
|
|
135 | # @DEFAULT_UNSET |
106 | # @DESCRIPTION: |
136 | # @DESCRIPTION: |
107 | # Specify location of autotools' configure script. By default it uses ${S}. |
137 | # Specify location of autotools' configure script. By default it uses ${S}. |
108 | |
138 | |
109 | # @ECLASS-VARIABLE: myeconfargs |
139 | # @ECLASS-VARIABLE: myeconfargs |
|
|
140 | # @DEFAULT_UNSET |
110 | # @DESCRIPTION: |
141 | # @DESCRIPTION: |
111 | # Optional econf arguments as Bash array. Should be defined before calling src_configure. |
142 | # Optional econf arguments as Bash array. Should be defined before calling src_configure. |
112 | # @CODE |
143 | # @CODE |
113 | # src_configure() { |
144 | # src_configure() { |
114 | # local myeconfargs=( |
145 | # local myeconfargs=( |
… | |
… | |
117 | # $(use_enable debug cnddebug) |
148 | # $(use_enable debug cnddebug) |
118 | # $(use_enable threads multithreading) |
149 | # $(use_enable threads multithreading) |
119 | # ) |
150 | # ) |
120 | # autotools-utils_src_configure |
151 | # autotools-utils_src_configure |
121 | # } |
152 | # } |
|
|
153 | # @CODE |
|
|
154 | |
|
|
155 | # @ECLASS-VARIABLE: DOCS |
|
|
156 | # @DEFAULT_UNSET |
|
|
157 | # @DESCRIPTION: |
|
|
158 | # Array containing documents passed to dodoc command. |
|
|
159 | # |
|
|
160 | # Example: |
|
|
161 | # @CODE |
|
|
162 | # DOCS=( NEWS README ) |
|
|
163 | # @CODE |
|
|
164 | |
|
|
165 | # @ECLASS-VARIABLE: HTML_DOCS |
|
|
166 | # @DEFAULT_UNSET |
|
|
167 | # @DESCRIPTION: |
|
|
168 | # Array containing documents passed to dohtml command. |
|
|
169 | # |
|
|
170 | # Example: |
|
|
171 | # @CODE |
|
|
172 | # HTML_DOCS=( doc/html/ ) |
|
|
173 | # @CODE |
|
|
174 | |
|
|
175 | # @ECLASS-VARIABLE: PATCHES |
|
|
176 | # @DEFAULT_UNSET |
|
|
177 | # @DESCRIPTION: |
|
|
178 | # PATCHES array variable containing all various patches to be applied. |
|
|
179 | # |
|
|
180 | # Example: |
|
|
181 | # @CODE |
|
|
182 | # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch ) |
122 | # @CODE |
183 | # @CODE |
123 | |
184 | |
124 | # Determine using IN or OUT source build |
185 | # Determine using IN or OUT source build |
125 | _check_build_dir() { |
186 | _check_build_dir() { |
126 | : ${ECONF_SOURCE:=${S}} |
187 | : ${ECONF_SOURCE:=${S}} |
… | |
… | |
199 | if [[ ${removing} ]]; then |
260 | if [[ ${removing} ]]; then |
200 | einfo "Removing unnecessary ${f#${D%/}} (${removing})" |
261 | einfo "Removing unnecessary ${f#${D%/}} (${removing})" |
201 | rm -f "${f}" || die |
262 | rm -f "${f}" || die |
202 | fi |
263 | fi |
203 | done |
264 | done |
|
|
265 | |
|
|
266 | # check for invalid eclass use |
|
|
267 | # this is the most commonly used function, so do it here |
|
|
268 | _check_build_dir |
|
|
269 | if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then |
|
|
270 | eqawarn "autotools-utils used but autotools-utils_src_configure was never called." |
|
|
271 | eqawarn "This is not supported and never was. Please report a bug against" |
|
|
272 | eqawarn "the offending ebuild. This will become a fatal error in a near future." |
|
|
273 | fi |
|
|
274 | } |
|
|
275 | |
|
|
276 | # @FUNCTION: autotools-utils_autoreconf |
|
|
277 | # @DESCRIPTION: |
|
|
278 | # Reconfigure the sources (like gnome-autogen.sh or eautoreconf). |
|
|
279 | autotools-utils_autoreconf() { |
|
|
280 | debug-print-function ${FUNCNAME} "$@" |
|
|
281 | |
|
|
282 | # Override this func to not require unnecessary eaclocal calls. |
|
|
283 | autotools_check_macro() { |
|
|
284 | local x |
|
|
285 | |
|
|
286 | # Add a few additional variants as we don't get expansions. |
|
|
287 | [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \ |
|
|
288 | AC_CONFIG_HEADER AM_CONFIG_HEADER |
|
|
289 | |
|
|
290 | for x; do |
|
|
291 | grep -h "^${x}" configure.{ac,in} 2>/dev/null |
|
|
292 | done |
|
|
293 | } |
|
|
294 | |
|
|
295 | einfo "Autoreconfiguring '${PWD}' ..." |
|
|
296 | |
|
|
297 | local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \ |
|
|
298 | configure.{ac,in} 2>/dev/null) |
|
|
299 | if [[ ${auxdir} ]]; then |
|
|
300 | auxdir=${auxdir%%]} |
|
|
301 | mkdir -p ${auxdir##[} |
|
|
302 | fi |
|
|
303 | |
|
|
304 | # Support running additional tools like gnome-autogen.sh. |
|
|
305 | # Note: you need to add additional depends to the ebuild. |
|
|
306 | |
|
|
307 | # gettext |
|
|
308 | if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then |
|
|
309 | echo 'no' | autotools_run_tool glib-gettextize --copy |
|
|
310 | elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then |
|
|
311 | eautopoint --force |
|
|
312 | fi |
|
|
313 | |
|
|
314 | # intltool |
|
|
315 | if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]] |
|
|
316 | then |
|
|
317 | autotools_run_tool intltoolize --copy --automake --force |
|
|
318 | fi |
|
|
319 | |
|
|
320 | # gtk-doc |
|
|
321 | if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then |
|
|
322 | autotools_run_tool gtkdocize --copy |
|
|
323 | fi |
|
|
324 | |
|
|
325 | # gnome-doc |
|
|
326 | if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then |
|
|
327 | autotools_run_tool gnome-doc-prepare --copy --force |
|
|
328 | fi |
|
|
329 | |
|
|
330 | # We need to perform the check twice to know whether to run eaclocal. |
|
|
331 | # (_elibtoolize does that itself) |
|
|
332 | if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]] |
|
|
333 | then |
|
|
334 | _elibtoolize --copy --force --install |
|
|
335 | else |
|
|
336 | eaclocal |
|
|
337 | fi |
|
|
338 | |
|
|
339 | eautoconf |
|
|
340 | eautoheader |
|
|
341 | FROM_EAUTORECONF=sure eautomake |
|
|
342 | |
|
|
343 | local x |
|
|
344 | for x in $(autotools_get_subdirs); do |
|
|
345 | if [[ -d ${x} ]] ; then |
|
|
346 | pushd "${x}" >/dev/null |
|
|
347 | autotools-utils_eautoreconf |
|
|
348 | popd >/dev/null |
|
|
349 | fi |
|
|
350 | done |
204 | } |
351 | } |
205 | |
352 | |
206 | # @FUNCTION: autotools-utils_src_prepare |
353 | # @FUNCTION: autotools-utils_src_prepare |
207 | # @DESCRIPTION: |
354 | # @DESCRIPTION: |
208 | # The src_prepare function. |
355 | # The src_prepare function. |
209 | # |
356 | # |
210 | # Supporting PATCHES array and user patches. See base.eclass(5) for reference. |
357 | # Supporting PATCHES array and user patches. See base.eclass(5) for reference. |
211 | autotools-utils_src_prepare() { |
358 | autotools-utils_src_prepare() { |
212 | debug-print-function ${FUNCNAME} "$@" |
359 | debug-print-function ${FUNCNAME} "$@" |
213 | |
360 | |
214 | base_src_prepare |
361 | local want_autoreconf=${AUTOTOOLS_AUTORECONF} |
|
|
362 | |
|
|
363 | touch "${T}"/.autotools-utils.timestamp || die |
|
|
364 | [[ ${PATCHES} ]] && epatch "${PATCHES[@]}" |
|
|
365 | epatch_user |
|
|
366 | if [[ ! ${want_autoreconf} ]]; then |
|
|
367 | if [[ $(find . -newer "${T}"/.autotools-utils.timestamp \ |
|
|
368 | -a '(' -name 'Makefile.am' \ |
|
|
369 | -o -name 'configure.ac' \ |
|
|
370 | -o -name 'configure.in' ')' \ |
|
|
371 | -print -quit) ]]; then |
|
|
372 | einfo 'Will autoreconfigure due to patches applied.' |
|
|
373 | want_autoreconf=yep |
|
|
374 | fi |
|
|
375 | fi |
|
|
376 | |
|
|
377 | [[ ${want_autoreconf} ]] && autotools-utils_autoreconf |
215 | elibtoolize --patch-only |
378 | elibtoolize --patch-only |
216 | } |
379 | } |
217 | |
380 | |
218 | # @FUNCTION: autotools-utils_src_configure |
381 | # @FUNCTION: autotools-utils_src_configure |
219 | # @DESCRIPTION: |
382 | # @DESCRIPTION: |
… | |
… | |
228 | debug-print-function ${FUNCNAME} "$@" |
391 | debug-print-function ${FUNCNAME} "$@" |
229 | |
392 | |
230 | [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ |
393 | [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ |
231 | || die 'autotools-utils.eclass: myeconfargs has to be an array.' |
394 | || die 'autotools-utils.eclass: myeconfargs has to be an array.' |
232 | |
395 | |
|
|
396 | [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX= |
|
|
397 | |
233 | # Common args |
398 | # Common args |
234 | local econfargs=() |
399 | local econfargs=() |
235 | |
400 | |
236 | # Handle debug found in IUSE |
401 | _check_build_dir |
237 | if in_iuse debug; then |
402 | if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then |
238 | local debugarg=$(use_enable debug) |
403 | econfargs+=( |
239 | if ! has "${debugarg}" "${myeconfargs[@]}"; then |
404 | --docdir="${EPREFIX}"/usr/share/doc/${PF} |
240 | eqawarn 'Implicit $(use_enable debug) for IUSE="debug" is no longer supported.' |
405 | ) |
241 | eqawarn 'Please add the necessary arg to myeconfargs if requested.' |
|
|
242 | eqawarn 'The autotools-utils eclass will stop warning about it on Oct 15th.' |
|
|
243 | fi |
|
|
244 | fi |
406 | fi |
245 | |
407 | |
246 | # Handle static-libs found in IUSE, disable them by default |
408 | # Handle static-libs found in IUSE, disable them by default |
247 | if in_iuse static-libs; then |
409 | if in_iuse static-libs; then |
248 | econfargs+=( |
410 | econfargs+=( |
… | |
… | |
252 | fi |
414 | fi |
253 | |
415 | |
254 | # Append user args |
416 | # Append user args |
255 | econfargs+=("${myeconfargs[@]}") |
417 | econfargs+=("${myeconfargs[@]}") |
256 | |
418 | |
257 | _check_build_dir |
|
|
258 | mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" |
419 | mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" |
259 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
420 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
260 | base_src_configure "${econfargs[@]}" "$@" |
421 | econf "${econfargs[@]}" "$@" |
261 | popd > /dev/null || die |
422 | popd > /dev/null |
262 | } |
423 | } |
263 | |
424 | |
264 | # @FUNCTION: autotools-utils_src_compile |
425 | # @FUNCTION: autotools-utils_src_compile |
265 | # @DESCRIPTION: |
426 | # @DESCRIPTION: |
266 | # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. |
427 | # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. |
267 | autotools-utils_src_compile() { |
428 | autotools-utils_src_compile() { |
268 | debug-print-function ${FUNCNAME} "$@" |
429 | debug-print-function ${FUNCNAME} "$@" |
269 | |
430 | |
270 | _check_build_dir |
431 | _check_build_dir |
271 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
432 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
272 | base_src_compile "$@" |
433 | emake "$@" || die 'emake failed' |
273 | popd > /dev/null || die |
434 | popd > /dev/null |
274 | } |
435 | } |
275 | |
436 | |
276 | # @FUNCTION: autotools-utils_src_install |
437 | # @FUNCTION: autotools-utils_src_install |
277 | # @DESCRIPTION: |
438 | # @DESCRIPTION: |
278 | # The autotools src_install function. Runs emake install, unconditionally |
439 | # The autotools src_install function. Runs emake install, unconditionally |
… | |
… | |
283 | # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. |
444 | # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. |
284 | autotools-utils_src_install() { |
445 | autotools-utils_src_install() { |
285 | debug-print-function ${FUNCNAME} "$@" |
446 | debug-print-function ${FUNCNAME} "$@" |
286 | |
447 | |
287 | _check_build_dir |
448 | _check_build_dir |
288 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
449 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
289 | base_src_install "$@" |
450 | emake DESTDIR="${D}" "$@" install || die "emake install failed" |
290 | popd > /dev/null || die |
451 | popd > /dev/null |
|
|
452 | |
|
|
453 | # Move docs installed by autotools (in EAPI < 4). |
|
|
454 | if [[ ${EAPI} == [23] ]] \ |
|
|
455 | && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then |
|
|
456 | if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then |
|
|
457 | eqawarn "autotools-utils: directories in docdir require at least EAPI 4" |
|
|
458 | else |
|
|
459 | mkdir "${T}"/temp-docdir |
|
|
460 | mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \ |
|
|
461 | || die "moving docs to tempdir failed" |
|
|
462 | |
|
|
463 | dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed" |
|
|
464 | rm -r "${T}"/temp-docdir || die |
|
|
465 | fi |
|
|
466 | fi |
|
|
467 | |
|
|
468 | # XXX: support installing them from builddir as well? |
|
|
469 | if [[ ${DOCS} ]]; then |
|
|
470 | dodoc "${DOCS[@]}" || die "dodoc failed" |
|
|
471 | else |
|
|
472 | local f |
|
|
473 | # same list as in PMS |
|
|
474 | for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \ |
|
|
475 | THANKS BUGS FAQ CREDITS CHANGELOG; do |
|
|
476 | if [[ -s ${f} ]]; then |
|
|
477 | dodoc "${f}" || die "(default) dodoc ${f} failed" |
|
|
478 | fi |
|
|
479 | done |
|
|
480 | fi |
|
|
481 | if [[ ${HTML_DOCS} ]]; then |
|
|
482 | dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" |
|
|
483 | fi |
291 | |
484 | |
292 | # Remove libtool files and unnecessary static libs |
485 | # Remove libtool files and unnecessary static libs |
293 | remove_libtool_files |
486 | remove_libtool_files |
294 | } |
487 | } |
295 | |
488 | |
… | |
… | |
298 | # The autotools src_test function. Runs emake check in build directory. |
491 | # The autotools src_test function. Runs emake check in build directory. |
299 | autotools-utils_src_test() { |
492 | autotools-utils_src_test() { |
300 | debug-print-function ${FUNCNAME} "$@" |
493 | debug-print-function ${FUNCNAME} "$@" |
301 | |
494 | |
302 | _check_build_dir |
495 | _check_build_dir |
303 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
496 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
304 | # Run default src_test as defined in ebuild.sh |
497 | # Run default src_test as defined in ebuild.sh |
305 | default_src_test |
498 | default_src_test |
306 | popd > /dev/null || die |
499 | popd > /dev/null |
307 | } |
500 | } |