/[gentoo-x86]/eclass/autotools-utils.eclass
Gentoo

Diff of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.50 Revision 1.58
1# Copyright 1999-2012 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.50 2012/05/22 14:29:06 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.58 2012/12/01 16:26:03 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>
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. 14# handling, libtool files removal.
15# 15#
16# Please note note that autotools-utils does not support mixing of its phase 16# Please note that autotools-utils does not support mixing of its phase
17# functions with regular econf/emake calls. If necessary, please call 17# functions with regular econf/emake calls. If necessary, please call
18# autotools-utils_src_compile instead of the latter. 18# autotools-utils_src_compile instead of the latter.
19# 19#
20# @EXAMPLE: 20# @EXAMPLE:
21# Typical ebuild using autotools-utils.eclass: 21# Typical ebuild using autotools-utils.eclass:
74# autotools-utils_src_compile 74# autotools-utils_src_compile
75# use doc && autotools-utils_src_compile docs 75# use doc && autotools-utils_src_compile docs
76# } 76# }
77# 77#
78# src_install() { 78# src_install() {
79# use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/") 79# use doc && HTML_DOCS=("${BUILD_DIR}/apidocs/html/")
80# autotools-utils_src_install 80# autotools-utils_src_install
81# if use examples; then 81# if use examples; then
82# dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\ 82# dobin "${BUILD_DIR}"/foo_example{1,2,3} \\
83# || die 'dobin examples failed' 83# || die 'dobin examples failed'
84# fi 84# fi
85# } 85# }
86# 86#
87# @CODE 87# @CODE
88 88
89# Keep variable names synced with cmake-utils and the other way around! 89# Keep variable names synced with cmake-utils and the other way around!
90 90
91case ${EAPI:-0} in 91case ${EAPI:-0} in
92 2|3|4) ;; 92 2|3|4|5) ;;
93 *) die "EAPI=${EAPI} is not supported" ;; 93 *) die "EAPI=${EAPI} is not supported" ;;
94esac 94esac
95 95
96# @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF 96# @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
97# @DEFAULT_UNSET 97# @DEFAULT_UNSET
109# If your tool is not supported, please open a bug and we'll add support for it. 109# If your tool is not supported, please open a bug and we'll add support for it.
110# 110#
111# Note that dependencies are added for autoconf, automake and libtool only. 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 112# If your package needs one of the external tools listed above, you need to add
113# appropriate packages to DEPEND yourself. 113# appropriate packages to DEPEND yourself.
114[[ ${AUTOTOOLS_AUTORECONF} ]] || _autotools_auto_dep=no 114[[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no}
115 115
116AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
117inherit autotools eutils libtool 116inherit autotools eutils libtool
118 117
119EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 118EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
120 119
121unset _autotools_auto_dep
122
123# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 120# @ECLASS-VARIABLE: BUILD_DIR
124# @DEFAULT_UNSET 121# @DEFAULT_UNSET
125# @DESCRIPTION: 122# @DESCRIPTION:
126# Build directory, location where all autotools generated files should be 123# Build directory, location where all autotools generated files should be
127# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build. 124# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
125#
126# This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127# It is set under that name for compatibility.
128 128
129# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 129# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130# @DEFAULT_UNSET 130# @DEFAULT_UNSET
131# @DESCRIPTION: 131# @DESCRIPTION:
132# Set to enable in-source build. 132# Set to enable in-source build.
184 184
185# Determine using IN or OUT source build 185# Determine using IN or OUT source build
186_check_build_dir() { 186_check_build_dir() {
187 : ${ECONF_SOURCE:=${S}} 187 : ${ECONF_SOURCE:=${S}}
188 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 188 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
189 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 189 BUILD_DIR="${ECONF_SOURCE}"
190 else 190 else
191 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 191 : ${BUILD_DIR:=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}}
192 fi 192 fi
193
194 # Backwards compatibility.
195 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
193 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 196 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
194} 197}
195 198
196# @FUNCTION: remove_libtool_files 199# @FUNCTION: remove_libtool_files
197# @USAGE: [all] 200# @USAGE: [all]
198# @DESCRIPTION: 201# @DESCRIPTION:
205# In most cases it's not necessary to manually invoke this function. 208# In most cases it's not necessary to manually invoke this function.
206# See autotools-utils_src_install for reference. 209# See autotools-utils_src_install for reference.
207remove_libtool_files() { 210remove_libtool_files() {
208 debug-print-function ${FUNCNAME} "$@" 211 debug-print-function ${FUNCNAME} "$@"
209 local removing_all 212 local removing_all
213
214 eqawarn "The remove_libtool_files() function was deprecated."
215 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
216
210 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 217 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
211 if [[ ${#} -eq 1 ]]; then 218 if [[ ${#} -eq 1 ]]; then
212 case "${1}" in 219 case "${1}" in
213 all) 220 all)
214 removing_all=1 221 removing_all=1
260 if [[ ${removing} ]]; then 267 if [[ ${removing} ]]; then
261 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 268 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
262 rm -f "${f}" || die 269 rm -f "${f}" || die
263 fi 270 fi
264 done 271 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} 272}
275 273
276# @FUNCTION: autotools-utils_autoreconf 274# @FUNCTION: autotools-utils_autoreconf
277# @DESCRIPTION: 275# @DESCRIPTION:
278# Reconfigure the sources (like gnome-autogen.sh or eautoreconf). 276# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
279autotools-utils_autoreconf() { 277autotools-utils_autoreconf() {
280 debug-print-function ${FUNCNAME} "$@" 278 debug-print-function ${FUNCNAME} "$@"
279
280 eqawarn "The autotools-utils_autoreconf() function was deprecated."
281 eqawarn "Please call autotools-utils_src_prepare()"
282 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
281 283
282 # Override this func to not require unnecessary eaclocal calls. 284 # Override this func to not require unnecessary eaclocal calls.
283 autotools_check_macro() { 285 autotools_check_macro() {
284 local x 286 local x
285 287
338 FROM_EAUTORECONF=sure eautomake 340 FROM_EAUTORECONF=sure eautomake
339 341
340 local x 342 local x
341 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do 343 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
342 if [[ -d ${x} ]] ; then 344 if [[ -d ${x} ]] ; then
343 pushd "${x}" >/dev/null 345 pushd "${x}" >/dev/null || die
344 autotools-utils_autoreconf 346 autotools-utils_autoreconf
345 popd >/dev/null 347 popd >/dev/null || die
346 fi 348 fi
347 done 349 done
348} 350}
349 351
350# @FUNCTION: autotools-utils_src_prepare 352# @FUNCTION: autotools-utils_src_prepare
373 einfo 'Will autoreconfigure due to user patches applied.' 375 einfo 'Will autoreconfigure due to user patches applied.'
374 want_autoreconf=yep 376 want_autoreconf=yep
375 fi 377 fi
376 fi 378 fi
377 379
378 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf 380 [[ ${want_autoreconf} ]] && eautoreconf
379 elibtoolize --patch-only 381 elibtoolize --patch-only
380} 382}
381 383
382# @FUNCTION: autotools-utils_src_configure 384# @FUNCTION: autotools-utils_src_configure
383# @DESCRIPTION: 385# @DESCRIPTION:
415 fi 417 fi
416 418
417 # Append user args 419 # Append user args
418 econfargs+=("${myeconfargs[@]}") 420 econfargs+=("${myeconfargs[@]}")
419 421
420 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 422 mkdir -p "${BUILD_DIR}" || die
421 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 423 pushd "${BUILD_DIR}" > /dev/null || die
422 econf "${econfargs[@]}" "$@" 424 econf "${econfargs[@]}" "$@"
423 popd > /dev/null 425 popd > /dev/null || die
424} 426}
425 427
426# @FUNCTION: autotools-utils_src_compile 428# @FUNCTION: autotools-utils_src_compile
427# @DESCRIPTION: 429# @DESCRIPTION:
428# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 430# The autotools src_compile function, invokes emake in specified BUILD_DIR.
429autotools-utils_src_compile() { 431autotools-utils_src_compile() {
430 debug-print-function ${FUNCNAME} "$@" 432 debug-print-function ${FUNCNAME} "$@"
431 433
432 _check_build_dir 434 _check_build_dir
433 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 435 pushd "${BUILD_DIR}" > /dev/null || die
434 emake "$@" || die 'emake failed' 436 emake "$@" || die 'emake failed'
435 popd > /dev/null 437 popd > /dev/null || die
436} 438}
437 439
438# @FUNCTION: autotools-utils_src_install 440# @FUNCTION: autotools-utils_src_install
439# @DESCRIPTION: 441# @DESCRIPTION:
440# The autotools src_install function. Runs emake install, unconditionally 442# The autotools src_install function. Runs emake install, unconditionally
445# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 447# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
446autotools-utils_src_install() { 448autotools-utils_src_install() {
447 debug-print-function ${FUNCNAME} "$@" 449 debug-print-function ${FUNCNAME} "$@"
448 450
449 _check_build_dir 451 _check_build_dir
450 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 452 pushd "${BUILD_DIR}" > /dev/null || die
451 emake DESTDIR="${D}" "$@" install || die "emake install failed" 453 emake DESTDIR="${D}" "$@" install || die "emake install failed"
452 popd > /dev/null 454 popd > /dev/null || die
453 455
454 # Move docs installed by autotools (in EAPI < 4). 456 # Move docs installed by autotools (in EAPI < 4).
455 if [[ ${EAPI} == [23] ]] \ 457 if [[ ${EAPI} == [23] ]] \
456 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then 458 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
457 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then 459 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
482 if [[ ${HTML_DOCS} ]]; then 484 if [[ ${HTML_DOCS} ]]; then
483 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" 485 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
484 fi 486 fi
485 487
486 # Remove libtool files and unnecessary static libs 488 # Remove libtool files and unnecessary static libs
487 remove_libtool_files 489 prune_libtool_files
488} 490}
489 491
490# @FUNCTION: autotools-utils_src_test 492# @FUNCTION: autotools-utils_src_test
491# @DESCRIPTION: 493# @DESCRIPTION:
492# The autotools src_test function. Runs emake check in build directory. 494# The autotools src_test function. Runs emake check in build directory.
493autotools-utils_src_test() { 495autotools-utils_src_test() {
494 debug-print-function ${FUNCNAME} "$@" 496 debug-print-function ${FUNCNAME} "$@"
495 497
496 _check_build_dir 498 _check_build_dir
497 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 499 pushd "${BUILD_DIR}" > /dev/null || die
498 # Run default src_test as defined in ebuild.sh 500 # Run default src_test as defined in ebuild.sh
499 default_src_test 501 default_src_test
500 popd > /dev/null 502 popd > /dev/null || die
501} 503}

Legend:
Removed from v.1.50  
changed lines
  Added in v.1.58

  ViewVC Help
Powered by ViewVC 1.1.20