/[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.42 Revision 1.60
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.42 2012/01/15 16:40:12 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.60 2012/12/03 12:05:51 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 # Respect both the old variable and the new one, depending
192 # on which one was set by the ebuild.
193 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
194 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
195 eqawarn "Please migrate the ebuild to use the new one."
196
197 # In the next call, both variables will be set already
198 # and we'd have to know which one takes precedence.
199 _RESPECT_AUTOTOOLS_BUILD_DIR=1
200 fi
201
202 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
203 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
204 else
191 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 205 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
192 fi 206 fi
207 fi
208
209 # Backwards compatibility for getting the value.
210 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
193 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 211 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
194} 212}
195 213
196# @FUNCTION: remove_libtool_files 214# @FUNCTION: remove_libtool_files
197# @USAGE: [all] 215# @USAGE: [all]
198# @DESCRIPTION: 216# @DESCRIPTION:
205# In most cases it's not necessary to manually invoke this function. 223# In most cases it's not necessary to manually invoke this function.
206# See autotools-utils_src_install for reference. 224# See autotools-utils_src_install for reference.
207remove_libtool_files() { 225remove_libtool_files() {
208 debug-print-function ${FUNCNAME} "$@" 226 debug-print-function ${FUNCNAME} "$@"
209 local removing_all 227 local removing_all
228
229 eqawarn "The remove_libtool_files() function was deprecated."
230 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
231
210 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 232 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
211 if [[ ${#} -eq 1 ]]; then 233 if [[ ${#} -eq 1 ]]; then
212 case "${1}" in 234 case "${1}" in
213 all) 235 all)
214 removing_all=1 236 removing_all=1
260 if [[ ${removing} ]]; then 282 if [[ ${removing} ]]; then
261 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 283 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
262 rm -f "${f}" || die 284 rm -f "${f}" || die
263 fi 285 fi
264 done 286 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} 287}
275 288
276# @FUNCTION: autotools-utils_autoreconf 289# @FUNCTION: autotools-utils_autoreconf
277# @DESCRIPTION: 290# @DESCRIPTION:
278# Reconfigure the sources (like gnome-autogen.sh or eautoreconf). 291# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
279autotools-utils_autoreconf() { 292autotools-utils_autoreconf() {
280 debug-print-function ${FUNCNAME} "$@" 293 debug-print-function ${FUNCNAME} "$@"
294
295 eqawarn "The autotools-utils_autoreconf() function was deprecated."
296 eqawarn "Please call autotools-utils_src_prepare()"
297 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
281 298
282 # Override this func to not require unnecessary eaclocal calls. 299 # Override this func to not require unnecessary eaclocal calls.
283 autotools_check_macro() { 300 autotools_check_macro() {
284 local x 301 local x
285 302
286 # Add a few additional variants as we don't get expansions. 303 # Add a few additional variants as we don't get expansions.
287 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" AC_CONFIG_HEADER 304 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
305 AC_CONFIG_HEADER AM_CONFIG_HEADER
288 306
289 for x; do 307 for x; do
290 grep -h "^${x}" configure.{ac,in} 2>/dev/null 308 grep -h "^${x}" configure.{ac,in} 2>/dev/null
291 done 309 done
292 } 310 }
303 # Support running additional tools like gnome-autogen.sh. 321 # Support running additional tools like gnome-autogen.sh.
304 # Note: you need to add additional depends to the ebuild. 322 # Note: you need to add additional depends to the ebuild.
305 323
306 # gettext 324 # gettext
307 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then 325 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
308 echo 'no' | autotools_run_tool glib-gettextize --copy 326 echo 'no' | autotools_run_tool glib-gettextize --copy --force
309 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then 327 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
310 eautopoint --force 328 eautopoint --force
311 fi 329 fi
312 330
313 # intltool 331 # intltool
324 # gnome-doc 342 # gnome-doc
325 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then 343 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
326 autotools_run_tool gnome-doc-prepare --copy --force 344 autotools_run_tool gnome-doc-prepare --copy --force
327 fi 345 fi
328 346
329 # We need to perform the check twice to know whether to run eaclocal.
330 # (_elibtoolize does that itself)
331 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]] 347 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
332 then 348 then
333 _elibtoolize --copy --force --install 349 _elibtoolize --copy --force --install
334 else 350 fi
351
335 eaclocal 352 eaclocal
336 fi
337
338 eautoconf 353 eautoconf
339 eautoheader 354 eautoheader
340 FROM_EAUTORECONF=sure eautomake 355 FROM_EAUTORECONF=sure eautomake
341 356
342 local x 357 local x
343 for x in $(autotools_get_subdirs); do 358 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
344 if [[ -d ${x} ]] ; then 359 if [[ -d ${x} ]] ; then
345 pushd "${x}" >/dev/null 360 pushd "${x}" >/dev/null || die
346 autotools-utils_eautoreconf 361 autotools-utils_autoreconf
347 popd >/dev/null 362 popd >/dev/null || die
348 fi 363 fi
349 done 364 done
350} 365}
351 366
352# @FUNCTION: autotools-utils_src_prepare 367# @FUNCTION: autotools-utils_src_prepare
357autotools-utils_src_prepare() { 372autotools-utils_src_prepare() {
358 debug-print-function ${FUNCNAME} "$@" 373 debug-print-function ${FUNCNAME} "$@"
359 374
360 local want_autoreconf=${AUTOTOOLS_AUTORECONF} 375 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
361 376
362 touch "${T}"/.autotools-utils.timestamp || die
363 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}" 377 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
378
379 at_checksum() {
380 find '(' -name 'Makefile.am' \
381 -o -name 'configure.ac' \
382 -o -name 'configure.in' ')' \
383 -exec cksum {} + | sort -k2
384 }
385
386 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
364 epatch_user 387 epatch_user
365 if [[ ! ${want_autoreconf} ]]; then 388 if [[ ! ${want_autoreconf} ]]; then
366 if [[ $(find . -newer "${T}"/.autotools-utils.timestamp \ 389 if [[ ${checksum} != $(at_checksum) ]]; then
367 -a '(' -name 'Makefile.am' \
368 -o -name 'configure.ac' \
369 -o -name 'configure.in' ')' \
370 -print -quit) ]]; then
371 einfo 'Will autoreconfigure due to patches applied.' 390 einfo 'Will autoreconfigure due to user patches applied.'
372 want_autoreconf=yep 391 want_autoreconf=yep
373 fi 392 fi
374 fi 393 fi
375 394
376 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf 395 [[ ${want_autoreconf} ]] && eautoreconf
377 elibtoolize --patch-only 396 elibtoolize --patch-only
378} 397}
379 398
380# @FUNCTION: autotools-utils_src_configure 399# @FUNCTION: autotools-utils_src_configure
381# @DESCRIPTION: 400# @DESCRIPTION:
396 415
397 # Common args 416 # Common args
398 local econfargs=() 417 local econfargs=()
399 418
400 _check_build_dir 419 _check_build_dir
401 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep '^ *--docdir='; then 420 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
402 econfargs+=( 421 econfargs+=(
403 --docdir="${EPREFIX}"/usr/share/doc/${PF} 422 --docdir="${EPREFIX}"/usr/share/doc/${PF}
404 ) 423 )
405 fi 424 fi
406 425
413 fi 432 fi
414 433
415 # Append user args 434 # Append user args
416 econfargs+=("${myeconfargs[@]}") 435 econfargs+=("${myeconfargs[@]}")
417 436
418 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 437 mkdir -p "${BUILD_DIR}" || die
419 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 438 pushd "${BUILD_DIR}" > /dev/null || die
420 econf "${econfargs[@]}" "$@" 439 econf "${econfargs[@]}" "$@"
421 popd > /dev/null 440 popd > /dev/null || die
422} 441}
423 442
424# @FUNCTION: autotools-utils_src_compile 443# @FUNCTION: autotools-utils_src_compile
425# @DESCRIPTION: 444# @DESCRIPTION:
426# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 445# The autotools src_compile function, invokes emake in specified BUILD_DIR.
427autotools-utils_src_compile() { 446autotools-utils_src_compile() {
428 debug-print-function ${FUNCNAME} "$@" 447 debug-print-function ${FUNCNAME} "$@"
429 448
430 _check_build_dir 449 _check_build_dir
431 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 450 pushd "${BUILD_DIR}" > /dev/null || die
432 emake "$@" || die 'emake failed' 451 emake "$@" || die 'emake failed'
433 popd > /dev/null 452 popd > /dev/null || die
434} 453}
435 454
436# @FUNCTION: autotools-utils_src_install 455# @FUNCTION: autotools-utils_src_install
437# @DESCRIPTION: 456# @DESCRIPTION:
438# The autotools src_install function. Runs emake install, unconditionally 457# The autotools src_install function. Runs emake install, unconditionally
443# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 462# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
444autotools-utils_src_install() { 463autotools-utils_src_install() {
445 debug-print-function ${FUNCNAME} "$@" 464 debug-print-function ${FUNCNAME} "$@"
446 465
447 _check_build_dir 466 _check_build_dir
448 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 467 pushd "${BUILD_DIR}" > /dev/null || die
449 emake DESTDIR="${D}" "$@" install || die "emake install failed" 468 emake DESTDIR="${D}" "$@" install || die "emake install failed"
450 popd > /dev/null 469 popd > /dev/null || die
451 470
452 # Move docs installed by autotools (in EAPI < 4). 471 # Move docs installed by autotools (in EAPI < 4).
453 if [[ ${EAPI} == [23] ]] \ 472 if [[ ${EAPI} == [23] ]] \
454 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then 473 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
455 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then 474 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
480 if [[ ${HTML_DOCS} ]]; then 499 if [[ ${HTML_DOCS} ]]; then
481 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" 500 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
482 fi 501 fi
483 502
484 # Remove libtool files and unnecessary static libs 503 # Remove libtool files and unnecessary static libs
485 remove_libtool_files 504 prune_libtool_files
486} 505}
487 506
488# @FUNCTION: autotools-utils_src_test 507# @FUNCTION: autotools-utils_src_test
489# @DESCRIPTION: 508# @DESCRIPTION:
490# The autotools src_test function. Runs emake check in build directory. 509# The autotools src_test function. Runs emake check in build directory.
491autotools-utils_src_test() { 510autotools-utils_src_test() {
492 debug-print-function ${FUNCNAME} "$@" 511 debug-print-function ${FUNCNAME} "$@"
493 512
494 _check_build_dir 513 _check_build_dir
495 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 514 pushd "${BUILD_DIR}" > /dev/null || die
496 # Run default src_test as defined in ebuild.sh 515 # Run default src_test as defined in ebuild.sh
497 default_src_test 516 default_src_test
498 popd > /dev/null 517 popd > /dev/null || die
499} 518}

Legend:
Removed from v.1.42  
changed lines
  Added in v.1.60

  ViewVC Help
Powered by ViewVC 1.1.20