| 1 | # Copyright 1999-2012 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.33 2012/01/09 10:16:25 jlec Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.54 2012/06/06 15:43:45 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> |
| … | |
… | |
| 97 | # @DEFAULT_UNSET |
97 | # @DEFAULT_UNSET |
| 98 | # @DESCRIPTION: |
98 | # @DESCRIPTION: |
| 99 | # Set to a non-empty value in order to enable running autoreconf |
99 | # Set to a non-empty value in order to enable running autoreconf |
| 100 | # in src_prepare() and adding autotools dependencies. |
100 | # in src_prepare() and adding autotools dependencies. |
| 101 | # |
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 | # |
| 102 | # The eclass will try to determine the correct autotools to run including a few |
107 | # The eclass will try to determine the correct autotools to run including a few |
| 103 | # external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare. |
108 | # external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare. |
| 104 | # If your tool is not supported, please open a bug and we'll add support for it. |
109 | # If your tool is not supported, please open a bug and we'll add support for it. |
| 105 | # |
110 | # |
| 106 | # Note that dependencies are added for autoconf, automake and libtool only. |
111 | # Note that dependencies are added for autoconf, automake and libtool only. |
| 107 | # If your package needs one of the external tools listed above, you need to add |
112 | # If your package needs one of the external tools listed above, you need to add |
| 108 | # appropriate packages to DEPEND yourself. |
113 | # appropriate packages to DEPEND yourself. |
| 109 | [[ ${AUTOTOOLS_AUTORECONF} ]] || _autotools_auto_dep=no |
114 | [[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no} |
| 110 | |
115 | |
| 111 | AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \ |
|
|
| 112 | inherit autotools eutils libtool |
116 | inherit autotools eutils libtool |
| 113 | |
117 | |
| 114 | EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test |
118 | EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test |
| 115 | |
|
|
| 116 | unset _autotools_auto_dep |
|
|
| 117 | |
119 | |
| 118 | # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR |
120 | # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR |
| 119 | # @DEFAULT_UNSET |
121 | # @DEFAULT_UNSET |
| 120 | # @DESCRIPTION: |
122 | # @DESCRIPTION: |
| 121 | # Build directory, location where all autotools generated files should be |
123 | # Build directory, location where all autotools generated files should be |
| … | |
… | |
| 200 | # 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. |
| 201 | # See autotools-utils_src_install for reference. |
203 | # See autotools-utils_src_install for reference. |
| 202 | remove_libtool_files() { |
204 | remove_libtool_files() { |
| 203 | debug-print-function ${FUNCNAME} "$@" |
205 | debug-print-function ${FUNCNAME} "$@" |
| 204 | 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 | |
| 205 | [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" |
211 | [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" |
| 206 | if [[ ${#} -eq 1 ]]; then |
212 | if [[ ${#} -eq 1 ]]; then |
| 207 | case "${1}" in |
213 | case "${1}" in |
| 208 | all) |
214 | all) |
| 209 | removing_all=1 |
215 | removing_all=1 |
| … | |
… | |
| 255 | if [[ ${removing} ]]; then |
261 | if [[ ${removing} ]]; then |
| 256 | einfo "Removing unnecessary ${f#${D%/}} (${removing})" |
262 | einfo "Removing unnecessary ${f#${D%/}} (${removing})" |
| 257 | rm -f "${f}" || die |
263 | rm -f "${f}" || die |
| 258 | fi |
264 | fi |
| 259 | done |
265 | done |
| 260 | |
|
|
| 261 | # check for invalid eclass use |
|
|
| 262 | # this is the most commonly used function, so do it here |
|
|
| 263 | _check_build_dir |
|
|
| 264 | if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then |
|
|
| 265 | eqawarn "autotools-utils used but autotools-utils_src_configure was never called." |
|
|
| 266 | eqawarn "This is not supported and never was. Please report a bug against" |
|
|
| 267 | eqawarn "the offending ebuild. This will become a fatal error in a near future." |
|
|
| 268 | fi |
|
|
| 269 | } |
266 | } |
| 270 | |
267 | |
| 271 | # @FUNCTION: autotools-utils_autoreconf |
268 | # @FUNCTION: autotools-utils_autoreconf |
| 272 | # @DESCRIPTION: |
269 | # @DESCRIPTION: |
| 273 | # Reconfigure the sources (like gnome-autogen.sh or eautoreconf). |
270 | # Reconfigure the sources (like gnome-autogen.sh or eautoreconf). |
| … | |
… | |
| 277 | # Override this func to not require unnecessary eaclocal calls. |
274 | # Override this func to not require unnecessary eaclocal calls. |
| 278 | autotools_check_macro() { |
275 | autotools_check_macro() { |
| 279 | local x |
276 | local x |
| 280 | |
277 | |
| 281 | # Add a few additional variants as we don't get expansions. |
278 | # Add a few additional variants as we don't get expansions. |
| 282 | [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" AC_CONFIG_HEADER |
279 | [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \ |
|
|
280 | AC_CONFIG_HEADER AM_CONFIG_HEADER |
| 283 | |
281 | |
| 284 | for x; do |
282 | for x; do |
| 285 | grep -h "^${x}" configure.{ac,in} 2>/dev/null |
283 | grep -h "^${x}" configure.{ac,in} 2>/dev/null |
| 286 | done |
284 | done |
| 287 | } |
285 | } |
| … | |
… | |
| 298 | # Support running additional tools like gnome-autogen.sh. |
296 | # Support running additional tools like gnome-autogen.sh. |
| 299 | # Note: you need to add additional depends to the ebuild. |
297 | # Note: you need to add additional depends to the ebuild. |
| 300 | |
298 | |
| 301 | # gettext |
299 | # gettext |
| 302 | if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then |
300 | if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then |
| 303 | echo 'no' | autotools_run_tool glib-gettextize --copy |
301 | echo 'no' | autotools_run_tool glib-gettextize --copy --force |
| 304 | elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then |
302 | elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then |
| 305 | eautopoint |
303 | eautopoint --force |
| 306 | fi |
304 | fi |
| 307 | |
305 | |
| 308 | # intltool |
306 | # intltool |
| 309 | if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]] |
307 | if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]] |
| 310 | then |
308 | then |
| 311 | autotools_run_tool intltoolize --copy --automake |
309 | autotools_run_tool intltoolize --copy --automake --force |
| 312 | fi |
310 | fi |
| 313 | |
311 | |
| 314 | # gtk-doc |
312 | # gtk-doc |
| 315 | if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then |
313 | if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then |
| 316 | autotools_run_tool gtkdocize --copy |
314 | autotools_run_tool gtkdocize --copy |
| 317 | fi |
315 | fi |
| 318 | |
316 | |
| 319 | # gnome-doc |
317 | # gnome-doc |
| 320 | if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then |
318 | if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then |
| 321 | autotools_run_tool gnome-doc-prepare --copy |
319 | autotools_run_tool gnome-doc-prepare --copy --force |
| 322 | fi |
320 | fi |
| 323 | |
321 | |
| 324 | # We need to perform the check twice to know whether to run eaclocal. |
|
|
| 325 | # (_elibtoolize does that itself) |
|
|
| 326 | if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]] |
322 | if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]] |
| 327 | then |
323 | then |
| 328 | _elibtoolize --copy --force --install |
324 | _elibtoolize --copy --force --install |
| 329 | else |
325 | fi |
|
|
326 | |
| 330 | eaclocal |
327 | eaclocal |
| 331 | fi |
|
|
| 332 | |
|
|
| 333 | eautoconf |
328 | eautoconf |
| 334 | eautoheader |
329 | eautoheader |
| 335 | eautomake |
330 | FROM_EAUTORECONF=sure eautomake |
| 336 | |
331 | |
| 337 | local x |
332 | local x |
| 338 | for x in $(autotools_get_subdirs); do |
333 | for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do |
| 339 | if [[ -d ${x} ]] ; then |
334 | if [[ -d ${x} ]] ; then |
| 340 | pushd "${x}" >/dev/null |
335 | pushd "${x}" >/dev/null || die |
| 341 | autotools-utils_eautoreconf |
336 | autotools-utils_autoreconf |
| 342 | popd >/dev/null |
337 | popd >/dev/null || die |
| 343 | fi |
338 | fi |
| 344 | done |
339 | done |
| 345 | } |
340 | } |
| 346 | |
341 | |
| 347 | # @FUNCTION: autotools-utils_src_prepare |
342 | # @FUNCTION: autotools-utils_src_prepare |
| … | |
… | |
| 353 | debug-print-function ${FUNCNAME} "$@" |
348 | debug-print-function ${FUNCNAME} "$@" |
| 354 | |
349 | |
| 355 | local want_autoreconf=${AUTOTOOLS_AUTORECONF} |
350 | local want_autoreconf=${AUTOTOOLS_AUTORECONF} |
| 356 | |
351 | |
| 357 | [[ ${PATCHES} ]] && epatch "${PATCHES[@]}" |
352 | [[ ${PATCHES} ]] && epatch "${PATCHES[@]}" |
|
|
353 | |
|
|
354 | at_checksum() { |
|
|
355 | find '(' -name 'Makefile.am' \ |
|
|
356 | -o -name 'configure.ac' \ |
|
|
357 | -o -name 'configure.in' ')' \ |
|
|
358 | -exec cksum {} + | sort -k2 |
|
|
359 | } |
|
|
360 | |
|
|
361 | [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum) |
| 358 | epatch_user |
362 | epatch_user |
|
|
363 | if [[ ! ${want_autoreconf} ]]; then |
|
|
364 | if [[ ${checksum} != $(at_checksum) ]]; then |
|
|
365 | einfo 'Will autoreconfigure due to user patches applied.' |
|
|
366 | want_autoreconf=yep |
|
|
367 | fi |
|
|
368 | fi |
| 359 | |
369 | |
| 360 | [[ ${want_autoreconf} ]] && autotools-utils_autoreconf |
370 | [[ ${want_autoreconf} ]] && autotools-utils_autoreconf |
| 361 | elibtoolize --patch-only |
371 | elibtoolize --patch-only |
| 362 | } |
372 | } |
| 363 | |
373 | |
| … | |
… | |
| 374 | debug-print-function ${FUNCNAME} "$@" |
384 | debug-print-function ${FUNCNAME} "$@" |
| 375 | |
385 | |
| 376 | [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ |
386 | [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ |
| 377 | || die 'autotools-utils.eclass: myeconfargs has to be an array.' |
387 | || die 'autotools-utils.eclass: myeconfargs has to be an array.' |
| 378 | |
388 | |
|
|
389 | [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX= |
|
|
390 | |
| 379 | # Common args |
391 | # Common args |
| 380 | local econfargs=() |
392 | local econfargs=() |
|
|
393 | |
|
|
394 | _check_build_dir |
|
|
395 | if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then |
|
|
396 | econfargs+=( |
|
|
397 | --docdir="${EPREFIX}"/usr/share/doc/${PF} |
|
|
398 | ) |
|
|
399 | fi |
| 381 | |
400 | |
| 382 | # Handle static-libs found in IUSE, disable them by default |
401 | # Handle static-libs found in IUSE, disable them by default |
| 383 | if in_iuse static-libs; then |
402 | if in_iuse static-libs; then |
| 384 | econfargs+=( |
403 | econfargs+=( |
| 385 | --enable-shared |
404 | --enable-shared |
| … | |
… | |
| 388 | fi |
407 | fi |
| 389 | |
408 | |
| 390 | # Append user args |
409 | # Append user args |
| 391 | econfargs+=("${myeconfargs[@]}") |
410 | econfargs+=("${myeconfargs[@]}") |
| 392 | |
411 | |
| 393 | _check_build_dir |
|
|
| 394 | mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" |
412 | mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" |
| 395 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
413 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
| 396 | econf "${econfargs[@]}" "$@" |
414 | econf "${econfargs[@]}" "$@" |
| 397 | popd > /dev/null |
415 | popd > /dev/null || die |
| 398 | } |
416 | } |
| 399 | |
417 | |
| 400 | # @FUNCTION: autotools-utils_src_compile |
418 | # @FUNCTION: autotools-utils_src_compile |
| 401 | # @DESCRIPTION: |
419 | # @DESCRIPTION: |
| 402 | # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. |
420 | # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. |
| 403 | autotools-utils_src_compile() { |
421 | autotools-utils_src_compile() { |
| 404 | debug-print-function ${FUNCNAME} "$@" |
422 | debug-print-function ${FUNCNAME} "$@" |
| 405 | |
423 | |
| 406 | _check_build_dir |
424 | _check_build_dir |
| 407 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
425 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
| 408 | emake "$@" || die 'emake failed' |
426 | emake "$@" || die 'emake failed' |
| 409 | popd > /dev/null |
427 | popd > /dev/null || die |
| 410 | } |
428 | } |
| 411 | |
429 | |
| 412 | # @FUNCTION: autotools-utils_src_install |
430 | # @FUNCTION: autotools-utils_src_install |
| 413 | # @DESCRIPTION: |
431 | # @DESCRIPTION: |
| 414 | # The autotools src_install function. Runs emake install, unconditionally |
432 | # The autotools src_install function. Runs emake install, unconditionally |
| … | |
… | |
| 419 | # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. |
437 | # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. |
| 420 | autotools-utils_src_install() { |
438 | autotools-utils_src_install() { |
| 421 | debug-print-function ${FUNCNAME} "$@" |
439 | debug-print-function ${FUNCNAME} "$@" |
| 422 | |
440 | |
| 423 | _check_build_dir |
441 | _check_build_dir |
| 424 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
442 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
| 425 | emake DESTDIR="${D}" "$@" install || die "emake install failed" |
443 | emake DESTDIR="${D}" "$@" install || die "emake install failed" |
| 426 | popd > /dev/null |
444 | popd > /dev/null || die |
|
|
445 | |
|
|
446 | # Move docs installed by autotools (in EAPI < 4). |
|
|
447 | if [[ ${EAPI} == [23] ]] \ |
|
|
448 | && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then |
|
|
449 | if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then |
|
|
450 | eqawarn "autotools-utils: directories in docdir require at least EAPI 4" |
|
|
451 | else |
|
|
452 | mkdir "${T}"/temp-docdir |
|
|
453 | mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \ |
|
|
454 | || die "moving docs to tempdir failed" |
|
|
455 | |
|
|
456 | dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed" |
|
|
457 | rm -r "${T}"/temp-docdir || die |
|
|
458 | fi |
|
|
459 | fi |
| 427 | |
460 | |
| 428 | # XXX: support installing them from builddir as well? |
461 | # XXX: support installing them from builddir as well? |
| 429 | if [[ ${DOCS} ]]; then |
462 | if [[ ${DOCS} ]]; then |
| 430 | dodoc "${DOCS[@]}" || die "dodoc failed" |
463 | dodoc "${DOCS[@]}" || die "dodoc failed" |
|
|
464 | else |
|
|
465 | local f |
|
|
466 | # same list as in PMS |
|
|
467 | for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \ |
|
|
468 | THANKS BUGS FAQ CREDITS CHANGELOG; do |
|
|
469 | if [[ -s ${f} ]]; then |
|
|
470 | dodoc "${f}" || die "(default) dodoc ${f} failed" |
|
|
471 | fi |
|
|
472 | done |
| 431 | fi |
473 | fi |
| 432 | if [[ ${HTML_DOCS} ]]; then |
474 | if [[ ${HTML_DOCS} ]]; then |
| 433 | dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" |
475 | dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" |
| 434 | fi |
476 | fi |
| 435 | |
477 | |
| 436 | # Remove libtool files and unnecessary static libs |
478 | # Remove libtool files and unnecessary static libs |
| 437 | remove_libtool_files |
479 | prune_libtool_files |
| 438 | } |
480 | } |
| 439 | |
481 | |
| 440 | # @FUNCTION: autotools-utils_src_test |
482 | # @FUNCTION: autotools-utils_src_test |
| 441 | # @DESCRIPTION: |
483 | # @DESCRIPTION: |
| 442 | # The autotools src_test function. Runs emake check in build directory. |
484 | # The autotools src_test function. Runs emake check in build directory. |
| 443 | autotools-utils_src_test() { |
485 | autotools-utils_src_test() { |
| 444 | debug-print-function ${FUNCNAME} "$@" |
486 | debug-print-function ${FUNCNAME} "$@" |
| 445 | |
487 | |
| 446 | _check_build_dir |
488 | _check_build_dir |
| 447 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null |
489 | pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die |
| 448 | # Run default src_test as defined in ebuild.sh |
490 | # Run default src_test as defined in ebuild.sh |
| 449 | default_src_test |
491 | default_src_test |
| 450 | popd > /dev/null |
492 | popd > /dev/null || die |
| 451 | } |
493 | } |