/[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.27 Revision 1.33
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.27 2011/11/26 20:43:55 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.33 2012/01/09 10:16:25 jlec 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 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
87case ${EAPI:-0} in 91case ${EAPI:-0} in
88 2|3|4) ;; 92 2|3|4) ;;
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# 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.
104# If your tool is not supported, please open a bug and we'll add support for it.
105#
106# 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
108# appropriate packages to DEPEND yourself.
109[[ ${AUTOTOOLS_AUTORECONF} ]] || _autotools_auto_dep=no
110
111AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
92inherit autotools base eutils libtool 112inherit autotools eutils libtool
93 113
94EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 114EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
95 115
116unset _autotools_auto_dep
117
96# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 118# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
119# @DEFAULT_UNSET
97# @DESCRIPTION: 120# @DESCRIPTION:
98# Build directory, location where all autotools generated files should be 121# Build directory, location where all autotools generated files should be
99# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build. 122# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
100 123
101# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 124# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
125# @DEFAULT_UNSET
102# @DESCRIPTION: 126# @DESCRIPTION:
103# Set to enable in-source build. 127# Set to enable in-source build.
104 128
105# @ECLASS-VARIABLE: ECONF_SOURCE 129# @ECLASS-VARIABLE: ECONF_SOURCE
130# @DEFAULT_UNSET
106# @DESCRIPTION: 131# @DESCRIPTION:
107# Specify location of autotools' configure script. By default it uses ${S}. 132# Specify location of autotools' configure script. By default it uses ${S}.
108 133
109# @ECLASS-VARIABLE: myeconfargs 134# @ECLASS-VARIABLE: myeconfargs
135# @DEFAULT_UNSET
110# @DESCRIPTION: 136# @DESCRIPTION:
111# Optional econf arguments as Bash array. Should be defined before calling src_configure. 137# Optional econf arguments as Bash array. Should be defined before calling src_configure.
112# @CODE 138# @CODE
113# src_configure() { 139# src_configure() {
114# local myeconfargs=( 140# local myeconfargs=(
117# $(use_enable debug cnddebug) 143# $(use_enable debug cnddebug)
118# $(use_enable threads multithreading) 144# $(use_enable threads multithreading)
119# ) 145# )
120# autotools-utils_src_configure 146# autotools-utils_src_configure
121# } 147# }
148# @CODE
149
150# @ECLASS-VARIABLE: DOCS
151# @DEFAULT_UNSET
152# @DESCRIPTION:
153# Array containing documents passed to dodoc command.
154#
155# Example:
156# @CODE
157# DOCS=( NEWS README )
158# @CODE
159
160# @ECLASS-VARIABLE: HTML_DOCS
161# @DEFAULT_UNSET
162# @DESCRIPTION:
163# Array containing documents passed to dohtml command.
164#
165# Example:
166# @CODE
167# HTML_DOCS=( doc/html/ )
168# @CODE
169
170# @ECLASS-VARIABLE: PATCHES
171# @DEFAULT_UNSET
172# @DESCRIPTION:
173# PATCHES array variable containing all various patches to be applied.
174#
175# Example:
176# @CODE
177# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
122# @CODE 178# @CODE
123 179
124# Determine using IN or OUT source build 180# Determine using IN or OUT source build
125_check_build_dir() { 181_check_build_dir() {
126 : ${ECONF_SOURCE:=${S}} 182 : ${ECONF_SOURCE:=${S}}
199 if [[ ${removing} ]]; then 255 if [[ ${removing} ]]; then
200 einfo "Removing unnecessary ${f#${D%/}} (${removing})" 256 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
201 rm -f "${f}" || die 257 rm -f "${f}" || die
202 fi 258 fi
203 done 259 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}
270
271# @FUNCTION: autotools-utils_autoreconf
272# @DESCRIPTION:
273# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
274autotools-utils_autoreconf() {
275 debug-print-function ${FUNCNAME} "$@"
276
277 # Override this func to not require unnecessary eaclocal calls.
278 autotools_check_macro() {
279 local x
280
281 # Add a few additional variants as we don't get expansions.
282 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" AC_CONFIG_HEADER
283
284 for x; do
285 grep -h "^${x}" configure.{ac,in} 2>/dev/null
286 done
287 }
288
289 einfo "Autoreconfiguring '${PWD}' ..."
290
291 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
292 configure.{ac,in} 2>/dev/null)
293 if [[ ${auxdir} ]]; then
294 auxdir=${auxdir%%]}
295 mkdir -p ${auxdir##[}
296 fi
297
298 # Support running additional tools like gnome-autogen.sh.
299 # Note: you need to add additional depends to the ebuild.
300
301 # gettext
302 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
303 echo 'no' | autotools_run_tool glib-gettextize --copy
304 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
305 eautopoint
306 fi
307
308 # intltool
309 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
310 then
311 autotools_run_tool intltoolize --copy --automake
312 fi
313
314 # gtk-doc
315 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
316 autotools_run_tool gtkdocize --copy
317 fi
318
319 # gnome-doc
320 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
321 autotools_run_tool gnome-doc-prepare --copy
322 fi
323
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) ]]
327 then
328 _elibtoolize --copy --force --install
329 else
330 eaclocal
331 fi
332
333 eautoconf
334 eautoheader
335 eautomake
336
337 local x
338 for x in $(autotools_get_subdirs); do
339 if [[ -d ${x} ]] ; then
340 pushd "${x}" >/dev/null
341 autotools-utils_eautoreconf
342 popd >/dev/null
343 fi
344 done
204} 345}
205 346
206# @FUNCTION: autotools-utils_src_prepare 347# @FUNCTION: autotools-utils_src_prepare
207# @DESCRIPTION: 348# @DESCRIPTION:
208# The src_prepare function. 349# The src_prepare function.
209# 350#
210# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 351# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
211autotools-utils_src_prepare() { 352autotools-utils_src_prepare() {
212 debug-print-function ${FUNCNAME} "$@" 353 debug-print-function ${FUNCNAME} "$@"
213 354
214 base_src_prepare 355 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
356
357 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
358 epatch_user
359
360 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
215 elibtoolize --patch-only 361 elibtoolize --patch-only
216} 362}
217 363
218# @FUNCTION: autotools-utils_src_configure 364# @FUNCTION: autotools-utils_src_configure
219# @DESCRIPTION: 365# @DESCRIPTION:
244 # Append user args 390 # Append user args
245 econfargs+=("${myeconfargs[@]}") 391 econfargs+=("${myeconfargs[@]}")
246 392
247 _check_build_dir 393 _check_build_dir
248 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 394 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
249 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 395 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
250 base_src_configure "${econfargs[@]}" "$@" 396 econf "${econfargs[@]}" "$@"
251 popd > /dev/null || die 397 popd > /dev/null
252} 398}
253 399
254# @FUNCTION: autotools-utils_src_compile 400# @FUNCTION: autotools-utils_src_compile
255# @DESCRIPTION: 401# @DESCRIPTION:
256# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 402# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
257autotools-utils_src_compile() { 403autotools-utils_src_compile() {
258 debug-print-function ${FUNCNAME} "$@" 404 debug-print-function ${FUNCNAME} "$@"
259 405
260 _check_build_dir 406 _check_build_dir
261 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 407 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
262 base_src_compile "$@" 408 emake "$@" || die 'emake failed'
263 popd > /dev/null || die 409 popd > /dev/null
264} 410}
265 411
266# @FUNCTION: autotools-utils_src_install 412# @FUNCTION: autotools-utils_src_install
267# @DESCRIPTION: 413# @DESCRIPTION:
268# The autotools src_install function. Runs emake install, unconditionally 414# The autotools src_install function. Runs emake install, unconditionally
273# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 419# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
274autotools-utils_src_install() { 420autotools-utils_src_install() {
275 debug-print-function ${FUNCNAME} "$@" 421 debug-print-function ${FUNCNAME} "$@"
276 422
277 _check_build_dir 423 _check_build_dir
278 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 424 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
279 base_src_install "$@" 425 emake DESTDIR="${D}" "$@" install || die "emake install failed"
280 popd > /dev/null || die 426 popd > /dev/null
427
428 # XXX: support installing them from builddir as well?
429 if [[ ${DOCS} ]]; then
430 dodoc "${DOCS[@]}" || die "dodoc failed"
431 fi
432 if [[ ${HTML_DOCS} ]]; then
433 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
434 fi
281 435
282 # Remove libtool files and unnecessary static libs 436 # Remove libtool files and unnecessary static libs
283 remove_libtool_files 437 remove_libtool_files
284} 438}
285 439
288# The autotools src_test function. Runs emake check in build directory. 442# The autotools src_test function. Runs emake check in build directory.
289autotools-utils_src_test() { 443autotools-utils_src_test() {
290 debug-print-function ${FUNCNAME} "$@" 444 debug-print-function ${FUNCNAME} "$@"
291 445
292 _check_build_dir 446 _check_build_dir
293 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die 447 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
294 # Run default src_test as defined in ebuild.sh 448 # Run default src_test as defined in ebuild.sh
295 default_src_test 449 default_src_test
296 popd > /dev/null || die 450 popd > /dev/null
297} 451}

Legend:
Removed from v.1.27  
changed lines
  Added in v.1.33

  ViewVC Help
Powered by ViewVC 1.1.20