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

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.38

  ViewVC Help
Powered by ViewVC 1.1.20