/[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.48 Revision 1.70
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.48 2012/02/04 09:26:16 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.70 2013/06/29 08:17:06 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.
134# @ECLASS-VARIABLE: ECONF_SOURCE 134# @ECLASS-VARIABLE: ECONF_SOURCE
135# @DEFAULT_UNSET 135# @DEFAULT_UNSET
136# @DESCRIPTION: 136# @DESCRIPTION:
137# Specify location of autotools' configure script. By default it uses ${S}. 137# Specify location of autotools' configure script. By default it uses ${S}.
138 138
139# @ECLASS-VARIABLE: myeconfargs
140# @DEFAULT_UNSET
141# @DESCRIPTION:
142# Optional econf arguments as Bash array. Should be defined before calling src_configure.
143# @CODE
144# src_configure() {
145# local myeconfargs=(
146# --disable-readline
147# --with-confdir="/etc/nasty foo confdir/"
148# $(use_enable debug cnddebug)
149# $(use_enable threads multithreading)
150# )
151# autotools-utils_src_configure
152# }
153# @CODE
154
155# @ECLASS-VARIABLE: DOCS 139# @ECLASS-VARIABLE: DOCS
156# @DEFAULT_UNSET 140# @DEFAULT_UNSET
157# @DESCRIPTION: 141# @DESCRIPTION:
158# Array containing documents passed to dodoc command. 142# Array containing documents passed to dodoc command.
159# 143#
144# In EAPIs 4+, can list directories as well.
145#
160# Example: 146# Example:
161# @CODE 147# @CODE
162# DOCS=( NEWS README ) 148# DOCS=( NEWS README )
163# @CODE 149# @CODE
164 150
179# 165#
180# Example: 166# Example:
181# @CODE 167# @CODE
182# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch ) 168# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
183# @CODE 169# @CODE
170
171# @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
172# @DEFAULT_UNSET
173# @DESCRIPTION:
174# Sets the mode of pruning libtool files. The values correspond to
175# prune_libtool_files parameters, with leading dashes stripped.
176#
177# Defaults to pruning the libtool files when static libraries are not
178# installed or can be linked properly without them. Libtool files
179# for modules (plugins) will be kept in case plugin loader needs them.
180#
181# If set to 'modules', the .la files for modules will be removed
182# as well. This is often the preferred option.
183#
184# If set to 'all', all .la files will be removed unconditionally. This
185# option is discouraged and shall be used only if 'modules' does not
186# remove the files.
187#
188# If set to 'none', no .la files will be pruned ever. Use in corner
189# cases only.
184 190
185# Determine using IN or OUT source build 191# Determine using IN or OUT source build
186_check_build_dir() { 192_check_build_dir() {
187 : ${ECONF_SOURCE:=${S}} 193 : ${ECONF_SOURCE:=${S}}
188 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 194 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
189 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 195 BUILD_DIR="${ECONF_SOURCE}"
190 else 196 else
197 # Respect both the old variable and the new one, depending
198 # on which one was set by the ebuild.
199 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
200 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
201 eqawarn "Please migrate the ebuild to use the new one."
202
203 # In the next call, both variables will be set already
204 # and we'd have to know which one takes precedence.
205 _RESPECT_AUTOTOOLS_BUILD_DIR=1
206 fi
207
208 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
209 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
210 else
191 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 211 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
192 fi 212 fi
213 fi
214
215 # Backwards compatibility for getting the value.
216 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
193 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 217 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
194} 218}
195 219
196# @FUNCTION: remove_libtool_files 220# @FUNCTION: remove_libtool_files
197# @USAGE: [all] 221# @USAGE: [all]
198# @DESCRIPTION: 222# @DESCRIPTION:
205# In most cases it's not necessary to manually invoke this function. 229# In most cases it's not necessary to manually invoke this function.
206# See autotools-utils_src_install for reference. 230# See autotools-utils_src_install for reference.
207remove_libtool_files() { 231remove_libtool_files() {
208 debug-print-function ${FUNCNAME} "$@" 232 debug-print-function ${FUNCNAME} "$@"
209 local removing_all 233 local removing_all
234
235 eqawarn "The remove_libtool_files() function was deprecated."
236 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
237
210 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 238 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
211 if [[ ${#} -eq 1 ]]; then 239 if [[ ${#} -eq 1 ]]; then
212 case "${1}" in 240 case "${1}" in
213 all) 241 all)
214 removing_all=1 242 removing_all=1
260 if [[ ${removing} ]]; then 288 if [[ ${removing} ]]; then
261 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 289 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
262 rm -f "${f}" || die 290 rm -f "${f}" || die
263 fi 291 fi
264 done 292 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} 293}
275 294
276# @FUNCTION: autotools-utils_autoreconf 295# @FUNCTION: autotools-utils_autoreconf
277# @DESCRIPTION: 296# @DESCRIPTION:
278# Reconfigure the sources (like gnome-autogen.sh or eautoreconf). 297# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
279autotools-utils_autoreconf() { 298autotools-utils_autoreconf() {
280 debug-print-function ${FUNCNAME} "$@" 299 debug-print-function ${FUNCNAME} "$@"
300
301 eqawarn "The autotools-utils_autoreconf() function was deprecated."
302 eqawarn "Please call autotools-utils_src_prepare()"
303 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
281 304
282 # Override this func to not require unnecessary eaclocal calls. 305 # Override this func to not require unnecessary eaclocal calls.
283 autotools_check_macro() { 306 autotools_check_macro() {
284 local x 307 local x
285 308
325 # gnome-doc 348 # gnome-doc
326 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then 349 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
327 autotools_run_tool gnome-doc-prepare --copy --force 350 autotools_run_tool gnome-doc-prepare --copy --force
328 fi 351 fi
329 352
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) ]] 353 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
333 then 354 then
334 _elibtoolize --copy --force --install 355 _elibtoolize --copy --force --install
335 else 356 fi
357
336 eaclocal 358 eaclocal
337 fi
338
339 eautoconf 359 eautoconf
340 eautoheader 360 eautoheader
341 FROM_EAUTORECONF=sure eautomake 361 FROM_EAUTORECONF=sure eautomake
342 362
343 local x 363 local x
344 for x in $(autotools_get_subdirs); do 364 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
345 if [[ -d ${x} ]] ; then 365 if [[ -d ${x} ]] ; then
346 pushd "${x}" >/dev/null 366 pushd "${x}" >/dev/null || die
347 autotools-utils_autoreconf 367 autotools-utils_autoreconf
348 popd >/dev/null 368 popd >/dev/null || die
349 fi 369 fi
350 done 370 done
351} 371}
352 372
353# @FUNCTION: autotools-utils_src_prepare 373# @FUNCTION: autotools-utils_src_prepare
376 einfo 'Will autoreconfigure due to user patches applied.' 396 einfo 'Will autoreconfigure due to user patches applied.'
377 want_autoreconf=yep 397 want_autoreconf=yep
378 fi 398 fi
379 fi 399 fi
380 400
381 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf 401 [[ ${want_autoreconf} ]] && eautoreconf
382 elibtoolize --patch-only 402 elibtoolize --patch-only
383} 403}
384 404
385# @FUNCTION: autotools-utils_src_configure 405# @FUNCTION: autotools-utils_src_configure
386# @DESCRIPTION: 406# @DESCRIPTION:
389# in myeconfargs are passed here to econf. Additionally following USE 409# in myeconfargs are passed here to econf. Additionally following USE
390# flags are known: 410# flags are known:
391# 411#
392# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static 412# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
393# to econf respectively. 413# to econf respectively.
414
415# @VARIABLE: myeconfargs
416# @DEFAULT_UNSET
417# @DESCRIPTION:
418# Optional econf arguments as Bash array. Should be defined before calling src_configure.
419# @CODE
420# src_configure() {
421# local myeconfargs=(
422# --disable-readline
423# --with-confdir="/etc/nasty foo confdir/"
424# $(use_enable debug cnddebug)
425# $(use_enable threads multithreading)
426# )
427# autotools-utils_src_configure
428# }
429# @CODE
394autotools-utils_src_configure() { 430autotools-utils_src_configure() {
395 debug-print-function ${FUNCNAME} "$@" 431 debug-print-function ${FUNCNAME} "$@"
396 432
397 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 433 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
398 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 434 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
418 fi 454 fi
419 455
420 # Append user args 456 # Append user args
421 econfargs+=("${myeconfargs[@]}") 457 econfargs+=("${myeconfargs[@]}")
422 458
423 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 459 mkdir -p "${BUILD_DIR}" || die
424 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 460 pushd "${BUILD_DIR}" > /dev/null || die
425 econf "${econfargs[@]}" "$@" 461 econf "${econfargs[@]}" "$@"
426 popd > /dev/null 462 popd > /dev/null || die
427} 463}
428 464
429# @FUNCTION: autotools-utils_src_compile 465# @FUNCTION: autotools-utils_src_compile
430# @DESCRIPTION: 466# @DESCRIPTION:
431# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 467# The autotools src_compile function, invokes emake in specified BUILD_DIR.
432autotools-utils_src_compile() { 468autotools-utils_src_compile() {
433 debug-print-function ${FUNCNAME} "$@" 469 debug-print-function ${FUNCNAME} "$@"
434 470
435 _check_build_dir 471 _check_build_dir
436 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 472 pushd "${BUILD_DIR}" > /dev/null || die
437 emake "$@" || die 'emake failed' 473 emake "$@" || die 'emake failed'
438 popd > /dev/null 474 popd > /dev/null || die
439} 475}
440 476
441# @FUNCTION: autotools-utils_src_install 477# @FUNCTION: autotools-utils_src_install
442# @DESCRIPTION: 478# @DESCRIPTION:
443# The autotools src_install function. Runs emake install, unconditionally 479# The autotools src_install function. Runs emake install, unconditionally
448# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 484# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
449autotools-utils_src_install() { 485autotools-utils_src_install() {
450 debug-print-function ${FUNCNAME} "$@" 486 debug-print-function ${FUNCNAME} "$@"
451 487
452 _check_build_dir 488 _check_build_dir
453 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 489 pushd "${BUILD_DIR}" > /dev/null || die
454 emake DESTDIR="${D}" "$@" install || die "emake install failed" 490 emake DESTDIR="${D}" "$@" install || die "emake install failed"
455 popd > /dev/null 491 popd > /dev/null || die
456 492
457 # Move docs installed by autotools (in EAPI < 4). 493 # Move docs installed by autotools (in EAPI < 4).
458 if [[ ${EAPI} == [23] ]] \ 494 if [[ ${EAPI} == [23] ]] \
459 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then 495 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
460 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then 496 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
468 rm -r "${T}"/temp-docdir || die 504 rm -r "${T}"/temp-docdir || die
469 fi 505 fi
470 fi 506 fi
471 507
472 # XXX: support installing them from builddir as well? 508 # XXX: support installing them from builddir as well?
509 if declare -p DOCS &>/dev/null; then
510 # an empty list == don't install anything
473 if [[ ${DOCS} ]]; then 511 if [[ ${DOCS[@]} ]]; then
512 if [[ ${EAPI} == [23] ]]; then
474 dodoc "${DOCS[@]}" || die "dodoc failed" 513 dodoc "${DOCS[@]}" || die
514 else
515 # dies by itself
516 dodoc -r "${DOCS[@]}"
517 fi
518 fi
475 else 519 else
476 local f 520 local f
477 # same list as in PMS 521 # same list as in PMS
478 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \ 522 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
479 THANKS BUGS FAQ CREDITS CHANGELOG; do 523 THANKS BUGS FAQ CREDITS CHANGELOG; do
485 if [[ ${HTML_DOCS} ]]; then 529 if [[ ${HTML_DOCS} ]]; then
486 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" 530 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
487 fi 531 fi
488 532
489 # Remove libtool files and unnecessary static libs 533 # Remove libtool files and unnecessary static libs
490 remove_libtool_files 534 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
535 if [[ ${prune_ltfiles} != none ]]; then
536 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
537 fi
491} 538}
492 539
493# @FUNCTION: autotools-utils_src_test 540# @FUNCTION: autotools-utils_src_test
494# @DESCRIPTION: 541# @DESCRIPTION:
495# The autotools src_test function. Runs emake check in build directory. 542# The autotools src_test function. Runs emake check in build directory.
496autotools-utils_src_test() { 543autotools-utils_src_test() {
497 debug-print-function ${FUNCNAME} "$@" 544 debug-print-function ${FUNCNAME} "$@"
498 545
499 _check_build_dir 546 _check_build_dir
500 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 547 pushd "${BUILD_DIR}" > /dev/null || die
501 # Run default src_test as defined in ebuild.sh 548
502 default_src_test 549 if make -n check "${@}" &>/dev/null; then
550 emake check "${@}" || die 'emake check failed.'
551 elif make -n test "${@}" &>/dev/null; then
552 emake test "${@}" || die 'emake test failed.'
553 fi
554
503 popd > /dev/null 555 popd > /dev/null || die
504} 556}

Legend:
Removed from v.1.48  
changed lines
  Added in v.1.70

  ViewVC Help
Powered by ViewVC 1.1.20