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

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20