/[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.23 Revision 1.64
1# Copyright 1999-2010 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.23 2011/09/18 21:03:59 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>
9# @BLURB: common ebuild functions for autotools-based packages 9# @BLURB: common ebuild functions for autotools-based packages
10# @DESCRIPTION: 10# @DESCRIPTION:
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, enable/disable debug handling. 14# handling, libtool files removal.
15#
16# Please note that autotools-utils does not support mixing of its phase
17# functions with regular econf/emake calls. If necessary, please call
18# autotools-utils_src_compile instead of the latter.
15# 19#
16# @EXAMPLE: 20# @EXAMPLE:
17# Typical ebuild using autotools-utils.eclass: 21# Typical ebuild using autotools-utils.eclass:
18# 22#
19# @CODE 23# @CODE
31# IUSE="debug doc examples qt4 static-libs tiff" 35# IUSE="debug doc examples qt4 static-libs tiff"
32# 36#
33# CDEPEND=" 37# CDEPEND="
34# media-libs/libpng:0 38# media-libs/libpng:0
35# qt4? ( 39# qt4? (
36# x11-libs/qt-core:4 40# dev-qt/qtcore:4
37# x11-libs/qt-gui:4 41# dev-qt/qtgui:4
38# ) 42# )
39# tiff? ( media-libs/tiff:0 ) 43# tiff? ( media-libs/tiff:0 )
40# " 44# "
41# RDEPEND="${CDEPEND} 45# RDEPEND="${CDEPEND}
42# !media-gfx/bar 46# !media-gfx/bar
70# autotools-utils_src_compile 74# autotools-utils_src_compile
71# use doc && autotools-utils_src_compile docs 75# use doc && autotools-utils_src_compile docs
72# } 76# }
73# 77#
74# src_install() { 78# src_install() {
75# use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/") 79# use doc && HTML_DOCS=("${BUILD_DIR}/apidocs/html/")
76# autotools-utils_src_install 80# autotools-utils_src_install
77# if use examples; then 81# if use examples; then
78# dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\ 82# dobin "${BUILD_DIR}"/foo_example{1,2,3} \\
79# || die 'dobin examples failed' 83# || die 'dobin examples failed'
80# fi 84# fi
81# } 85# }
82# 86#
83# @CODE 87# @CODE
84 88
85# 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!
86 90
87case ${EAPI:-0} in 91case ${EAPI:-0} in
88 2|3|4) ;; 92 2|3|4|5) ;;
89 *) die "EAPI=${EAPI} is not supported" ;; 93 *) die "EAPI=${EAPI} is not supported" ;;
90esac 94esac
91 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
92inherit autotools base eutils 116inherit autotools eutils libtool
93 117
94EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 118EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
95 119
96# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 120# @ECLASS-VARIABLE: BUILD_DIR
121# @DEFAULT_UNSET
97# @DESCRIPTION: 122# @DESCRIPTION:
98# Build directory, location where all autotools generated files should be 123# Build directory, location where all autotools generated files should be
99# 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.
100 128
101# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 129# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130# @DEFAULT_UNSET
102# @DESCRIPTION: 131# @DESCRIPTION:
103# Set to enable in-source build. 132# Set to enable in-source build.
104 133
105# @ECLASS-VARIABLE: ECONF_SOURCE 134# @ECLASS-VARIABLE: ECONF_SOURCE
135# @DEFAULT_UNSET
106# @DESCRIPTION: 136# @DESCRIPTION:
107# Specify location of autotools' configure script. By default it uses ${S}. 137# Specify location of autotools' configure script. By default it uses ${S}.
108 138
109# @ECLASS-VARIABLE: myeconfargs 139# @ECLASS-VARIABLE: myeconfargs
140# @DEFAULT_UNSET
110# @DESCRIPTION: 141# @DESCRIPTION:
111# Optional econf arguments as Bash array. Should be defined before calling src_configure. 142# Optional econf arguments as Bash array. Should be defined before calling src_configure.
112# @CODE 143# @CODE
113# src_configure() { 144# src_configure() {
114# local myeconfargs=( 145# local myeconfargs=(
119# ) 150# )
120# autotools-utils_src_configure 151# autotools-utils_src_configure
121# } 152# }
122# @CODE 153# @CODE
123 154
155# @ECLASS-VARIABLE: DOCS
156# @DEFAULT_UNSET
157# @DESCRIPTION:
158# Array containing documents passed to dodoc command.
159#
160# In EAPIs 4+, can list directories as well.
161#
162# Example:
163# @CODE
164# DOCS=( NEWS README )
165# @CODE
166
167# @ECLASS-VARIABLE: HTML_DOCS
168# @DEFAULT_UNSET
169# @DESCRIPTION:
170# Array containing documents passed to dohtml command.
171#
172# Example:
173# @CODE
174# HTML_DOCS=( doc/html/ )
175# @CODE
176
177# @ECLASS-VARIABLE: PATCHES
178# @DEFAULT_UNSET
179# @DESCRIPTION:
180# PATCHES array variable containing all various patches to be applied.
181#
182# Example:
183# @CODE
184# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
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.
203
124# Determine using IN or OUT source build 204# Determine using IN or OUT source build
125_check_build_dir() { 205_check_build_dir() {
126 : ${ECONF_SOURCE:=${S}} 206 : ${ECONF_SOURCE:=${S}}
127 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 207 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
128 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 208 BUILD_DIR="${ECONF_SOURCE}"
129 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
130 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 224 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
131 fi 225 fi
226 fi
227
228 # Backwards compatibility for getting the value.
229 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
132 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 230 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
133} 231}
134 232
135# @FUNCTION: remove_libtool_files 233# @FUNCTION: remove_libtool_files
136# @USAGE: [all] 234# @USAGE: [all]
137# @DESCRIPTION: 235# @DESCRIPTION:
144# 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.
145# See autotools-utils_src_install for reference. 243# See autotools-utils_src_install for reference.
146remove_libtool_files() { 244remove_libtool_files() {
147 debug-print-function ${FUNCNAME} "$@" 245 debug-print-function ${FUNCNAME} "$@"
148 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
149 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 251 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
150 if [[ ${#} -eq 1 ]]; then 252 if [[ ${#} -eq 1 ]]; then
151 case "${1}" in 253 case "${1}" in
152 all) 254 all)
153 removing_all=1 255 removing_all=1
201 rm -f "${f}" || die 303 rm -f "${f}" || die
202 fi 304 fi
203 done 305 done
204} 306}
205 307
308# @FUNCTION: autotools-utils_autoreconf
309# @DESCRIPTION:
310# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
311autotools-utils_autoreconf() {
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."
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
382 fi
383 done
384}
385
206# @FUNCTION: autotools-utils_src_prepare 386# @FUNCTION: autotools-utils_src_prepare
207# @DESCRIPTION: 387# @DESCRIPTION:
208# The src_prepare function. 388# The src_prepare function.
209# 389#
210# 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.
211autotools-utils_src_prepare() { 391autotools-utils_src_prepare() {
212 debug-print-function ${FUNCNAME} "$@" 392 debug-print-function ${FUNCNAME} "$@"
213 393
214 base_src_prepare 394 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
395
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)
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
413
414 [[ ${want_autoreconf} ]] && eautoreconf
415 elibtoolize --patch-only
215} 416}
216 417
217# @FUNCTION: autotools-utils_src_configure 418# @FUNCTION: autotools-utils_src_configure
218# @DESCRIPTION: 419# @DESCRIPTION:
219# The src_configure function. For out of source build it creates build 420# The src_configure function. For out of source build it creates build
227 debug-print-function ${FUNCNAME} "$@" 428 debug-print-function ${FUNCNAME} "$@"
228 429
229 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 430 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
230 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 431 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
231 432
433 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
434
232 # Common args 435 # Common args
233 local econfargs=() 436 local econfargs=()
234 437
235 # Handle debug found in IUSE 438 _check_build_dir
236 if has debug ${IUSE//+}; then 439 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
237 local debugarg=$(use_enable debug) 440 econfargs+=(
238 if ! has "${debugarg}" "${myeconfargs[@]}"; then 441 --docdir="${EPREFIX}"/usr/share/doc/${PF}
239 eqawarn 'Implicit $(use_enable debug) for IUSE="debug" is no longer supported.' 442 )
240 eqawarn 'Please add the necessary arg to myeconfargs if requested.'
241 eqawarn 'The autotools-utils eclass will stop warning about it on Oct 15th.'
242 fi
243 fi 443 fi
244 444
245 # Handle static-libs found in IUSE, disable them by default 445 # Handle static-libs found in IUSE, disable them by default
246 if has static-libs ${IUSE//+}; then 446 if in_iuse static-libs; then
247 econfargs+=( 447 econfargs+=(
248 --enable-shared 448 --enable-shared
249 $(use_enable static-libs static) 449 $(use_enable static-libs static)
250 ) 450 )
251 fi 451 fi
252 452
253 # Append user args 453 # Append user args
254 econfargs+=("${myeconfargs[@]}") 454 econfargs+=("${myeconfargs[@]}")
255 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
256 _check_build_dir 468 _check_build_dir
257 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
258 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 469 pushd "${BUILD_DIR}" > /dev/null || die
259 base_src_configure "${econfargs[@]}" "$@" 470 emake "$@" || die 'emake failed'
260 popd > /dev/null 471 popd > /dev/null || die
261}
262
263# @FUNCTION: autotools-utils_src_compile
264# @DESCRIPTION:
265# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
266autotools-utils_src_compile() {
267 debug-print-function ${FUNCNAME} "$@"
268
269 _check_build_dir
270 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
271 base_src_compile "$@"
272 popd > /dev/null
273} 472}
274 473
275# @FUNCTION: autotools-utils_src_install 474# @FUNCTION: autotools-utils_src_install
276# @DESCRIPTION: 475# @DESCRIPTION:
277# The autotools src_install function. Runs emake install, unconditionally 476# The autotools src_install function. Runs emake install, unconditionally
282# 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.
283autotools-utils_src_install() { 482autotools-utils_src_install() {
284 debug-print-function ${FUNCNAME} "$@" 483 debug-print-function ${FUNCNAME} "$@"
285 484
286 _check_build_dir 485 _check_build_dir
287 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 486 pushd "${BUILD_DIR}" > /dev/null || die
288 base_src_install "$@" 487 emake DESTDIR="${D}" "$@" install || die "emake install failed"
289 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
504
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
508 if [[ ${DOCS[@]} ]]; then
509 if [[ ${EAPI} == [23] ]]; then
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
525 fi
526 if [[ ${HTML_DOCS} ]]; then
527 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
528 fi
290 529
291 # Remove libtool files and unnecessary static libs 530 # Remove libtool files and unnecessary static libs
292 remove_libtool_files 531 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
532 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
293} 533}
294 534
295# @FUNCTION: autotools-utils_src_test 535# @FUNCTION: autotools-utils_src_test
296# @DESCRIPTION: 536# @DESCRIPTION:
297# The autotools src_test function. Runs emake check in build directory. 537# The autotools src_test function. Runs emake check in build directory.
298autotools-utils_src_test() { 538autotools-utils_src_test() {
299 debug-print-function ${FUNCNAME} "$@" 539 debug-print-function ${FUNCNAME} "$@"
300 540
301 _check_build_dir 541 _check_build_dir
302 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 542 pushd "${BUILD_DIR}" > /dev/null || die
303 # Run default src_test as defined in ebuild.sh 543 # Run default src_test as defined in ebuild.sh
304 default_src_test 544 default_src_test
305 popd > /dev/null 545 popd > /dev/null || die
306} 546}

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

  ViewVC Help
Powered by ViewVC 1.1.20