/[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.27 Revision 1.40
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.27 2011/11/26 20:43:55 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.40 2012/01/14 18:53:56 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_dep=no
115
116AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
92inherit autotools base eutils libtool 117inherit autotools eutils libtool
93 118
94EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 119EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
95 120
121unset _autotools_auto_dep
122
96# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 123# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
124# @DEFAULT_UNSET
97# @DESCRIPTION: 125# @DESCRIPTION:
98# Build directory, location where all autotools generated files should be 126# Build directory, location where all autotools generated files should be
99# 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.
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=(
117# $(use_enable debug cnddebug) 148# $(use_enable debug cnddebug)
118# $(use_enable threads multithreading) 149# $(use_enable threads multithreading)
119# ) 150# )
120# autotools-utils_src_configure 151# autotools-utils_src_configure
121# } 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 )
122# @CODE 183# @CODE
123 184
124# Determine using IN or OUT source build 185# Determine using IN or OUT source build
125_check_build_dir() { 186_check_build_dir() {
126 : ${ECONF_SOURCE:=${S}} 187 : ${ECONF_SOURCE:=${S}}
199 if [[ ${removing} ]]; then 260 if [[ ${removing} ]]; then
200 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 261 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
201 rm -f "${f}" || die 262 rm -f "${f}" || die
202 fi 263 fi
203 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 -- "${@}" AC_CONFIG_HEADER
288
289 for x; do
290 grep -h "^${x}" configure.{ac,in} 2>/dev/null
291 done
292 }
293
294 einfo "Autoreconfiguring '${PWD}' ..."
295
296 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
297 configure.{ac,in} 2>/dev/null)
298 if [[ ${auxdir} ]]; then
299 auxdir=${auxdir%%]}
300 mkdir -p ${auxdir##[}
301 fi
302
303 # Support running additional tools like gnome-autogen.sh.
304 # Note: you need to add additional depends to the ebuild.
305
306 # gettext
307 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
308 echo 'no' | autotools_run_tool glib-gettextize --copy
309 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
310 eautopoint --force
311 fi
312
313 # intltool
314 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
315 then
316 autotools_run_tool intltoolize --copy --automake --force
317 fi
318
319 # gtk-doc
320 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
321 autotools_run_tool gtkdocize --copy
322 fi
323
324 # gnome-doc
325 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
326 autotools_run_tool gnome-doc-prepare --copy --force
327 fi
328
329 # We need to perform the check twice to know whether to run eaclocal.
330 # (_elibtoolize does that itself)
331 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
332 then
333 _elibtoolize --copy --force --install
334 else
335 eaclocal
336 fi
337
338 eautoconf
339 eautoheader
340 FROM_EAUTORECONF=sure eautomake
341
342 local x
343 for x in $(autotools_get_subdirs); do
344 if [[ -d ${x} ]] ; then
345 pushd "${x}" >/dev/null
346 autotools-utils_eautoreconf
347 popd >/dev/null
348 fi
349 done
204} 350}
205 351
206# @FUNCTION: autotools-utils_src_prepare 352# @FUNCTION: autotools-utils_src_prepare
207# @DESCRIPTION: 353# @DESCRIPTION:
208# The src_prepare function. 354# The src_prepare function.
209# 355#
210# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 356# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
211autotools-utils_src_prepare() { 357autotools-utils_src_prepare() {
212 debug-print-function ${FUNCNAME} "$@" 358 debug-print-function ${FUNCNAME} "$@"
213 359
214 base_src_prepare 360 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
361
362 touch "${T}"/.autotools-utils.timestamp || die
363 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
364 epatch_user
365 if [[ ! ${want_autoreconf} ]]; then
366 if [[ $(find . -newer "${T}"/.autotools-utils.timestamp \
367 -a '(' -name 'Makefile.am' \
368 -o -name 'configure.ac' \
369 -o -name 'configure.in' ')' \
370 -print -quit) ]]; then
371 einfo 'Will autoreconfigure due to patches applied.'
372 want_autoreconf=yep
373 fi
374 fi
375
376 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
215 elibtoolize --patch-only 377 elibtoolize --patch-only
216} 378}
217 379
218# @FUNCTION: autotools-utils_src_configure 380# @FUNCTION: autotools-utils_src_configure
219# @DESCRIPTION: 381# @DESCRIPTION:
228 debug-print-function ${FUNCNAME} "$@" 390 debug-print-function ${FUNCNAME} "$@"
229 391
230 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 392 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
231 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 393 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
232 394
395 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
396
233 # Common args 397 # Common args
234 local econfargs=() 398 local econfargs=(
399 --docdir="${EPREFIX}/usr/share/doc/${PF}"
400 )
235 401
236 # Handle static-libs found in IUSE, disable them by default 402 # Handle static-libs found in IUSE, disable them by default
237 if in_iuse static-libs; then 403 if in_iuse static-libs; then
238 econfargs+=( 404 econfargs+=(
239 --enable-shared 405 --enable-shared
244 # Append user args 410 # Append user args
245 econfargs+=("${myeconfargs[@]}") 411 econfargs+=("${myeconfargs[@]}")
246 412
247 _check_build_dir 413 _check_build_dir
248 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 414 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
249 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 415 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
250 base_src_configure "${econfargs[@]}" "$@" 416 econf "${econfargs[@]}" "$@"
251 popd > /dev/null || die 417 popd > /dev/null
252} 418}
253 419
254# @FUNCTION: autotools-utils_src_compile 420# @FUNCTION: autotools-utils_src_compile
255# @DESCRIPTION: 421# @DESCRIPTION:
256# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 422# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
257autotools-utils_src_compile() { 423autotools-utils_src_compile() {
258 debug-print-function ${FUNCNAME} "$@" 424 debug-print-function ${FUNCNAME} "$@"
259 425
260 _check_build_dir 426 _check_build_dir
261 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 427 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
262 base_src_compile "$@" 428 emake "$@" || die 'emake failed'
263 popd > /dev/null || die 429 popd > /dev/null
264} 430}
265 431
266# @FUNCTION: autotools-utils_src_install 432# @FUNCTION: autotools-utils_src_install
267# @DESCRIPTION: 433# @DESCRIPTION:
268# The autotools src_install function. Runs emake install, unconditionally 434# The autotools src_install function. Runs emake install, unconditionally
273# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 439# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
274autotools-utils_src_install() { 440autotools-utils_src_install() {
275 debug-print-function ${FUNCNAME} "$@" 441 debug-print-function ${FUNCNAME} "$@"
276 442
277 _check_build_dir 443 _check_build_dir
278 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 444 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
279 base_src_install "$@" 445 emake DESTDIR="${D}" "$@" install || die "emake install failed"
280 popd > /dev/null || die 446 popd > /dev/null
447
448 # Move docs installed by autotools (in EAPI < 4).
449 if [[ ${EAPI} == [23] ]] \
450 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
451 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
452 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
453 else
454 mkdir "${T}"/temp-docdir
455 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
456 || die "moving docs to tempdir failed"
457
458 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
459 rm -r "${T}"/temp-docdir || die
460 fi
461 fi
462
463 # XXX: support installing them from builddir as well?
464 if [[ ${DOCS} ]]; then
465 dodoc "${DOCS[@]}" || die "dodoc failed"
466 else
467 local f
468 # same list as in PMS
469 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
470 THANKS BUGS FAQ CREDITS CHANGELOG; do
471 if [[ -s ${f} ]]; then
472 dodoc "${f}" || die "(default) dodoc ${f} failed"
473 fi
474 done
475 fi
476 if [[ ${HTML_DOCS} ]]; then
477 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
478 fi
281 479
282 # Remove libtool files and unnecessary static libs 480 # Remove libtool files and unnecessary static libs
283 remove_libtool_files 481 remove_libtool_files
284} 482}
285 483
288# The autotools src_test function. Runs emake check in build directory. 486# The autotools src_test function. Runs emake check in build directory.
289autotools-utils_src_test() { 487autotools-utils_src_test() {
290 debug-print-function ${FUNCNAME} "$@" 488 debug-print-function ${FUNCNAME} "$@"
291 489
292 _check_build_dir 490 _check_build_dir
293 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 491 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
294 # Run default src_test as defined in ebuild.sh 492 # Run default src_test as defined in ebuild.sh
295 default_src_test 493 default_src_test
296 popd > /dev/null || die 494 popd > /dev/null
297} 495}

Legend:
Removed from v.1.27  
changed lines
  Added in v.1.40

  ViewVC Help
Powered by ViewVC 1.1.20