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

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

  ViewVC Help
Powered by ViewVC 1.1.20