/[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.31 Revision 1.64
1# Copyright 1999-2011 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.31 2011/12/22 18:01:12 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
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_DEPEND:=no}
115
96inherit autotools eutils libtool 116inherit autotools eutils libtool
97 117
98EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 118EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
99 119
100# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 120# @ECLASS-VARIABLE: BUILD_DIR
101# @DEFAULT_UNSET 121# @DEFAULT_UNSET
102# @DESCRIPTION: 122# @DESCRIPTION:
103# Build directory, location where all autotools generated files should be 123# Build directory, location where all autotools generated files should be
104# 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.
105 128
106# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 129# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
107# @DEFAULT_UNSET 130# @DEFAULT_UNSET
108# @DESCRIPTION: 131# @DESCRIPTION:
109# Set to enable in-source build. 132# Set to enable in-source build.
132# @ECLASS-VARIABLE: DOCS 155# @ECLASS-VARIABLE: DOCS
133# @DEFAULT_UNSET 156# @DEFAULT_UNSET
134# @DESCRIPTION: 157# @DESCRIPTION:
135# Array containing documents passed to dodoc command. 158# Array containing documents passed to dodoc command.
136# 159#
160# In EAPIs 4+, can list directories as well.
161#
137# Example: 162# Example:
138# @CODE 163# @CODE
139# DOCS=( NEWS README ) 164# DOCS=( NEWS README )
140# @CODE 165# @CODE
141 166
156# 181#
157# Example: 182# Example:
158# @CODE 183# @CODE
159# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch ) 184# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
160# @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.
161 203
162# Determine using IN or OUT source build 204# Determine using IN or OUT source build
163_check_build_dir() { 205_check_build_dir() {
164 : ${ECONF_SOURCE:=${S}} 206 : ${ECONF_SOURCE:=${S}}
165 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 207 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
166 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 208 BUILD_DIR="${ECONF_SOURCE}"
167 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
168 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 224 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
169 fi 225 fi
226 fi
227
228 # Backwards compatibility for getting the value.
229 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
170 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 230 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
171} 231}
172 232
173# @FUNCTION: remove_libtool_files 233# @FUNCTION: remove_libtool_files
174# @USAGE: [all] 234# @USAGE: [all]
175# @DESCRIPTION: 235# @DESCRIPTION:
182# 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.
183# See autotools-utils_src_install for reference. 243# See autotools-utils_src_install for reference.
184remove_libtool_files() { 244remove_libtool_files() {
185 debug-print-function ${FUNCNAME} "$@" 245 debug-print-function ${FUNCNAME} "$@"
186 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
187 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 251 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
188 if [[ ${#} -eq 1 ]]; then 252 if [[ ${#} -eq 1 ]]; then
189 case "${1}" in 253 case "${1}" in
190 all) 254 all)
191 removing_all=1 255 removing_all=1
237 if [[ ${removing} ]]; then 301 if [[ ${removing} ]]; then
238 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 302 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
239 rm -f "${f}" || die 303 rm -f "${f}" || die
240 fi 304 fi
241 done 305 done
306}
242 307
243 # check for invalid eclass use 308# @FUNCTION: autotools-utils_autoreconf
244 # this is the most commonly used function, so do it here 309# @DESCRIPTION:
245 _check_build_dir 310# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
246 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then 311autotools-utils_autoreconf() {
247 eqawarn "autotools-utils used but autotools-utils_src_configure was never called." 312 debug-print-function ${FUNCNAME} "$@"
248 eqawarn "This is not supported and never was. Please report a bug against" 313
249 eqawarn "the offending ebuild. This will become a fatal error in a near future." 314 eqawarn "The autotools-utils_autoreconf() function was deprecated."
315 eqawarn "Please call autotools-utils_src_prepare()"
316 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
317
318 # Override this func to not require unnecessary eaclocal calls.
319 autotools_check_macro() {
320 local x
321
322 # Add a few additional variants as we don't get expansions.
323 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
324 AC_CONFIG_HEADER AM_CONFIG_HEADER
325
326 for x; do
327 grep -h "^${x}" configure.{ac,in} 2>/dev/null
328 done
329 }
330
331 einfo "Autoreconfiguring '${PWD}' ..."
332
333 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
334 configure.{ac,in} 2>/dev/null)
335 if [[ ${auxdir} ]]; then
336 auxdir=${auxdir%%]}
337 mkdir -p ${auxdir##[}
338 fi
339
340 # Support running additional tools like gnome-autogen.sh.
341 # Note: you need to add additional depends to the ebuild.
342
343 # gettext
344 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
345 echo 'no' | autotools_run_tool glib-gettextize --copy --force
346 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
347 eautopoint --force
348 fi
349
350 # intltool
351 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
352 then
353 autotools_run_tool intltoolize --copy --automake --force
354 fi
355
356 # gtk-doc
357 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
358 autotools_run_tool gtkdocize --copy
359 fi
360
361 # gnome-doc
362 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
363 autotools_run_tool gnome-doc-prepare --copy --force
364 fi
365
366 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
367 then
368 _elibtoolize --copy --force --install
369 fi
370
371 eaclocal
372 eautoconf
373 eautoheader
374 FROM_EAUTORECONF=sure eautomake
375
376 local x
377 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
378 if [[ -d ${x} ]] ; then
379 pushd "${x}" >/dev/null || die
380 autotools-utils_autoreconf
381 popd >/dev/null || die
250 fi 382 fi
383 done
251} 384}
252 385
253# @FUNCTION: autotools-utils_src_prepare 386# @FUNCTION: autotools-utils_src_prepare
254# @DESCRIPTION: 387# @DESCRIPTION:
255# The src_prepare function. 388# The src_prepare function.
256# 389#
257# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 390# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
258#
259# This function calls elibtoolize implicitly. If you need to call eautoreconf
260# afterwards, please use AT_NOELIBTOOLIZE=yes to avoid it being called twice.
261autotools-utils_src_prepare() { 391autotools-utils_src_prepare() {
262 debug-print-function ${FUNCNAME} "$@" 392 debug-print-function ${FUNCNAME} "$@"
263 393
394 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
395
264 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}" 396 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
397
398 at_checksum() {
399 find '(' -name 'Makefile.am' \
400 -o -name 'configure.ac' \
401 -o -name 'configure.in' ')' \
402 -exec cksum {} + | sort -k2
403 }
404
405 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
265 epatch_user 406 epatch_user
407 if [[ ! ${want_autoreconf} ]]; then
408 if [[ ${checksum} != $(at_checksum) ]]; then
409 einfo 'Will autoreconfigure due to user patches applied.'
410 want_autoreconf=yep
411 fi
412 fi
266 413
414 [[ ${want_autoreconf} ]] && eautoreconf
267 elibtoolize --patch-only 415 elibtoolize --patch-only
268} 416}
269 417
270# @FUNCTION: autotools-utils_src_configure 418# @FUNCTION: autotools-utils_src_configure
271# @DESCRIPTION: 419# @DESCRIPTION:
280 debug-print-function ${FUNCNAME} "$@" 428 debug-print-function ${FUNCNAME} "$@"
281 429
282 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 430 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
283 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 431 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
284 432
433 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
434
285 # Common args 435 # Common args
286 local econfargs=() 436 local econfargs=()
437
438 _check_build_dir
439 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
440 econfargs+=(
441 --docdir="${EPREFIX}"/usr/share/doc/${PF}
442 )
443 fi
287 444
288 # Handle static-libs found in IUSE, disable them by default 445 # Handle static-libs found in IUSE, disable them by default
289 if in_iuse static-libs; then 446 if in_iuse static-libs; then
290 econfargs+=( 447 econfargs+=(
291 --enable-shared 448 --enable-shared
294 fi 451 fi
295 452
296 # Append user args 453 # Append user args
297 econfargs+=("${myeconfargs[@]}") 454 econfargs+=("${myeconfargs[@]}")
298 455
456 mkdir -p "${BUILD_DIR}" || die
457 pushd "${BUILD_DIR}" > /dev/null || die
458 econf "${econfargs[@]}" "$@"
459 popd > /dev/null || die
460}
461
462# @FUNCTION: autotools-utils_src_compile
463# @DESCRIPTION:
464# The autotools src_compile function, invokes emake in specified BUILD_DIR.
465autotools-utils_src_compile() {
466 debug-print-function ${FUNCNAME} "$@"
467
299 _check_build_dir 468 _check_build_dir
300 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
301 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 469 pushd "${BUILD_DIR}" > /dev/null || die
302 econf "${econfargs[@]}" "$@"
303 popd > /dev/null
304}
305
306# @FUNCTION: autotools-utils_src_compile
307# @DESCRIPTION:
308# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
309autotools-utils_src_compile() {
310 debug-print-function ${FUNCNAME} "$@"
311
312 _check_build_dir
313 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
314 emake "$@" || die 'emake failed' 470 emake "$@" || die 'emake failed'
315 popd > /dev/null 471 popd > /dev/null || die
316} 472}
317 473
318# @FUNCTION: autotools-utils_src_install 474# @FUNCTION: autotools-utils_src_install
319# @DESCRIPTION: 475# @DESCRIPTION:
320# The autotools src_install function. Runs emake install, unconditionally 476# The autotools src_install function. Runs emake install, unconditionally
325# 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.
326autotools-utils_src_install() { 482autotools-utils_src_install() {
327 debug-print-function ${FUNCNAME} "$@" 483 debug-print-function ${FUNCNAME} "$@"
328 484
329 _check_build_dir 485 _check_build_dir
330 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 486 pushd "${BUILD_DIR}" > /dev/null || die
331 emake DESTDIR="${D}" "$@" install || die "emake install failed" 487 emake DESTDIR="${D}" "$@" install || die "emake install failed"
332 popd > /dev/null 488 popd > /dev/null || die
489
490 # Move docs installed by autotools (in EAPI < 4).
491 if [[ ${EAPI} == [23] ]] \
492 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
493 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
494 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
495 else
496 mkdir "${T}"/temp-docdir
497 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
498 || die "moving docs to tempdir failed"
499
500 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
501 rm -r "${T}"/temp-docdir || die
502 fi
503 fi
333 504
334 # 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
335 if [[ ${DOCS} ]]; then 508 if [[ ${DOCS[@]} ]]; then
509 if [[ ${EAPI} == [23] ]]; then
336 dodoc "${DOCS[@]}" || die "dodoc failed" 510 dodoc "${DOCS[@]}" || die
511 else
512 # dies by itself
513 dodoc -r "${DOCS[@]}"
514 fi
515 fi
516 else
517 local f
518 # same list as in PMS
519 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
520 THANKS BUGS FAQ CREDITS CHANGELOG; do
521 if [[ -s ${f} ]]; then
522 dodoc "${f}" || die "(default) dodoc ${f} failed"
523 fi
524 done
337 fi 525 fi
338 if [[ ${HTML_DOCS} ]]; then 526 if [[ ${HTML_DOCS} ]]; then
339 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" 527 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
340 fi 528 fi
341 529
342 # Remove libtool files and unnecessary static libs 530 # Remove libtool files and unnecessary static libs
343 remove_libtool_files 531 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
532 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
344} 533}
345 534
346# @FUNCTION: autotools-utils_src_test 535# @FUNCTION: autotools-utils_src_test
347# @DESCRIPTION: 536# @DESCRIPTION:
348# The autotools src_test function. Runs emake check in build directory. 537# The autotools src_test function. Runs emake check in build directory.
349autotools-utils_src_test() { 538autotools-utils_src_test() {
350 debug-print-function ${FUNCNAME} "$@" 539 debug-print-function ${FUNCNAME} "$@"
351 540
352 _check_build_dir 541 _check_build_dir
353 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 542 pushd "${BUILD_DIR}" > /dev/null || die
354 # Run default src_test as defined in ebuild.sh 543 # Run default src_test as defined in ebuild.sh
355 default_src_test 544 default_src_test
356 popd > /dev/null 545 popd > /dev/null || die
357} 546}

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

  ViewVC Help
Powered by ViewVC 1.1.20