/[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.56
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.23 2011/09/18 21:03:59 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.56 2012/06/08 17:50:10 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
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=(
119# ) 147# )
120# autotools-utils_src_configure 148# autotools-utils_src_configure
121# } 149# }
122# @CODE 150# @CODE
123 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 )
180# @CODE
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}}
127 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 185 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
128 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 186 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
144# In most cases it's not necessary to manually invoke this function. 202# In most cases it's not necessary to manually invoke this function.
145# See autotools-utils_src_install for reference. 203# See autotools-utils_src_install for reference.
146remove_libtool_files() { 204remove_libtool_files() {
147 debug-print-function ${FUNCNAME} "$@" 205 debug-print-function ${FUNCNAME} "$@"
148 local removing_all 206 local removing_all
207
208 eqawarn "The remove_libtool_files() function was deprecated."
209 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
210
149 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 211 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
150 if [[ ${#} -eq 1 ]]; then 212 if [[ ${#} -eq 1 ]]; then
151 case "${1}" in 213 case "${1}" in
152 all) 214 all)
153 removing_all=1 215 removing_all=1
201 rm -f "${f}" || die 263 rm -f "${f}" || die
202 fi 264 fi
203 done 265 done
204} 266}
205 267
268# @FUNCTION: autotools-utils_autoreconf
269# @DESCRIPTION:
270# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
271autotools-utils_autoreconf() {
272 debug-print-function ${FUNCNAME} "$@"
273
274 eqawarn "The autotools-utils_autoreconf() function was deprecated."
275 eqawarn "Please call autotools-utils_src_prepare()"
276 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
277
278 # Override this func to not require unnecessary eaclocal calls.
279 autotools_check_macro() {
280 local x
281
282 # Add a few additional variants as we don't get expansions.
283 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
284 AC_CONFIG_HEADER AM_CONFIG_HEADER
285
286 for x; do
287 grep -h "^${x}" configure.{ac,in} 2>/dev/null
288 done
289 }
290
291 einfo "Autoreconfiguring '${PWD}' ..."
292
293 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
294 configure.{ac,in} 2>/dev/null)
295 if [[ ${auxdir} ]]; then
296 auxdir=${auxdir%%]}
297 mkdir -p ${auxdir##[}
298 fi
299
300 # Support running additional tools like gnome-autogen.sh.
301 # Note: you need to add additional depends to the ebuild.
302
303 # gettext
304 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
305 echo 'no' | autotools_run_tool glib-gettextize --copy --force
306 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
307 eautopoint --force
308 fi
309
310 # intltool
311 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
312 then
313 autotools_run_tool intltoolize --copy --automake --force
314 fi
315
316 # gtk-doc
317 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
318 autotools_run_tool gtkdocize --copy
319 fi
320
321 # gnome-doc
322 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
323 autotools_run_tool gnome-doc-prepare --copy --force
324 fi
325
326 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
327 then
328 _elibtoolize --copy --force --install
329 fi
330
331 eaclocal
332 eautoconf
333 eautoheader
334 FROM_EAUTORECONF=sure eautomake
335
336 local x
337 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
338 if [[ -d ${x} ]] ; then
339 pushd "${x}" >/dev/null || die
340 autotools-utils_autoreconf
341 popd >/dev/null || die
342 fi
343 done
344}
345
206# @FUNCTION: autotools-utils_src_prepare 346# @FUNCTION: autotools-utils_src_prepare
207# @DESCRIPTION: 347# @DESCRIPTION:
208# The src_prepare function. 348# The src_prepare function.
209# 349#
210# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 350# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
211autotools-utils_src_prepare() { 351autotools-utils_src_prepare() {
212 debug-print-function ${FUNCNAME} "$@" 352 debug-print-function ${FUNCNAME} "$@"
213 353
214 base_src_prepare 354 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
355
356 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
357
358 at_checksum() {
359 find '(' -name 'Makefile.am' \
360 -o -name 'configure.ac' \
361 -o -name 'configure.in' ')' \
362 -exec cksum {} + | sort -k2
363 }
364
365 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
366 epatch_user
367 if [[ ! ${want_autoreconf} ]]; then
368 if [[ ${checksum} != $(at_checksum) ]]; then
369 einfo 'Will autoreconfigure due to user patches applied.'
370 want_autoreconf=yep
371 fi
372 fi
373
374 [[ ${want_autoreconf} ]] && eautoreconf
375 elibtoolize --patch-only
215} 376}
216 377
217# @FUNCTION: autotools-utils_src_configure 378# @FUNCTION: autotools-utils_src_configure
218# @DESCRIPTION: 379# @DESCRIPTION:
219# The src_configure function. For out of source build it creates build 380# The src_configure function. For out of source build it creates build
227 debug-print-function ${FUNCNAME} "$@" 388 debug-print-function ${FUNCNAME} "$@"
228 389
229 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 390 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
230 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 391 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
231 392
393 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
394
232 # Common args 395 # Common args
233 local econfargs=() 396 local econfargs=()
234 397
235 # Handle debug found in IUSE 398 _check_build_dir
236 if has debug ${IUSE//+}; then 399 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
237 local debugarg=$(use_enable debug) 400 econfargs+=(
238 if ! has "${debugarg}" "${myeconfargs[@]}"; then 401 --docdir="${EPREFIX}"/usr/share/doc/${PF}
239 eqawarn 'Implicit $(use_enable debug) for IUSE="debug" is no longer supported.' 402 )
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 403 fi
244 404
245 # Handle static-libs found in IUSE, disable them by default 405 # Handle static-libs found in IUSE, disable them by default
246 if has static-libs ${IUSE//+}; then 406 if in_iuse static-libs; then
247 econfargs+=( 407 econfargs+=(
248 --enable-shared 408 --enable-shared
249 $(use_enable static-libs static) 409 $(use_enable static-libs static)
250 ) 410 )
251 fi 411 fi
252 412
253 # Append user args 413 # Append user args
254 econfargs+=("${myeconfargs[@]}") 414 econfargs+=("${myeconfargs[@]}")
255 415
256 _check_build_dir
257 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 416 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
258 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 417 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
259 base_src_configure "${econfargs[@]}" "$@" 418 econf "${econfargs[@]}" "$@"
260 popd > /dev/null 419 popd > /dev/null || die
261} 420}
262 421
263# @FUNCTION: autotools-utils_src_compile 422# @FUNCTION: autotools-utils_src_compile
264# @DESCRIPTION: 423# @DESCRIPTION:
265# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 424# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
266autotools-utils_src_compile() { 425autotools-utils_src_compile() {
267 debug-print-function ${FUNCNAME} "$@" 426 debug-print-function ${FUNCNAME} "$@"
268 427
269 _check_build_dir 428 _check_build_dir
270 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 429 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
271 base_src_compile "$@" 430 emake "$@" || die 'emake failed'
272 popd > /dev/null 431 popd > /dev/null || die
273} 432}
274 433
275# @FUNCTION: autotools-utils_src_install 434# @FUNCTION: autotools-utils_src_install
276# @DESCRIPTION: 435# @DESCRIPTION:
277# The autotools src_install function. Runs emake install, unconditionally 436# The autotools src_install function. Runs emake install, unconditionally
282# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 441# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
283autotools-utils_src_install() { 442autotools-utils_src_install() {
284 debug-print-function ${FUNCNAME} "$@" 443 debug-print-function ${FUNCNAME} "$@"
285 444
286 _check_build_dir 445 _check_build_dir
287 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 446 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
288 base_src_install "$@" 447 emake DESTDIR="${D}" "$@" install || die "emake install failed"
289 popd > /dev/null 448 popd > /dev/null || die
449
450 # Move docs installed by autotools (in EAPI < 4).
451 if [[ ${EAPI} == [23] ]] \
452 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
453 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
454 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
455 else
456 mkdir "${T}"/temp-docdir
457 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
458 || die "moving docs to tempdir failed"
459
460 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
461 rm -r "${T}"/temp-docdir || die
462 fi
463 fi
464
465 # XXX: support installing them from builddir as well?
466 if [[ ${DOCS} ]]; then
467 dodoc "${DOCS[@]}" || die "dodoc failed"
468 else
469 local f
470 # same list as in PMS
471 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
472 THANKS BUGS FAQ CREDITS CHANGELOG; do
473 if [[ -s ${f} ]]; then
474 dodoc "${f}" || die "(default) dodoc ${f} failed"
475 fi
476 done
477 fi
478 if [[ ${HTML_DOCS} ]]; then
479 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
480 fi
290 481
291 # Remove libtool files and unnecessary static libs 482 # Remove libtool files and unnecessary static libs
292 remove_libtool_files 483 prune_libtool_files
293} 484}
294 485
295# @FUNCTION: autotools-utils_src_test 486# @FUNCTION: autotools-utils_src_test
296# @DESCRIPTION: 487# @DESCRIPTION:
297# The autotools src_test function. Runs emake check in build directory. 488# The autotools src_test function. Runs emake check in build directory.
298autotools-utils_src_test() { 489autotools-utils_src_test() {
299 debug-print-function ${FUNCNAME} "$@" 490 debug-print-function ${FUNCNAME} "$@"
300 491
301 _check_build_dir 492 _check_build_dir
302 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 493 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
303 # Run default src_test as defined in ebuild.sh 494 # Run default src_test as defined in ebuild.sh
304 default_src_test 495 default_src_test
305 popd > /dev/null 496 popd > /dev/null || die
306} 497}

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

  ViewVC Help
Powered by ViewVC 1.1.20