/[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.64
1# Copyright 1999-2012 Gentoo Foundation 1# Copyright 1999-2013 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.64 2013/04/01 09:16:07 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:
35# IUSE="debug doc examples qt4 static-libs tiff" 35# IUSE="debug doc examples qt4 static-libs tiff"
36# 36#
37# CDEPEND=" 37# CDEPEND="
38# media-libs/libpng:0 38# media-libs/libpng:0
39# qt4? ( 39# qt4? (
40# x11-libs/qt-core:4 40# dev-qt/qtcore:4
41# x11-libs/qt-gui:4 41# dev-qt/qtgui:4
42# ) 42# )
43# tiff? ( media-libs/tiff:0 ) 43# tiff? ( media-libs/tiff:0 )
44# " 44# "
45# RDEPEND="${CDEPEND} 45# RDEPEND="${CDEPEND}
46# !media-gfx/bar 46# !media-gfx/bar
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.
155# @ECLASS-VARIABLE: DOCS 155# @ECLASS-VARIABLE: DOCS
156# @DEFAULT_UNSET 156# @DEFAULT_UNSET
157# @DESCRIPTION: 157# @DESCRIPTION:
158# Array containing documents passed to dodoc command. 158# Array containing documents passed to dodoc command.
159# 159#
160# In EAPIs 4+, can list directories as well.
161#
160# Example: 162# Example:
161# @CODE 163# @CODE
162# DOCS=( NEWS README ) 164# DOCS=( NEWS README )
163# @CODE 165# @CODE
164 166
179# 181#
180# Example: 182# Example:
181# @CODE 183# @CODE
182# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch ) 184# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
183# @CODE 185# @CODE
186
187# @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
188# @DEFAULT-UNSET
189# @DESCRIPTION:
190# Sets the mode of pruning libtool files. The values correspond to
191# prune_libtool_files parameters, with leading dashes stripped.
192#
193# Defaults to pruning the libtool files when static libraries are not
194# installed or can be linked properly without them. Libtool files
195# for modules (plugins) will be kept in case plugin loader needs them.
196#
197# If set to 'modules', the .la files for modules will be removed
198# as well. This is often the preferred option.
199#
200# If set to 'all', all .la files will be removed unconditionally. This
201# option is discouraged and shall be used only if 'modules' does not
202# remove the files.
184 203
185# Determine using IN or OUT source build 204# Determine using IN or OUT source build
186_check_build_dir() { 205_check_build_dir() {
187 : ${ECONF_SOURCE:=${S}} 206 : ${ECONF_SOURCE:=${S}}
188 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 207 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
189 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 208 BUILD_DIR="${ECONF_SOURCE}"
190 else 209 else
210 # Respect both the old variable and the new one, depending
211 # on which one was set by the ebuild.
212 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
213 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
214 eqawarn "Please migrate the ebuild to use the new one."
215
216 # In the next call, both variables will be set already
217 # and we'd have to know which one takes precedence.
218 _RESPECT_AUTOTOOLS_BUILD_DIR=1
219 fi
220
221 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
222 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
223 else
191 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 224 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
192 fi 225 fi
226 fi
227
228 # Backwards compatibility for getting the value.
229 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
193 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 230 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
194} 231}
195 232
196# @FUNCTION: remove_libtool_files 233# @FUNCTION: remove_libtool_files
197# @USAGE: [all] 234# @USAGE: [all]
198# @DESCRIPTION: 235# @DESCRIPTION:
205# In most cases it's not necessary to manually invoke this function. 242# In most cases it's not necessary to manually invoke this function.
206# See autotools-utils_src_install for reference. 243# See autotools-utils_src_install for reference.
207remove_libtool_files() { 244remove_libtool_files() {
208 debug-print-function ${FUNCNAME} "$@" 245 debug-print-function ${FUNCNAME} "$@"
209 local removing_all 246 local removing_all
247
248 eqawarn "The remove_libtool_files() function was deprecated."
249 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
250
210 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 251 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
211 if [[ ${#} -eq 1 ]]; then 252 if [[ ${#} -eq 1 ]]; then
212 case "${1}" in 253 case "${1}" in
213 all) 254 all)
214 removing_all=1 255 removing_all=1
260 if [[ ${removing} ]]; then 301 if [[ ${removing} ]]; then
261 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 302 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
262 rm -f "${f}" || die 303 rm -f "${f}" || die
263 fi 304 fi
264 done 305 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} 306}
275 307
276# @FUNCTION: autotools-utils_autoreconf 308# @FUNCTION: autotools-utils_autoreconf
277# @DESCRIPTION: 309# @DESCRIPTION:
278# Reconfigure the sources (like gnome-autogen.sh or eautoreconf). 310# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
279autotools-utils_autoreconf() { 311autotools-utils_autoreconf() {
280 debug-print-function ${FUNCNAME} "$@" 312 debug-print-function ${FUNCNAME} "$@"
313
314 eqawarn "The autotools-utils_autoreconf() function was deprecated."
315 eqawarn "Please call autotools-utils_src_prepare()"
316 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
281 317
282 # Override this func to not require unnecessary eaclocal calls. 318 # Override this func to not require unnecessary eaclocal calls.
283 autotools_check_macro() { 319 autotools_check_macro() {
284 local x 320 local x
285 321
338 FROM_EAUTORECONF=sure eautomake 374 FROM_EAUTORECONF=sure eautomake
339 375
340 local x 376 local x
341 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do 377 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
342 if [[ -d ${x} ]] ; then 378 if [[ -d ${x} ]] ; then
343 pushd "${x}" >/dev/null 379 pushd "${x}" >/dev/null || die
344 autotools-utils_autoreconf 380 autotools-utils_autoreconf
345 popd >/dev/null 381 popd >/dev/null || die
346 fi 382 fi
347 done 383 done
348} 384}
349 385
350# @FUNCTION: autotools-utils_src_prepare 386# @FUNCTION: autotools-utils_src_prepare
373 einfo 'Will autoreconfigure due to user patches applied.' 409 einfo 'Will autoreconfigure due to user patches applied.'
374 want_autoreconf=yep 410 want_autoreconf=yep
375 fi 411 fi
376 fi 412 fi
377 413
378 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf 414 [[ ${want_autoreconf} ]] && eautoreconf
379 elibtoolize --patch-only 415 elibtoolize --patch-only
380} 416}
381 417
382# @FUNCTION: autotools-utils_src_configure 418# @FUNCTION: autotools-utils_src_configure
383# @DESCRIPTION: 419# @DESCRIPTION:
415 fi 451 fi
416 452
417 # Append user args 453 # Append user args
418 econfargs+=("${myeconfargs[@]}") 454 econfargs+=("${myeconfargs[@]}")
419 455
420 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 456 mkdir -p "${BUILD_DIR}" || die
421 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 457 pushd "${BUILD_DIR}" > /dev/null || die
422 econf "${econfargs[@]}" "$@" 458 econf "${econfargs[@]}" "$@"
423 popd > /dev/null 459 popd > /dev/null || die
424} 460}
425 461
426# @FUNCTION: autotools-utils_src_compile 462# @FUNCTION: autotools-utils_src_compile
427# @DESCRIPTION: 463# @DESCRIPTION:
428# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 464# The autotools src_compile function, invokes emake in specified BUILD_DIR.
429autotools-utils_src_compile() { 465autotools-utils_src_compile() {
430 debug-print-function ${FUNCNAME} "$@" 466 debug-print-function ${FUNCNAME} "$@"
431 467
432 _check_build_dir 468 _check_build_dir
433 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 469 pushd "${BUILD_DIR}" > /dev/null || die
434 emake "$@" || die 'emake failed' 470 emake "$@" || die 'emake failed'
435 popd > /dev/null 471 popd > /dev/null || die
436} 472}
437 473
438# @FUNCTION: autotools-utils_src_install 474# @FUNCTION: autotools-utils_src_install
439# @DESCRIPTION: 475# @DESCRIPTION:
440# The autotools src_install function. Runs emake install, unconditionally 476# The autotools src_install function. Runs emake install, unconditionally
445# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 481# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
446autotools-utils_src_install() { 482autotools-utils_src_install() {
447 debug-print-function ${FUNCNAME} "$@" 483 debug-print-function ${FUNCNAME} "$@"
448 484
449 _check_build_dir 485 _check_build_dir
450 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 486 pushd "${BUILD_DIR}" > /dev/null || die
451 emake DESTDIR="${D}" "$@" install || die "emake install failed" 487 emake DESTDIR="${D}" "$@" install || die "emake install failed"
452 popd > /dev/null 488 popd > /dev/null || die
453 489
454 # Move docs installed by autotools (in EAPI < 4). 490 # Move docs installed by autotools (in EAPI < 4).
455 if [[ ${EAPI} == [23] ]] \ 491 if [[ ${EAPI} == [23] ]] \
456 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then 492 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
457 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then 493 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
465 rm -r "${T}"/temp-docdir || die 501 rm -r "${T}"/temp-docdir || die
466 fi 502 fi
467 fi 503 fi
468 504
469 # XXX: support installing them from builddir as well? 505 # XXX: support installing them from builddir as well?
506 if declare -p DOCS &>/dev/null; then
507 # an empty list == don't install anything
470 if [[ ${DOCS} ]]; then 508 if [[ ${DOCS[@]} ]]; then
509 if [[ ${EAPI} == [23] ]]; then
471 dodoc "${DOCS[@]}" || die "dodoc failed" 510 dodoc "${DOCS[@]}" || die
511 else
512 # dies by itself
513 dodoc -r "${DOCS[@]}"
514 fi
515 fi
472 else 516 else
473 local f 517 local f
474 # same list as in PMS 518 # same list as in PMS
475 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \ 519 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
476 THANKS BUGS FAQ CREDITS CHANGELOG; do 520 THANKS BUGS FAQ CREDITS CHANGELOG; do
482 if [[ ${HTML_DOCS} ]]; then 526 if [[ ${HTML_DOCS} ]]; then
483 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" 527 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
484 fi 528 fi
485 529
486 # Remove libtool files and unnecessary static libs 530 # Remove libtool files and unnecessary static libs
487 remove_libtool_files 531 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
532 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
488} 533}
489 534
490# @FUNCTION: autotools-utils_src_test 535# @FUNCTION: autotools-utils_src_test
491# @DESCRIPTION: 536# @DESCRIPTION:
492# The autotools src_test function. Runs emake check in build directory. 537# The autotools src_test function. Runs emake check in build directory.
493autotools-utils_src_test() { 538autotools-utils_src_test() {
494 debug-print-function ${FUNCNAME} "$@" 539 debug-print-function ${FUNCNAME} "$@"
495 540
496 _check_build_dir 541 _check_build_dir
497 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 542 pushd "${BUILD_DIR}" > /dev/null || die
498 # Run default src_test as defined in ebuild.sh 543 # Run default src_test as defined in ebuild.sh
499 default_src_test 544 default_src_test
500 popd > /dev/null 545 popd > /dev/null || die
501} 546}

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

  ViewVC Help
Powered by ViewVC 1.1.20