/[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.31 Revision 1.74
1# Copyright 1999-2011 Gentoo Foundation 1# Copyright 1999-2014 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.31 2011/12/22 18:01:12 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.74 2014/07/31 23:24:56 reavertm 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:
35# IUSE="debug doc examples qt4 static-libs tiff" 35# IUSE="debug doc examples qt4 static-libs tiff"
36# 36#
37# CDEPEND=" 37# CDEPEND="
38# media-libs/libpng:0 38# media-libs/libpng:0
39# qt4? ( 39# qt4? (
40# x11-libs/qt-core:4 40# dev-qt/qtcore:4
41# x11-libs/qt-gui:4 41# dev-qt/qtgui:4
42# ) 42# )
43# tiff? ( media-libs/tiff:0 ) 43# tiff? ( media-libs/tiff:0 )
44# " 44# "
45# RDEPEND="${CDEPEND} 45# RDEPEND="${CDEPEND}
46# !media-gfx/bar 46# !media-gfx/bar
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 before calling inherit 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 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
101# @DEFAULT_UNSET 121# @DEFAULT_UNSET
102# @DESCRIPTION: 122# @DESCRIPTION:
103# Build directory, location where all autotools generated files should be 123# Build directory, location where all autotools generated files should be
104# 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.
105 128
106# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 129# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
107# @DEFAULT_UNSET 130# @DEFAULT_UNSET
108# @DESCRIPTION: 131# @DESCRIPTION:
109# Set to enable in-source build. 132# Set to enable in-source build.
111# @ECLASS-VARIABLE: ECONF_SOURCE 134# @ECLASS-VARIABLE: ECONF_SOURCE
112# @DEFAULT_UNSET 135# @DEFAULT_UNSET
113# @DESCRIPTION: 136# @DESCRIPTION:
114# Specify location of autotools' configure script. By default it uses ${S}. 137# Specify location of autotools' configure script. By default it uses ${S}.
115 138
116# @ECLASS-VARIABLE: myeconfargs
117# @DEFAULT_UNSET
118# @DESCRIPTION:
119# Optional econf arguments as Bash array. Should be defined before calling src_configure.
120# @CODE
121# src_configure() {
122# local myeconfargs=(
123# --disable-readline
124# --with-confdir="/etc/nasty foo confdir/"
125# $(use_enable debug cnddebug)
126# $(use_enable threads multithreading)
127# )
128# autotools-utils_src_configure
129# }
130# @CODE
131
132# @ECLASS-VARIABLE: DOCS 139# @ECLASS-VARIABLE: DOCS
133# @DEFAULT_UNSET 140# @DEFAULT_UNSET
134# @DESCRIPTION: 141# @DESCRIPTION:
135# Array containing documents passed to dodoc command. 142# Array containing documents passed to dodoc command.
136# 143#
144# In EAPIs 4+, can list directories as well.
145#
137# Example: 146# Example:
138# @CODE 147# @CODE
139# DOCS=( NEWS README ) 148# DOCS=( NEWS README )
140# @CODE 149# @CODE
141 150
156# 165#
157# Example: 166# Example:
158# @CODE 167# @CODE
159# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch ) 168# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
160# @CODE 169# @CODE
170
171# @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
172# @DEFAULT_UNSET
173# @DESCRIPTION:
174# Sets the mode of pruning libtool files. The values correspond to
175# prune_libtool_files parameters, with leading dashes stripped.
176#
177# Defaults to pruning the libtool files when static libraries are not
178# installed or can be linked properly without them. Libtool files
179# for modules (plugins) will be kept in case plugin loader needs them.
180#
181# If set to 'modules', the .la files for modules will be removed
182# as well. This is often the preferred option.
183#
184# If set to 'all', all .la files will be removed unconditionally. This
185# option is discouraged and shall be used only if 'modules' does not
186# remove the files.
187#
188# If set to 'none', no .la files will be pruned ever. Use in corner
189# cases only.
161 190
162# Determine using IN or OUT source build 191# Determine using IN or OUT source build
163_check_build_dir() { 192_check_build_dir() {
164 : ${ECONF_SOURCE:=${S}} 193 : ${ECONF_SOURCE:=${S}}
165 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 194 # Respect both the old variable and the new one, depending
166 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 195 # on which one was set by the ebuild.
196 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
197 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
198 eqawarn "Please migrate the ebuild to use the new one."
199
200 # In the next call, both variables will be set already
201 # and we'd have to know which one takes precedence.
202 _RESPECT_AUTOTOOLS_BUILD_DIR=1
203 fi
204
205 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
206 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
167 else 207 else
208 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
209 : ${BUILD_DIR:=${ECONF_SOURCE}}
210 else
168 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 211 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
169 fi 212 fi
213 fi
214
215 # Backwards compatibility for getting the value.
216 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
170 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 217 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
171} 218}
172 219
173# @FUNCTION: remove_libtool_files 220# @FUNCTION: remove_libtool_files
174# @USAGE: [all] 221# @USAGE: [all]
175# @DESCRIPTION: 222# @DESCRIPTION:
182# In most cases it's not necessary to manually invoke this function. 229# In most cases it's not necessary to manually invoke this function.
183# See autotools-utils_src_install for reference. 230# See autotools-utils_src_install for reference.
184remove_libtool_files() { 231remove_libtool_files() {
185 debug-print-function ${FUNCNAME} "$@" 232 debug-print-function ${FUNCNAME} "$@"
186 local removing_all 233 local removing_all
234
235 eqawarn "The remove_libtool_files() function was deprecated."
236 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
237
187 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 238 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
188 if [[ ${#} -eq 1 ]]; then 239 if [[ ${#} -eq 1 ]]; then
189 case "${1}" in 240 case "${1}" in
190 all) 241 all)
191 removing_all=1 242 removing_all=1
237 if [[ ${removing} ]]; then 288 if [[ ${removing} ]]; then
238 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 289 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
239 rm -f "${f}" || die 290 rm -f "${f}" || die
240 fi 291 fi
241 done 292 done
242
243 # check for invalid eclass use
244 # this is the most commonly used function, so do it here
245 _check_build_dir
246 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then
247 eqawarn "autotools-utils used but autotools-utils_src_configure was never called."
248 eqawarn "This is not supported and never was. Please report a bug against"
249 eqawarn "the offending ebuild. This will become a fatal error in a near future."
250 fi
251} 293}
252 294
253# @FUNCTION: autotools-utils_src_prepare 295# @FUNCTION: autotools-utils_src_prepare
254# @DESCRIPTION: 296# @DESCRIPTION:
255# The src_prepare function. 297# The src_prepare function.
256# 298#
257# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 299# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
258#
259# This function calls elibtoolize implicitly. If you need to call eautoreconf
260# afterwards, please use AT_NOELIBTOOLIZE=yes to avoid it being called twice.
261autotools-utils_src_prepare() { 300autotools-utils_src_prepare() {
262 debug-print-function ${FUNCNAME} "$@" 301 debug-print-function ${FUNCNAME} "$@"
263 302
303 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
304
264 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}" 305 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
306
307 at_checksum() {
308 find '(' -name 'Makefile.am' \
309 -o -name 'configure.ac' \
310 -o -name 'configure.in' ')' \
311 -exec cksum {} + | sort -k2
312 }
313
314 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
265 epatch_user 315 epatch_user
316 if [[ ! ${want_autoreconf} ]]; then
317 if [[ ${checksum} != $(at_checksum) ]]; then
318 einfo 'Will autoreconfigure due to user patches applied.'
319 want_autoreconf=yep
320 fi
321 fi
266 322
323 [[ ${want_autoreconf} ]] && eautoreconf
267 elibtoolize --patch-only 324 elibtoolize --patch-only
268} 325}
269 326
270# @FUNCTION: autotools-utils_src_configure 327# @FUNCTION: autotools-utils_src_configure
271# @DESCRIPTION: 328# @DESCRIPTION:
274# in myeconfargs are passed here to econf. Additionally following USE 331# in myeconfargs are passed here to econf. Additionally following USE
275# flags are known: 332# flags are known:
276# 333#
277# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static 334# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
278# to econf respectively. 335# to econf respectively.
336
337# @VARIABLE: myeconfargs
338# @DEFAULT_UNSET
339# @DESCRIPTION:
340# Optional econf arguments as Bash array. Should be defined before calling src_configure.
341# @CODE
342# src_configure() {
343# local myeconfargs=(
344# --disable-readline
345# --with-confdir="/etc/nasty foo confdir/"
346# $(use_enable debug cnddebug)
347# $(use_enable threads multithreading)
348# )
349# autotools-utils_src_configure
350# }
351# @CODE
279autotools-utils_src_configure() { 352autotools-utils_src_configure() {
280 debug-print-function ${FUNCNAME} "$@" 353 debug-print-function ${FUNCNAME} "$@"
281 354
282 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 355 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
283 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 356 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
284 357
358 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
359
285 # Common args 360 # Common args
286 local econfargs=() 361 local econfargs=()
362
363 _check_build_dir
364 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
365 econfargs+=(
366 --docdir="${EPREFIX}"/usr/share/doc/${PF}
367 )
368 fi
287 369
288 # Handle static-libs found in IUSE, disable them by default 370 # Handle static-libs found in IUSE, disable them by default
289 if in_iuse static-libs; then 371 if in_iuse static-libs; then
290 econfargs+=( 372 econfargs+=(
291 --enable-shared 373 --enable-shared
294 fi 376 fi
295 377
296 # Append user args 378 # Append user args
297 econfargs+=("${myeconfargs[@]}") 379 econfargs+=("${myeconfargs[@]}")
298 380
381 mkdir -p "${BUILD_DIR}" || die
382 pushd "${BUILD_DIR}" > /dev/null || die
383 econf "${econfargs[@]}" "$@"
384 popd > /dev/null || die
385}
386
387# @FUNCTION: autotools-utils_src_compile
388# @DESCRIPTION:
389# The autotools src_compile function, invokes emake in specified BUILD_DIR.
390autotools-utils_src_compile() {
391 debug-print-function ${FUNCNAME} "$@"
392
299 _check_build_dir 393 _check_build_dir
300 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
301 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 394 pushd "${BUILD_DIR}" > /dev/null || die
302 econf "${econfargs[@]}" "$@"
303 popd > /dev/null
304}
305
306# @FUNCTION: autotools-utils_src_compile
307# @DESCRIPTION:
308# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
309autotools-utils_src_compile() {
310 debug-print-function ${FUNCNAME} "$@"
311
312 _check_build_dir
313 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
314 emake "$@" || die 'emake failed' 395 emake "$@" || die 'emake failed'
315 popd > /dev/null 396 popd > /dev/null || die
316} 397}
317 398
318# @FUNCTION: autotools-utils_src_install 399# @FUNCTION: autotools-utils_src_install
319# @DESCRIPTION: 400# @DESCRIPTION:
320# The autotools src_install function. Runs emake install, unconditionally 401# The autotools src_install function. Runs emake install, unconditionally
325# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 406# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
326autotools-utils_src_install() { 407autotools-utils_src_install() {
327 debug-print-function ${FUNCNAME} "$@" 408 debug-print-function ${FUNCNAME} "$@"
328 409
329 _check_build_dir 410 _check_build_dir
330 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 411 pushd "${BUILD_DIR}" > /dev/null || die
331 emake DESTDIR="${D}" "$@" install || die "emake install failed" 412 emake DESTDIR="${D}" "$@" install || die "emake install failed"
332 popd > /dev/null 413 popd > /dev/null || die
414
415 # Move docs installed by autotools (in EAPI < 4).
416 if [[ ${EAPI} == [23] ]] \
417 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
418 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
419 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
420 else
421 mkdir "${T}"/temp-docdir
422 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
423 || die "moving docs to tempdir failed"
424
425 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
426 rm -r "${T}"/temp-docdir || die
427 fi
428 fi
333 429
334 # XXX: support installing them from builddir as well? 430 # XXX: support installing them from builddir as well?
431 if declare -p DOCS &>/dev/null; then
432 # an empty list == don't install anything
335 if [[ ${DOCS} ]]; then 433 if [[ ${DOCS[@]} ]]; then
434 if [[ ${EAPI} == [23] ]]; then
336 dodoc "${DOCS[@]}" || die "dodoc failed" 435 dodoc "${DOCS[@]}" || die
436 else
437 # dies by itself
438 dodoc -r "${DOCS[@]}"
439 fi
440 fi
441 else
442 local f
443 # same list as in PMS
444 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
445 THANKS BUGS FAQ CREDITS CHANGELOG; do
446 if [[ -s ${f} ]]; then
447 dodoc "${f}" || die "(default) dodoc ${f} failed"
448 fi
449 done
337 fi 450 fi
338 if [[ ${HTML_DOCS} ]]; then 451 if [[ ${HTML_DOCS} ]]; then
339 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed" 452 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
340 fi 453 fi
341 454
342 # Remove libtool files and unnecessary static libs 455 # Remove libtool files and unnecessary static libs
343 remove_libtool_files 456 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
457 if [[ ${prune_ltfiles} != none ]]; then
458 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
459 fi
344} 460}
345 461
346# @FUNCTION: autotools-utils_src_test 462# @FUNCTION: autotools-utils_src_test
347# @DESCRIPTION: 463# @DESCRIPTION:
348# The autotools src_test function. Runs emake check in build directory. 464# The autotools src_test function. Runs emake check in build directory.
349autotools-utils_src_test() { 465autotools-utils_src_test() {
350 debug-print-function ${FUNCNAME} "$@" 466 debug-print-function ${FUNCNAME} "$@"
351 467
352 _check_build_dir 468 _check_build_dir
353 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 469 pushd "${BUILD_DIR}" > /dev/null || die
354 # Run default src_test as defined in ebuild.sh 470
355 default_src_test 471 if make -ni check "${@}" &>/dev/null; then
472 emake check "${@}" || die 'emake check failed.'
473 elif make -ni test "${@}" &>/dev/null; then
474 emake test "${@}" || die 'emake test failed.'
475 fi
476
356 popd > /dev/null 477 popd > /dev/null || die
357} 478}

Legend:
Removed from v.1.31  
changed lines
  Added in v.1.74

  ViewVC Help
Powered by ViewVC 1.1.20