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

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.56

  ViewVC Help
Powered by ViewVC 1.1.20