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

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

  ViewVC Help
Powered by ViewVC 1.1.20