/[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.74
1# Copyright 1999-2010 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.23 2011/09/18 21:03:59 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>
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
31# IUSE="debug doc examples qt4 static-libs tiff" 35# IUSE="debug doc examples qt4 static-libs tiff"
32# 36#
33# CDEPEND=" 37# CDEPEND="
34# media-libs/libpng:0 38# media-libs/libpng:0
35# qt4? ( 39# qt4? (
36# x11-libs/qt-core:4 40# dev-qt/qtcore:4
37# x11-libs/qt-gui:4 41# dev-qt/qtgui:4
38# ) 42# )
39# tiff? ( media-libs/tiff:0 ) 43# tiff? ( media-libs/tiff:0 )
40# " 44# "
41# RDEPEND="${CDEPEND} 45# RDEPEND="${CDEPEND}
42# !media-gfx/bar 46# !media-gfx/bar
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 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
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: DOCS
140# @DEFAULT_UNSET
110# @DESCRIPTION: 141# @DESCRIPTION:
111# Optional econf arguments as Bash array. Should be defined before calling src_configure. 142# Array containing documents passed to dodoc command.
143#
144# In EAPIs 4+, can list directories as well.
145#
146# Example:
112# @CODE 147# @CODE
113# src_configure() { 148# DOCS=( NEWS README )
114# local myeconfargs=(
115# --disable-readline
116# --with-confdir="/etc/nasty foo confdir/"
117# $(use_enable debug cnddebug)
118# $(use_enable threads multithreading)
119# )
120# autotools-utils_src_configure
121# }
122# @CODE 149# @CODE
150
151# @ECLASS-VARIABLE: HTML_DOCS
152# @DEFAULT_UNSET
153# @DESCRIPTION:
154# Array containing documents passed to dohtml command.
155#
156# Example:
157# @CODE
158# HTML_DOCS=( doc/html/ )
159# @CODE
160
161# @ECLASS-VARIABLE: PATCHES
162# @DEFAULT_UNSET
163# @DESCRIPTION:
164# PATCHES array variable containing all various patches to be applied.
165#
166# Example:
167# @CODE
168# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
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.
123 190
124# Determine using IN or OUT source build 191# Determine using IN or OUT source build
125_check_build_dir() { 192_check_build_dir() {
126 : ${ECONF_SOURCE:=${S}} 193 : ${ECONF_SOURCE:=${S}}
127 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 194 # Respect both the old variable and the new one, depending
128 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}
129 else 207 else
208 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
209 : ${BUILD_DIR:=${ECONF_SOURCE}}
210 else
130 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build} 211 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
131 fi 212 fi
213 fi
214
215 # Backwards compatibility for getting the value.
216 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
132 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 217 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
133} 218}
134 219
135# @FUNCTION: remove_libtool_files 220# @FUNCTION: remove_libtool_files
136# @USAGE: [all] 221# @USAGE: [all]
137# @DESCRIPTION: 222# @DESCRIPTION:
144# 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.
145# See autotools-utils_src_install for reference. 230# See autotools-utils_src_install for reference.
146remove_libtool_files() { 231remove_libtool_files() {
147 debug-print-function ${FUNCNAME} "$@" 232 debug-print-function ${FUNCNAME} "$@"
148 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
149 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()" 238 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
150 if [[ ${#} -eq 1 ]]; then 239 if [[ ${#} -eq 1 ]]; then
151 case "${1}" in 240 case "${1}" in
152 all) 241 all)
153 removing_all=1 242 removing_all=1
209# 298#
210# 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.
211autotools-utils_src_prepare() { 300autotools-utils_src_prepare() {
212 debug-print-function ${FUNCNAME} "$@" 301 debug-print-function ${FUNCNAME} "$@"
213 302
214 base_src_prepare 303 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
304
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)
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
322
323 [[ ${want_autoreconf} ]] && eautoreconf
324 elibtoolize --patch-only
215} 325}
216 326
217# @FUNCTION: autotools-utils_src_configure 327# @FUNCTION: autotools-utils_src_configure
218# @DESCRIPTION: 328# @DESCRIPTION:
219# The src_configure function. For out of source build it creates build 329# The src_configure function. For out of source build it creates build
221# in myeconfargs are passed here to econf. Additionally following USE 331# in myeconfargs are passed here to econf. Additionally following USE
222# flags are known: 332# flags are known:
223# 333#
224# 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
225# 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
226autotools-utils_src_configure() { 352autotools-utils_src_configure() {
227 debug-print-function ${FUNCNAME} "$@" 353 debug-print-function ${FUNCNAME} "$@"
228 354
229 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \ 355 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
230 || die 'autotools-utils.eclass: myeconfargs has to be an array.' 356 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
231 357
358 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
359
232 # Common args 360 # Common args
233 local econfargs=() 361 local econfargs=()
234 362
235 # Handle debug found in IUSE 363 _check_build_dir
236 if has debug ${IUSE//+}; then 364 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
237 local debugarg=$(use_enable debug) 365 econfargs+=(
238 if ! has "${debugarg}" "${myeconfargs[@]}"; then 366 --docdir="${EPREFIX}"/usr/share/doc/${PF}
239 eqawarn 'Implicit $(use_enable debug) for IUSE="debug" is no longer supported.' 367 )
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 368 fi
244 369
245 # Handle static-libs found in IUSE, disable them by default 370 # Handle static-libs found in IUSE, disable them by default
246 if has static-libs ${IUSE//+}; then 371 if in_iuse static-libs; then
247 econfargs+=( 372 econfargs+=(
248 --enable-shared 373 --enable-shared
249 $(use_enable static-libs static) 374 $(use_enable static-libs static)
250 ) 375 )
251 fi 376 fi
252 377
253 # Append user args 378 # Append user args
254 econfargs+=("${myeconfargs[@]}") 379 econfargs+=("${myeconfargs[@]}")
255 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
256 _check_build_dir 393 _check_build_dir
257 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
258 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 394 pushd "${BUILD_DIR}" > /dev/null || die
259 base_src_configure "${econfargs[@]}" "$@" 395 emake "$@" || die 'emake failed'
260 popd > /dev/null 396 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} 397}
274 398
275# @FUNCTION: autotools-utils_src_install 399# @FUNCTION: autotools-utils_src_install
276# @DESCRIPTION: 400# @DESCRIPTION:
277# The autotools src_install function. Runs emake install, unconditionally 401# The autotools src_install function. Runs emake install, unconditionally
282# 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.
283autotools-utils_src_install() { 407autotools-utils_src_install() {
284 debug-print-function ${FUNCNAME} "$@" 408 debug-print-function ${FUNCNAME} "$@"
285 409
286 _check_build_dir 410 _check_build_dir
287 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 411 pushd "${BUILD_DIR}" > /dev/null || die
288 base_src_install "$@" 412 emake DESTDIR="${D}" "$@" install || die "emake install failed"
289 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
429
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
433 if [[ ${DOCS[@]} ]]; then
434 if [[ ${EAPI} == [23] ]]; then
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
450 fi
451 if [[ ${HTML_DOCS} ]]; then
452 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
453 fi
290 454
291 # Remove libtool files and unnecessary static libs 455 # Remove libtool files and unnecessary static libs
292 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
293} 460}
294 461
295# @FUNCTION: autotools-utils_src_test 462# @FUNCTION: autotools-utils_src_test
296# @DESCRIPTION: 463# @DESCRIPTION:
297# The autotools src_test function. Runs emake check in build directory. 464# The autotools src_test function. Runs emake check in build directory.
298autotools-utils_src_test() { 465autotools-utils_src_test() {
299 debug-print-function ${FUNCNAME} "$@" 466 debug-print-function ${FUNCNAME} "$@"
300 467
301 _check_build_dir 468 _check_build_dir
302 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 469 pushd "${BUILD_DIR}" > /dev/null || die
303 # Run default src_test as defined in ebuild.sh 470
304 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
305 popd > /dev/null 477 popd > /dev/null || die
306} 478}

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

  ViewVC Help
Powered by ViewVC 1.1.20