/[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.24 Revision 1.52
1# Copyright 1999-2010 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.24 2011/09/23 07:56:41 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.52 2012/05/28 07:45:19 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 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
87case ${EAPI:-0} in 91case ${EAPI:-0} in
88 2|3|4) ;; 92 2|3|4) ;;
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: AUTOTOOLS_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.
100 125
101# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 126# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
127# @DEFAULT_UNSET
102# @DESCRIPTION: 128# @DESCRIPTION:
103# Set to enable in-source build. 129# Set to enable in-source build.
104 130
105# @ECLASS-VARIABLE: ECONF_SOURCE 131# @ECLASS-VARIABLE: ECONF_SOURCE
132# @DEFAULT_UNSET
106# @DESCRIPTION: 133# @DESCRIPTION:
107# Specify location of autotools' configure script. By default it uses ${S}. 134# Specify location of autotools' configure script. By default it uses ${S}.
108 135
109# @ECLASS-VARIABLE: myeconfargs 136# @ECLASS-VARIABLE: myeconfargs
137# @DEFAULT_UNSET
110# @DESCRIPTION: 138# @DESCRIPTION:
111# Optional econf arguments as Bash array. Should be defined before calling src_configure. 139# Optional econf arguments as Bash array. Should be defined before calling src_configure.
112# @CODE 140# @CODE
113# src_configure() { 141# src_configure() {
114# local myeconfargs=( 142# local myeconfargs=(
117# $(use_enable debug cnddebug) 145# $(use_enable debug cnddebug)
118# $(use_enable threads multithreading) 146# $(use_enable threads multithreading)
119# ) 147# )
120# autotools-utils_src_configure 148# autotools-utils_src_configure
121# } 149# }
150# @CODE
151
152# @ECLASS-VARIABLE: DOCS
153# @DEFAULT_UNSET
154# @DESCRIPTION:
155# Array containing documents passed to dodoc command.
156#
157# Example:
158# @CODE
159# DOCS=( NEWS README )
160# @CODE
161
162# @ECLASS-VARIABLE: HTML_DOCS
163# @DEFAULT_UNSET
164# @DESCRIPTION:
165# Array containing documents passed to dohtml command.
166#
167# Example:
168# @CODE
169# HTML_DOCS=( doc/html/ )
170# @CODE
171
172# @ECLASS-VARIABLE: PATCHES
173# @DEFAULT_UNSET
174# @DESCRIPTION:
175# PATCHES array variable containing all various patches to be applied.
176#
177# Example:
178# @CODE
179# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
122# @CODE 180# @CODE
123 181
124# Determine using IN or OUT source build 182# Determine using IN or OUT source build
125_check_build_dir() { 183_check_build_dir() {
126 : ${ECONF_SOURCE:=${S}} 184 : ${ECONF_SOURCE:=${S}}
199 if [[ ${removing} ]]; then 257 if [[ ${removing} ]]; then
200 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 258 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
201 rm -f "${f}" || die 259 rm -f "${f}" || die
202 fi 260 fi
203 done 261 done
262
263 # check for invalid eclass use
264 # this is the most commonly used function, so do it here
265 _check_build_dir
266 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then
267 eqawarn "autotools-utils used but autotools-utils_src_configure was never called."
268 eqawarn "This is not supported and never was. Please report a bug against"
269 eqawarn "the offending ebuild. This will become a fatal error in a near future."
270 fi
271}
272
273# @FUNCTION: autotools-utils_autoreconf
274# @DESCRIPTION:
275# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
276autotools-utils_autoreconf() {
277 debug-print-function ${FUNCNAME} "$@"
278
279 # Override this func to not require unnecessary eaclocal calls.
280 autotools_check_macro() {
281 local x
282
283 # Add a few additional variants as we don't get expansions.
284 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
285 AC_CONFIG_HEADER AM_CONFIG_HEADER
286
287 for x; do
288 grep -h "^${x}" configure.{ac,in} 2>/dev/null
289 done
290 }
291
292 einfo "Autoreconfiguring '${PWD}' ..."
293
294 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
295 configure.{ac,in} 2>/dev/null)
296 if [[ ${auxdir} ]]; then
297 auxdir=${auxdir%%]}
298 mkdir -p ${auxdir##[}
299 fi
300
301 # Support running additional tools like gnome-autogen.sh.
302 # Note: you need to add additional depends to the ebuild.
303
304 # gettext
305 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
306 echo 'no' | autotools_run_tool glib-gettextize --copy --force
307 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
308 eautopoint --force
309 fi
310
311 # intltool
312 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
313 then
314 autotools_run_tool intltoolize --copy --automake --force
315 fi
316
317 # gtk-doc
318 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
319 autotools_run_tool gtkdocize --copy
320 fi
321
322 # gnome-doc
323 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
324 autotools_run_tool gnome-doc-prepare --copy --force
325 fi
326
327 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
328 then
329 _elibtoolize --copy --force --install
330 fi
331
332 eaclocal
333 eautoconf
334 eautoheader
335 FROM_EAUTORECONF=sure eautomake
336
337 local x
338 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
339 if [[ -d ${x} ]] ; then
340 pushd "${x}" >/dev/null || die
341 autotools-utils_autoreconf
342 popd >/dev/null || die
343 fi
344 done
204} 345}
205 346
206# @FUNCTION: autotools-utils_src_prepare 347# @FUNCTION: autotools-utils_src_prepare
207# @DESCRIPTION: 348# @DESCRIPTION:
208# The src_prepare function. 349# The src_prepare function.
209# 350#
210# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 351# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
211autotools-utils_src_prepare() { 352autotools-utils_src_prepare() {
212 debug-print-function ${FUNCNAME} "$@" 353 debug-print-function ${FUNCNAME} "$@"
213 354
214 base_src_prepare 355 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
356
357 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
358
359 at_checksum() {
360 find '(' -name 'Makefile.am' \
361 -o -name 'configure.ac' \
362 -o -name 'configure.in' ')' \
363 -exec cksum {} + | sort -k2
364 }
365
366 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
367 epatch_user
368 if [[ ! ${want_autoreconf} ]]; then
369 if [[ ${checksum} != $(at_checksum) ]]; then
370 einfo 'Will autoreconfigure due to user patches applied.'
371 want_autoreconf=yep
372 fi
373 fi
374
375 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
376 elibtoolize --patch-only
215} 377}
216 378
217# @FUNCTION: autotools-utils_src_configure 379# @FUNCTION: autotools-utils_src_configure
218# @DESCRIPTION: 380# @DESCRIPTION:
219# The src_configure function. For out of source build it creates build 381# The src_configure function. For out of source build it creates build
227 debug-print-function ${FUNCNAME} "$@" 389 debug-print-function ${FUNCNAME} "$@"
228 390
229 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 391 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
230 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 392 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
231 393
394 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
395
232 # Common args 396 # Common args
233 local econfargs=() 397 local econfargs=()
234 398
235 # Handle debug found in IUSE 399 _check_build_dir
236 if in_iuse debug; then 400 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
237 local debugarg=$(use_enable debug) 401 econfargs+=(
238 if ! has "${debugarg}" "${myeconfargs[@]}"; then 402 --docdir="${EPREFIX}"/usr/share/doc/${PF}
239 eqawarn 'Implicit $(use_enable debug) for IUSE="debug" is no longer supported.' 403 )
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 404 fi
244 405
245 # Handle static-libs found in IUSE, disable them by default 406 # Handle static-libs found in IUSE, disable them by default
246 if in_iuse static-libs; then 407 if in_iuse static-libs; then
247 econfargs+=( 408 econfargs+=(
251 fi 412 fi
252 413
253 # Append user args 414 # Append user args
254 econfargs+=("${myeconfargs[@]}") 415 econfargs+=("${myeconfargs[@]}")
255 416
256 _check_build_dir
257 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 417 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
258 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 418 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
259 base_src_configure "${econfargs[@]}" "$@" 419 econf "${econfargs[@]}" "$@"
260 popd > /dev/null 420 popd > /dev/null || die
261} 421}
262 422
263# @FUNCTION: autotools-utils_src_compile 423# @FUNCTION: autotools-utils_src_compile
264# @DESCRIPTION: 424# @DESCRIPTION:
265# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 425# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
266autotools-utils_src_compile() { 426autotools-utils_src_compile() {
267 debug-print-function ${FUNCNAME} "$@" 427 debug-print-function ${FUNCNAME} "$@"
268 428
269 _check_build_dir 429 _check_build_dir
270 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 430 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
271 base_src_compile "$@" 431 emake "$@" || die 'emake failed'
272 popd > /dev/null 432 popd > /dev/null || die
273} 433}
274 434
275# @FUNCTION: autotools-utils_src_install 435# @FUNCTION: autotools-utils_src_install
276# @DESCRIPTION: 436# @DESCRIPTION:
277# The autotools src_install function. Runs emake install, unconditionally 437# The autotools src_install function. Runs emake install, unconditionally
282# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 442# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
283autotools-utils_src_install() { 443autotools-utils_src_install() {
284 debug-print-function ${FUNCNAME} "$@" 444 debug-print-function ${FUNCNAME} "$@"
285 445
286 _check_build_dir 446 _check_build_dir
287 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 447 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
288 base_src_install "$@" 448 emake DESTDIR="${D}" "$@" install || die "emake install failed"
289 popd > /dev/null 449 popd > /dev/null || die
450
451 # Move docs installed by autotools (in EAPI < 4).
452 if [[ ${EAPI} == [23] ]] \
453 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
454 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
455 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
456 else
457 mkdir "${T}"/temp-docdir
458 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
459 || die "moving docs to tempdir failed"
460
461 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
462 rm -r "${T}"/temp-docdir || die
463 fi
464 fi
465
466 # XXX: support installing them from builddir as well?
467 if [[ ${DOCS} ]]; then
468 dodoc "${DOCS[@]}" || die "dodoc failed"
469 else
470 local f
471 # same list as in PMS
472 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
473 THANKS BUGS FAQ CREDITS CHANGELOG; do
474 if [[ -s ${f} ]]; then
475 dodoc "${f}" || die "(default) dodoc ${f} failed"
476 fi
477 done
478 fi
479 if [[ ${HTML_DOCS} ]]; then
480 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
481 fi
290 482
291 # Remove libtool files and unnecessary static libs 483 # Remove libtool files and unnecessary static libs
292 remove_libtool_files 484 remove_libtool_files
293} 485}
294 486
297# The autotools src_test function. Runs emake check in build directory. 489# The autotools src_test function. Runs emake check in build directory.
298autotools-utils_src_test() { 490autotools-utils_src_test() {
299 debug-print-function ${FUNCNAME} "$@" 491 debug-print-function ${FUNCNAME} "$@"
300 492
301 _check_build_dir 493 _check_build_dir
302 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 494 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
303 # Run default src_test as defined in ebuild.sh 495 # Run default src_test as defined in ebuild.sh
304 default_src_test 496 default_src_test
305 popd > /dev/null 497 popd > /dev/null || die
306} 498}

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.52

  ViewVC Help
Powered by ViewVC 1.1.20