/[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.29 Revision 1.59
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.29 2011/11/27 09:57:20 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.59 2012/12/03 09:29:09 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:
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 base 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
121# @DEFAULT_UNSET
101# @DESCRIPTION: 122# @DESCRIPTION:
102# Build directory, location where all autotools generated files should be 123# Build directory, location where all autotools generated files should be
103# 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.
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=(
123# ) 150# )
124# autotools-utils_src_configure 151# autotools-utils_src_configure
125# } 152# }
126# @CODE 153# @CODE
127 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 )
183# @CODE
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}}
131 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 188 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
132 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 189 BUILD_DIR="${ECONF_SOURCE}"
133 else 190 else
191 # Respect both the old variable and the new one, depending
192 # on which one was set by the ebuild.
193 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
194 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
195 eqawarn "Please migrate the ebuild to use the new one."
196
197 # In the next call, both variables will be set already
198 # and we'd have to know which one takes precedence.
199 _RESPECT_AUTOTOOLS_BUILD_DIR=1
200 fi
201 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
202 BUILD_DIR=${AUTOTOOLS_BUILD_DIR}
203 fi
204
134 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 205 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
135 fi 206 fi
207
208 # Backwards compatibility for getting the value.
209 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
136 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 210 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
137} 211}
138 212
139# @FUNCTION: remove_libtool_files 213# @FUNCTION: remove_libtool_files
140# @USAGE: [all] 214# @USAGE: [all]
141# @DESCRIPTION: 215# @DESCRIPTION:
148# In most cases it's not necessary to manually invoke this function. 222# In most cases it's not necessary to manually invoke this function.
149# See autotools-utils_src_install for reference. 223# See autotools-utils_src_install for reference.
150remove_libtool_files() { 224remove_libtool_files() {
151 debug-print-function ${FUNCNAME} "$@" 225 debug-print-function ${FUNCNAME} "$@"
152 local removing_all 226 local removing_all
227
228 eqawarn "The remove_libtool_files() function was deprecated."
229 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
230
153 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 231 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
154 if [[ ${#} -eq 1 ]]; then 232 if [[ ${#} -eq 1 ]]; then
155 case "${1}" in 233 case "${1}" in
156 all) 234 all)
157 removing_all=1 235 removing_all=1
203 if [[ ${removing} ]]; then 281 if [[ ${removing} ]]; then
204 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 282 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
205 rm -f "${f}" || die 283 rm -f "${f}" || die
206 fi 284 fi
207 done 285 done
286}
208 287
209 # check for invalid eclass use 288# @FUNCTION: autotools-utils_autoreconf
210 # this is the most commonly used function, so do it here 289# @DESCRIPTION:
211 _check_build_dir 290# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
212 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then 291autotools-utils_autoreconf() {
213 eqawarn "autotools-utils used but autotools-utils_src_configure was never called." 292 debug-print-function ${FUNCNAME} "$@"
214 eqawarn "This is not supported and never was. Please report a bug against" 293
215 eqawarn "the offending ebuild. This will become a fatal error in a near future." 294 eqawarn "The autotools-utils_autoreconf() function was deprecated."
295 eqawarn "Please call autotools-utils_src_prepare()"
296 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
297
298 # Override this func to not require unnecessary eaclocal calls.
299 autotools_check_macro() {
300 local x
301
302 # Add a few additional variants as we don't get expansions.
303 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
304 AC_CONFIG_HEADER AM_CONFIG_HEADER
305
306 for x; do
307 grep -h "^${x}" configure.{ac,in} 2>/dev/null
308 done
309 }
310
311 einfo "Autoreconfiguring '${PWD}' ..."
312
313 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
314 configure.{ac,in} 2>/dev/null)
315 if [[ ${auxdir} ]]; then
316 auxdir=${auxdir%%]}
317 mkdir -p ${auxdir##[}
318 fi
319
320 # Support running additional tools like gnome-autogen.sh.
321 # Note: you need to add additional depends to the ebuild.
322
323 # gettext
324 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
325 echo 'no' | autotools_run_tool glib-gettextize --copy --force
326 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
327 eautopoint --force
328 fi
329
330 # intltool
331 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
332 then
333 autotools_run_tool intltoolize --copy --automake --force
334 fi
335
336 # gtk-doc
337 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
338 autotools_run_tool gtkdocize --copy
339 fi
340
341 # gnome-doc
342 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
343 autotools_run_tool gnome-doc-prepare --copy --force
344 fi
345
346 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
347 then
348 _elibtoolize --copy --force --install
349 fi
350
351 eaclocal
352 eautoconf
353 eautoheader
354 FROM_EAUTORECONF=sure eautomake
355
356 local x
357 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
358 if [[ -d ${x} ]] ; then
359 pushd "${x}" >/dev/null || die
360 autotools-utils_autoreconf
361 popd >/dev/null || die
216 fi 362 fi
363 done
217} 364}
218 365
219# @FUNCTION: autotools-utils_src_prepare 366# @FUNCTION: autotools-utils_src_prepare
220# @DESCRIPTION: 367# @DESCRIPTION:
221# The src_prepare function. 368# The src_prepare function.
222# 369#
223# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 370# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
224autotools-utils_src_prepare() { 371autotools-utils_src_prepare() {
225 debug-print-function ${FUNCNAME} "$@" 372 debug-print-function ${FUNCNAME} "$@"
226 373
227 base_src_prepare 374 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
375
376 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
377
378 at_checksum() {
379 find '(' -name 'Makefile.am' \
380 -o -name 'configure.ac' \
381 -o -name 'configure.in' ')' \
382 -exec cksum {} + | sort -k2
383 }
384
385 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
386 epatch_user
387 if [[ ! ${want_autoreconf} ]]; then
388 if [[ ${checksum} != $(at_checksum) ]]; then
389 einfo 'Will autoreconfigure due to user patches applied.'
390 want_autoreconf=yep
391 fi
392 fi
393
394 [[ ${want_autoreconf} ]] && eautoreconf
228 elibtoolize --patch-only 395 elibtoolize --patch-only
229} 396}
230 397
231# @FUNCTION: autotools-utils_src_configure 398# @FUNCTION: autotools-utils_src_configure
232# @DESCRIPTION: 399# @DESCRIPTION:
241 debug-print-function ${FUNCNAME} "$@" 408 debug-print-function ${FUNCNAME} "$@"
242 409
243 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 410 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
244 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 411 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
245 412
413 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
414
246 # Common args 415 # Common args
247 local econfargs=() 416 local econfargs=()
417
418 _check_build_dir
419 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
420 econfargs+=(
421 --docdir="${EPREFIX}"/usr/share/doc/${PF}
422 )
423 fi
248 424
249 # Handle static-libs found in IUSE, disable them by default 425 # Handle static-libs found in IUSE, disable them by default
250 if in_iuse static-libs; then 426 if in_iuse static-libs; then
251 econfargs+=( 427 econfargs+=(
252 --enable-shared 428 --enable-shared
255 fi 431 fi
256 432
257 # Append user args 433 # Append user args
258 econfargs+=("${myeconfargs[@]}") 434 econfargs+=("${myeconfargs[@]}")
259 435
436 mkdir -p "${BUILD_DIR}" || die
437 pushd "${BUILD_DIR}" > /dev/null || die
438 econf "${econfargs[@]}" "$@"
439 popd > /dev/null || die
440}
441
442# @FUNCTION: autotools-utils_src_compile
443# @DESCRIPTION:
444# The autotools src_compile function, invokes emake in specified BUILD_DIR.
445autotools-utils_src_compile() {
446 debug-print-function ${FUNCNAME} "$@"
447
260 _check_build_dir 448 _check_build_dir
261 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
262 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 449 pushd "${BUILD_DIR}" > /dev/null || die
263 base_src_configure "${econfargs[@]}" "$@" 450 emake "$@" || die 'emake failed'
264 popd > /dev/null 451 popd > /dev/null || die
265}
266
267# @FUNCTION: autotools-utils_src_compile
268# @DESCRIPTION:
269# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
270autotools-utils_src_compile() {
271 debug-print-function ${FUNCNAME} "$@"
272
273 _check_build_dir
274 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
275 base_src_compile "$@"
276 popd > /dev/null
277} 452}
278 453
279# @FUNCTION: autotools-utils_src_install 454# @FUNCTION: autotools-utils_src_install
280# @DESCRIPTION: 455# @DESCRIPTION:
281# The autotools src_install function. Runs emake install, unconditionally 456# The autotools src_install function. Runs emake install, unconditionally
286# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 461# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
287autotools-utils_src_install() { 462autotools-utils_src_install() {
288 debug-print-function ${FUNCNAME} "$@" 463 debug-print-function ${FUNCNAME} "$@"
289 464
290 _check_build_dir 465 _check_build_dir
291 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 466 pushd "${BUILD_DIR}" > /dev/null || die
292 base_src_install "$@" 467 emake DESTDIR="${D}" "$@" install || die "emake install failed"
293 popd > /dev/null 468 popd > /dev/null || die
469
470 # Move docs installed by autotools (in EAPI < 4).
471 if [[ ${EAPI} == [23] ]] \
472 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
473 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
474 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
475 else
476 mkdir "${T}"/temp-docdir
477 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
478 || die "moving docs to tempdir failed"
479
480 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
481 rm -r "${T}"/temp-docdir || die
482 fi
483 fi
484
485 # XXX: support installing them from builddir as well?
486 if [[ ${DOCS} ]]; then
487 dodoc "${DOCS[@]}" || die "dodoc failed"
488 else
489 local f
490 # same list as in PMS
491 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
492 THANKS BUGS FAQ CREDITS CHANGELOG; do
493 if [[ -s ${f} ]]; then
494 dodoc "${f}" || die "(default) dodoc ${f} failed"
495 fi
496 done
497 fi
498 if [[ ${HTML_DOCS} ]]; then
499 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
500 fi
294 501
295 # Remove libtool files and unnecessary static libs 502 # Remove libtool files and unnecessary static libs
296 remove_libtool_files 503 prune_libtool_files
297} 504}
298 505
299# @FUNCTION: autotools-utils_src_test 506# @FUNCTION: autotools-utils_src_test
300# @DESCRIPTION: 507# @DESCRIPTION:
301# The autotools src_test function. Runs emake check in build directory. 508# The autotools src_test function. Runs emake check in build directory.
302autotools-utils_src_test() { 509autotools-utils_src_test() {
303 debug-print-function ${FUNCNAME} "$@" 510 debug-print-function ${FUNCNAME} "$@"
304 511
305 _check_build_dir 512 _check_build_dir
306 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 513 pushd "${BUILD_DIR}" > /dev/null || die
307 # Run default src_test as defined in ebuild.sh 514 # Run default src_test as defined in ebuild.sh
308 default_src_test 515 default_src_test
309 popd > /dev/null 516 popd > /dev/null || die
310} 517}

Legend:
Removed from v.1.29  
changed lines
  Added in v.1.59

  ViewVC Help
Powered by ViewVC 1.1.20