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

Legend:
Removed from v.1.28  
changed lines
  Added in v.1.47

  ViewVC Help
Powered by ViewVC 1.1.20