/[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.17 Revision 1.47
1# Copyright 1999-2010 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.17 2011/09/16 15:38:13 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.47 2012/02/02 22:01:13 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>
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
56# "${FILESDIR}/${P}-unbundle_libpng.patch" 60# "${FILESDIR}/${P}-unbundle_libpng.patch"
57# ) 61# )
58# 62#
59# src_configure() { 63# src_configure() {
60# local myeconfargs=( 64# local myeconfargs=(
65# $(use_enable debug)
61# $(use_with qt4) 66# $(use_with qt4)
62# $(use_enable threads multithreading) 67# $(use_enable threads multithreading)
63# $(use_with tiff) 68# $(use_with tiff)
64# ) 69# )
65# autotools-utils_src_configure 70# autotools-utils_src_configure
86case ${EAPI:-0} in 91case ${EAPI:-0} in
87 2|3|4) ;; 92 2|3|4) ;;
88 *) die "EAPI=${EAPI} is not supported" ;; 93 *) die "EAPI=${EAPI} is not supported" ;;
89esac 94esac
90 95
91inherit autotools base 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_dep=no
115
116AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
117inherit autotools eutils libtool
92 118
93EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 119EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
94 120
121unset _autotools_auto_dep
122
95# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 123# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
124# @DEFAULT_UNSET
96# @DESCRIPTION: 125# @DESCRIPTION:
97# Build directory, location where all autotools generated files should be 126# Build directory, location where all autotools generated files should be
98# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build. 127# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
99 128
100# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 129# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130# @DEFAULT_UNSET
101# @DESCRIPTION: 131# @DESCRIPTION:
102# Set to enable in-source build. 132# Set to enable in-source build.
103 133
104# @ECLASS-VARIABLE: ECONF_SOURCE 134# @ECLASS-VARIABLE: ECONF_SOURCE
135# @DEFAULT_UNSET
105# @DESCRIPTION: 136# @DESCRIPTION:
106# Specify location of autotools' configure script. By default it uses ${S}. 137# Specify location of autotools' configure script. By default it uses ${S}.
107 138
108# @ECLASS-VARIABLE: myeconfargs 139# @ECLASS-VARIABLE: myeconfargs
140# @DEFAULT_UNSET
109# @DESCRIPTION: 141# @DESCRIPTION:
110# 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.
111# @CODE 143# @CODE
112# src_configure() { 144# src_configure() {
113# local myeconfargs=( 145# local myeconfargs=(
116# $(use_enable debug cnddebug) 148# $(use_enable debug cnddebug)
117# $(use_enable threads multithreading) 149# $(use_enable threads multithreading)
118# ) 150# )
119# autotools-utils_src_configure 151# autotools-utils_src_configure
120# } 152# }
153# @CODE
154
155# @ECLASS-VARIABLE: DOCS
156# @DEFAULT_UNSET
157# @DESCRIPTION:
158# Array containing documents passed to dodoc command.
159#
160# Example:
161# @CODE
162# DOCS=( NEWS README )
163# @CODE
164
165# @ECLASS-VARIABLE: HTML_DOCS
166# @DEFAULT_UNSET
167# @DESCRIPTION:
168# Array containing documents passed to dohtml command.
169#
170# Example:
171# @CODE
172# HTML_DOCS=( doc/html/ )
173# @CODE
174
175# @ECLASS-VARIABLE: PATCHES
176# @DEFAULT_UNSET
177# @DESCRIPTION:
178# PATCHES array variable containing all various patches to be applied.
179#
180# Example:
181# @CODE
182# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
121# @CODE 183# @CODE
122 184
123# Determine using IN or OUT source build 185# Determine using IN or OUT source build
124_check_build_dir() { 186_check_build_dir() {
125 : ${ECONF_SOURCE:=${S}} 187 : ${ECONF_SOURCE:=${S}}
154 *) 216 *)
155 die "Invalid argument to ${FUNCNAME}(): ${1}" 217 die "Invalid argument to ${FUNCNAME}(): ${1}"
156 esac 218 esac
157 fi 219 fi
158 220
221 local pc_libs=()
222 if [[ ! ${removing_all} ]]; then
223 local arg
224 for arg in $(find "${D}" -name '*.pc' -exec \
225 sed -n -e 's;^Libs:;;p' {} +); do
226 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
227 done
228 fi
229
159 local f 230 local f
160 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do 231 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
161 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}") 232 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
162 local archivefile=${f/%.la/.a} 233 local archivefile=${f/%.la/.a}
163 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed' 234 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
164 235
165 # Remove static libs we're not supposed to link against 236 # Remove static libs we're not supposed to link against.
166 if [[ ${shouldnotlink} ]]; then 237 if [[ ${shouldnotlink} ]]; then
167 einfo "Removing unnecessary ${archivefile#${D%/}}" 238 einfo "Removing unnecessary ${archivefile#${D%/}}"
168 rm -f "${archivefile}" || die 239 rm -f "${archivefile}" || die
169 # We're never going to remove the .la file. 240 # The .la file may be used by a module loader, so avoid removing it
241 # unless explicitly requested.
170 [[ ${removing_all} ]] || continue 242 [[ ${removing_all} ]] || continue
171 fi 243 fi
172 244
173 # Keep .la files when: 245 # Remove .la files when:
174 # - they have shouldnotlink=yes - likely plugins (handled above), 246 # - user explicitly wants us to remove all .la files,
175 # - respective static archive exists. 247 # - respective static archive doesn't exist,
176 if [[ ${removing_all} || ! -f ${archivefile} ]]; then 248 # - they are covered by a .pc file already,
249 # - they don't provide any new information (no libs & no flags).
250 local removing
251 if [[ ${removing_all} ]]; then removing='forced'
252 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
253 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
254 removing='covered by .pc'
255 elif [[ ! $(sed -n -e \
256 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
257 "${f}") ]]; then removing='no libs & flags'
258 fi
259
260 if [[ ${removing} ]]; then
177 einfo "Removing unnecessary ${f#${D%/}}" 261 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
178 rm -f "${f}" || die 262 rm -f "${f}" || die
179 fi 263 fi
180 done 264 done
265
266 # check for invalid eclass use
267 # this is the most commonly used function, so do it here
268 _check_build_dir
269 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then
270 eqawarn "autotools-utils used but autotools-utils_src_configure was never called."
271 eqawarn "This is not supported and never was. Please report a bug against"
272 eqawarn "the offending ebuild. This will become a fatal error in a near future."
273 fi
274}
275
276# @FUNCTION: autotools-utils_autoreconf
277# @DESCRIPTION:
278# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
279autotools-utils_autoreconf() {
280 debug-print-function ${FUNCNAME} "$@"
281
282 # Override this func to not require unnecessary eaclocal calls.
283 autotools_check_macro() {
284 local x
285
286 # Add a few additional variants as we don't get expansions.
287 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
288 AC_CONFIG_HEADER AM_CONFIG_HEADER
289
290 for x; do
291 grep -h "^${x}" configure.{ac,in} 2>/dev/null
292 done
293 }
294
295 einfo "Autoreconfiguring '${PWD}' ..."
296
297 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
298 configure.{ac,in} 2>/dev/null)
299 if [[ ${auxdir} ]]; then
300 auxdir=${auxdir%%]}
301 mkdir -p ${auxdir##[}
302 fi
303
304 # Support running additional tools like gnome-autogen.sh.
305 # Note: you need to add additional depends to the ebuild.
306
307 # gettext
308 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
309 echo 'no' | autotools_run_tool glib-gettextize --copy --force
310 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
311 eautopoint --force
312 fi
313
314 # intltool
315 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
316 then
317 autotools_run_tool intltoolize --copy --automake --force
318 fi
319
320 # gtk-doc
321 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
322 autotools_run_tool gtkdocize --copy
323 fi
324
325 # gnome-doc
326 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
327 autotools_run_tool gnome-doc-prepare --copy --force
328 fi
329
330 # We need to perform the check twice to know whether to run eaclocal.
331 # (_elibtoolize does that itself)
332 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
333 then
334 _elibtoolize --copy --force --install
335 else
336 eaclocal
337 fi
338
339 eautoconf
340 eautoheader
341 FROM_EAUTORECONF=sure eautomake
342
343 local x
344 for x in $(autotools_get_subdirs); do
345 if [[ -d ${x} ]] ; then
346 pushd "${x}" >/dev/null
347 autotools-utils_eautoreconf
348 popd >/dev/null
349 fi
350 done
181} 351}
182 352
183# @FUNCTION: autotools-utils_src_prepare 353# @FUNCTION: autotools-utils_src_prepare
184# @DESCRIPTION: 354# @DESCRIPTION:
185# The src_prepare function. 355# The src_prepare function.
186# 356#
187# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 357# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
188autotools-utils_src_prepare() { 358autotools-utils_src_prepare() {
189 debug-print-function ${FUNCNAME} "$@" 359 debug-print-function ${FUNCNAME} "$@"
190 360
191 base_src_prepare 361 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
362
363 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
364
365 at_checksum() {
366 find '(' -name 'Makefile.am' \
367 -o -name 'configure.ac' \
368 -o -name 'configure.in' ')' \
369 -exec cksum {} + | sort -k2
370 }
371
372 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
373 epatch_user
374 if [[ ! ${want_autoreconf} ]]; then
375 if [[ ${checksum} != $(at_checksum) ]]; then
376 einfo 'Will autoreconfigure due to user patches applied.'
377 want_autoreconf=yep
378 fi
379 fi
380
381 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
382 elibtoolize --patch-only
192} 383}
193 384
194# @FUNCTION: autotools-utils_src_configure 385# @FUNCTION: autotools-utils_src_configure
195# @DESCRIPTION: 386# @DESCRIPTION:
196# The src_configure function. For out of source build it creates build 387# The src_configure function. For out of source build it creates build
197# directory and runs econf there. Configuration parameters defined 388# directory and runs econf there. Configuration parameters defined
198# in myeconfargs are passed here to econf. Additionally following USE 389# in myeconfargs are passed here to econf. Additionally following USE
199# flags are known: 390# flags are known:
200# 391#
201# IUSE="debug" passes --disable-debug/--enable-debug to econf respectively.
202#
203# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static 392# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
204# to econf respectively. 393# to econf respectively.
205autotools-utils_src_configure() { 394autotools-utils_src_configure() {
206 debug-print-function ${FUNCNAME} "$@" 395 debug-print-function ${FUNCNAME} "$@"
207 396
397 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
398 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
399
400 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
401
208 # Common args 402 # Common args
209 local econfargs=() 403 local econfargs=()
210 404
211 # Handle debug found in IUSE 405 _check_build_dir
212 if has debug ${IUSE//+}; then 406 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
213 econfargs+=($(use_enable debug)) 407 econfargs+=(
408 --docdir="${EPREFIX}"/usr/share/doc/${PF}
409 )
214 fi 410 fi
215 411
216 # Handle static-libs found in IUSE, disable them by default 412 # Handle static-libs found in IUSE, disable them by default
217 if has static-libs ${IUSE//+}; then 413 if in_iuse static-libs; then
218 econfargs+=( 414 econfargs+=(
219 --enable-shared 415 --enable-shared
220 $(use_enable static-libs static) 416 $(use_enable static-libs static)
221 ) 417 )
222 fi 418 fi
223 419
224 # Append user args 420 # Append user args
225 econfargs+=("${myeconfargs[@]}") 421 econfargs+=("${myeconfargs[@]}")
226 422
227 _check_build_dir
228 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 423 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
229 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 424 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
230 base_src_configure "${econfargs[@]}" "$@" 425 econf "${econfargs[@]}" "$@"
231 popd > /dev/null 426 popd > /dev/null
232} 427}
233 428
234# @FUNCTION: autotools-utils_src_compile 429# @FUNCTION: autotools-utils_src_compile
235# @DESCRIPTION: 430# @DESCRIPTION:
237autotools-utils_src_compile() { 432autotools-utils_src_compile() {
238 debug-print-function ${FUNCNAME} "$@" 433 debug-print-function ${FUNCNAME} "$@"
239 434
240 _check_build_dir 435 _check_build_dir
241 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 436 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
242 base_src_compile "$@" 437 emake "$@" || die 'emake failed'
243 popd > /dev/null 438 popd > /dev/null
244} 439}
245 440
246# @FUNCTION: autotools-utils_src_install 441# @FUNCTION: autotools-utils_src_install
247# @DESCRIPTION: 442# @DESCRIPTION:
254autotools-utils_src_install() { 449autotools-utils_src_install() {
255 debug-print-function ${FUNCNAME} "$@" 450 debug-print-function ${FUNCNAME} "$@"
256 451
257 _check_build_dir 452 _check_build_dir
258 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 453 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
259 base_src_install "$@" 454 emake DESTDIR="${D}" "$@" install || die "emake install failed"
260 popd > /dev/null 455 popd > /dev/null
456
457 # Move docs installed by autotools (in EAPI < 4).
458 if [[ ${EAPI} == [23] ]] \
459 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
460 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
461 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
462 else
463 mkdir "${T}"/temp-docdir
464 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
465 || die "moving docs to tempdir failed"
466
467 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
468 rm -r "${T}"/temp-docdir || die
469 fi
470 fi
471
472 # XXX: support installing them from builddir as well?
473 if [[ ${DOCS} ]]; then
474 dodoc "${DOCS[@]}" || die "dodoc failed"
475 else
476 local f
477 # same list as in PMS
478 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
479 THANKS BUGS FAQ CREDITS CHANGELOG; do
480 if [[ -s ${f} ]]; then
481 dodoc "${f}" || die "(default) dodoc ${f} failed"
482 fi
483 done
484 fi
485 if [[ ${HTML_DOCS} ]]; then
486 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
487 fi
261 488
262 # Remove libtool files and unnecessary static libs 489 # Remove libtool files and unnecessary static libs
263 remove_libtool_files 490 remove_libtool_files
264} 491}
265 492

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.47

  ViewVC Help
Powered by ViewVC 1.1.20