/[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.52
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.52 2012/05/28 07:45:19 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_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 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
208 if [[ ${#} -eq 1 ]]; then
209 case "${1}" in
210 all)
211 removing_all=1
212 ;;
213 *)
214 die "Invalid argument to ${FUNCNAME}(): ${1}"
215 esac
216 fi
217
218 local pc_libs=()
219 if [[ ! ${removing_all} ]]; then
220 local arg
221 for arg in $(find "${D}" -name '*.pc' -exec \
222 sed -n -e 's;^Libs:;;p' {} +); do
223 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
224 done
225 fi
147 226
148 local f 227 local f
149 for f in $(find "${D}" -type f -name '*.la'); do 228 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}") 229 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
152 if [[ "$1" == 'all' || -z ${shouldnotlink} ]]; then 230 local archivefile=${f/%.la/.a}
153 if [[ "$1" != 'none' ]]; then 231 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
154 echo "Removing unnecessary ${f}" 232
155 rm -f "${f}"
156 fi
157 fi
158 # Remove static libs we're not supposed to link against 233 # Remove static libs we're not supposed to link against.
159 if [[ -n ${shouldnotlink} ]]; then 234 if [[ ${shouldnotlink} ]]; then
160 local remove=${f/%.la/.a} 235 einfo "Removing unnecessary ${archivefile#${D%/}}"
161 [[ "${f}" != "${remove}" ]] || die 'regex sanity check failed' 236 rm -f "${archivefile}" || die
237 # The .la file may be used by a module loader, so avoid removing it
238 # unless explicitly requested.
239 [[ ${removing_all} ]] || continue
240 fi
241
242 # Remove .la files when:
243 # - user explicitly wants us to remove all .la files,
244 # - respective static archive doesn't exist,
245 # - they are covered by a .pc file already,
246 # - they don't provide any new information (no libs & no flags).
247 local removing
248 if [[ ${removing_all} ]]; then removing='forced'
249 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
250 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
251 removing='covered by .pc'
252 elif [[ ! $(sed -n -e \
253 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
254 "${f}") ]]; then removing='no libs & flags'
255 fi
256
257 if [[ ${removing} ]]; then
162 echo "Removing unnecessary ${remove}" 258 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
163 rm -f "${remove}" 259 rm -f "${f}" || die
260 fi
261 done
262
263 # check for invalid eclass use
264 # this is the most commonly used function, so do it here
265 _check_build_dir
266 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then
267 eqawarn "autotools-utils used but autotools-utils_src_configure was never called."
268 eqawarn "This is not supported and never was. Please report a bug against"
269 eqawarn "the offending ebuild. This will become a fatal error in a near future."
270 fi
271}
272
273# @FUNCTION: autotools-utils_autoreconf
274# @DESCRIPTION:
275# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
276autotools-utils_autoreconf() {
277 debug-print-function ${FUNCNAME} "$@"
278
279 # Override this func to not require unnecessary eaclocal calls.
280 autotools_check_macro() {
281 local x
282
283 # Add a few additional variants as we don't get expansions.
284 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
285 AC_CONFIG_HEADER AM_CONFIG_HEADER
286
287 for x; do
288 grep -h "^${x}" configure.{ac,in} 2>/dev/null
289 done
290 }
291
292 einfo "Autoreconfiguring '${PWD}' ..."
293
294 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
295 configure.{ac,in} 2>/dev/null)
296 if [[ ${auxdir} ]]; then
297 auxdir=${auxdir%%]}
298 mkdir -p ${auxdir##[}
299 fi
300
301 # Support running additional tools like gnome-autogen.sh.
302 # Note: you need to add additional depends to the ebuild.
303
304 # gettext
305 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
306 echo 'no' | autotools_run_tool glib-gettextize --copy --force
307 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
308 eautopoint --force
309 fi
310
311 # intltool
312 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
313 then
314 autotools_run_tool intltoolize --copy --automake --force
315 fi
316
317 # gtk-doc
318 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
319 autotools_run_tool gtkdocize --copy
320 fi
321
322 # gnome-doc
323 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
324 autotools_run_tool gnome-doc-prepare --copy --force
325 fi
326
327 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
328 then
329 _elibtoolize --copy --force --install
330 fi
331
332 eaclocal
333 eautoconf
334 eautoheader
335 FROM_EAUTORECONF=sure eautomake
336
337 local x
338 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
339 if [[ -d ${x} ]] ; then
340 pushd "${x}" >/dev/null || die
341 autotools-utils_autoreconf
342 popd >/dev/null || die
164 fi 343 fi
165 done 344 done
166} 345}
167 346
168# @FUNCTION: autotools-utils_src_prepare 347# @FUNCTION: autotools-utils_src_prepare
… …
171# 350#
172# 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.
173autotools-utils_src_prepare() { 352autotools-utils_src_prepare() {
174 debug-print-function ${FUNCNAME} "$@" 353 debug-print-function ${FUNCNAME} "$@"
175 354
176 base_src_prepare 355 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
356
357 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
358
359 at_checksum() {
360 find '(' -name 'Makefile.am' \
361 -o -name 'configure.ac' \
362 -o -name 'configure.in' ')' \
363 -exec cksum {} + | sort -k2
364 }
365
366 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
367 epatch_user
368 if [[ ! ${want_autoreconf} ]]; then
369 if [[ ${checksum} != $(at_checksum) ]]; then
370 einfo 'Will autoreconfigure due to user patches applied.'
371 want_autoreconf=yep
372 fi
373 fi
374
375 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
376 elibtoolize --patch-only
177} 377}
178 378
179# @FUNCTION: autotools-utils_src_configure 379# @FUNCTION: autotools-utils_src_configure
180# @DESCRIPTION: 380# @DESCRIPTION:
181# The src_configure function. For out of source build it creates build 381# The src_configure function. For out of source build it creates build
182# directory and runs econf there. Configuration parameters defined 382# directory and runs econf there. Configuration parameters defined
183# in myeconfargs are passed here to econf. Additionally following USE 383# in myeconfargs are passed here to econf. Additionally following USE
184# flags are known: 384# flags are known:
185# 385#
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 386# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
189# to econf respectively. 387# to econf respectively.
190autotools-utils_src_configure() { 388autotools-utils_src_configure() {
191 debug-print-function ${FUNCNAME} "$@" 389 debug-print-function ${FUNCNAME} "$@"
192 390
391 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
392 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
393
394 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
395
193 # Common args 396 # Common args
194 local econfargs=() 397 local econfargs=()
195 398
196 # Handle debug found in IUSE 399 _check_build_dir
197 if has debug ${IUSE//+}; then 400 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
198 econfargs+=($(use_enable debug)) 401 econfargs+=(
402 --docdir="${EPREFIX}"/usr/share/doc/${PF}
403 )
199 fi 404 fi
200 405
201 # Handle static-libs found in IUSE, disable them by default 406 # Handle static-libs found in IUSE, disable them by default
202 if has static-libs ${IUSE//+}; then 407 if in_iuse static-libs; then
203 econfargs+=( 408 econfargs+=(
204 --enable-shared 409 --enable-shared
205 $(use_enable static-libs static) 410 $(use_enable static-libs static)
206 ) 411 )
207 fi 412 fi
208 413
209 # Append user args 414 # Append user args
210 econfargs+=("${myeconfargs[@]}") 415 econfargs+=("${myeconfargs[@]}")
211 416
212 _check_build_dir
213 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 417 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
214 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 418 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
215 base_src_configure "${econfargs[@]}" "$@" 419 econf "${econfargs[@]}" "$@"
216 popd > /dev/null 420 popd > /dev/null || die
217} 421}
218 422
219# @FUNCTION: autotools-utils_src_compile 423# @FUNCTION: autotools-utils_src_compile
220# @DESCRIPTION: 424# @DESCRIPTION:
221# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 425# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
222autotools-utils_src_compile() { 426autotools-utils_src_compile() {
223 debug-print-function ${FUNCNAME} "$@" 427 debug-print-function ${FUNCNAME} "$@"
224 428
225 _check_build_dir 429 _check_build_dir
226 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 430 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
227 base_src_compile "$@" 431 emake "$@" || die 'emake failed'
228 popd > /dev/null 432 popd > /dev/null || die
229} 433}
230 434
231# @FUNCTION: autotools-utils_src_install 435# @FUNCTION: autotools-utils_src_install
232# @DESCRIPTION: 436# @DESCRIPTION:
233# The autotools src_install function. Runs emake install, unconditionally 437# The autotools src_install function. Runs emake install, unconditionally
… …
238# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 442# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
239autotools-utils_src_install() { 443autotools-utils_src_install() {
240 debug-print-function ${FUNCNAME} "$@" 444 debug-print-function ${FUNCNAME} "$@"
241 445
242 _check_build_dir 446 _check_build_dir
243 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 447 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
244 base_src_install "$@" 448 emake DESTDIR="${D}" "$@" install || die "emake install failed"
245 popd > /dev/null 449 popd > /dev/null || die
450
451 # Move docs installed by autotools (in EAPI < 4).
452 if [[ ${EAPI} == [23] ]] \
453 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
454 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
455 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
456 else
457 mkdir "${T}"/temp-docdir
458 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
459 || die "moving docs to tempdir failed"
460
461 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
462 rm -r "${T}"/temp-docdir || die
463 fi
464 fi
465
466 # XXX: support installing them from builddir as well?
467 if [[ ${DOCS} ]]; then
468 dodoc "${DOCS[@]}" || die "dodoc failed"
469 else
470 local f
471 # same list as in PMS
472 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
473 THANKS BUGS FAQ CREDITS CHANGELOG; do
474 if [[ -s ${f} ]]; then
475 dodoc "${f}" || die "(default) dodoc ${f} failed"
476 fi
477 done
478 fi
479 if [[ ${HTML_DOCS} ]]; then
480 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
481 fi
246 482
247 # Remove libtool files and unnecessary static libs 483 # Remove libtool files and unnecessary static libs
248 local args
249 has static-libs ${IUSE//+} && ! use static-libs || args='none'
250 remove_libtool_files ${args} 484 remove_libtool_files
251} 485}
252 486
253# @FUNCTION: autotools-utils_src_test 487# @FUNCTION: autotools-utils_src_test
254# @DESCRIPTION: 488# @DESCRIPTION:
255# The autotools src_test function. Runs emake check in build directory. 489# The autotools src_test function. Runs emake check in build directory.
256autotools-utils_src_test() { 490autotools-utils_src_test() {
257 debug-print-function ${FUNCNAME} "$@" 491 debug-print-function ${FUNCNAME} "$@"
258 492
259 _check_build_dir 493 _check_build_dir
260 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 494 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
261 # Run default src_test as defined in ebuild.sh 495 # Run default src_test as defined in ebuild.sh
262 default_src_test 496 default_src_test
263 popd > /dev/null 497 popd > /dev/null || die
264} 498}
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.52
  ViewVC Help
Powered by ViewVC 1.1.13