/[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.13 Revision 1.34
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.13 2011/09/16 15:29:22 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.34 2012/01/14 14:41: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 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# The eclass will try to determine the correct autotools to run including a few
103# external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare.
104# If your tool is not supported, please open a bug and we'll add support for it.
105#
106# Note that dependencies are added for autoconf, automake and libtool only.
107# If your package needs one of the external tools listed above, you need to add
108# appropriate packages to DEPEND yourself.
109[[ ${AUTOTOOLS_AUTORECONF} ]] || _autotools_auto_dep=no
110
111AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
112inherit autotools eutils libtool
92 113
93EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 114EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
94 115
116unset _autotools_auto_dep
117
95# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 118# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
119# @DEFAULT_UNSET
96# @DESCRIPTION: 120# @DESCRIPTION:
97# Build directory, location where all autotools generated files should be 121# Build directory, location where all autotools generated files should be
98# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build. 122# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
99 123
100# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 124# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
125# @DEFAULT_UNSET
101# @DESCRIPTION: 126# @DESCRIPTION:
102# Set to enable in-source build. 127# Set to enable in-source build.
103 128
104# @ECLASS-VARIABLE: ECONF_SOURCE 129# @ECLASS-VARIABLE: ECONF_SOURCE
130# @DEFAULT_UNSET
105# @DESCRIPTION: 131# @DESCRIPTION:
106# Specify location of autotools' configure script. By default it uses ${S}. 132# Specify location of autotools' configure script. By default it uses ${S}.
107 133
108# @ECLASS-VARIABLE: myeconfargs 134# @ECLASS-VARIABLE: myeconfargs
135# @DEFAULT_UNSET
109# @DESCRIPTION: 136# @DESCRIPTION:
110# Optional econf arguments as Bash array. Should be defined before calling src_configure. 137# Optional econf arguments as Bash array. Should be defined before calling src_configure.
111# @CODE 138# @CODE
112# src_configure() { 139# src_configure() {
113# local myeconfargs=( 140# local myeconfargs=(
118# ) 145# )
119# autotools-utils_src_configure 146# autotools-utils_src_configure
120# } 147# }
121# @CODE 148# @CODE
122 149
150# @ECLASS-VARIABLE: DOCS
151# @DEFAULT_UNSET
152# @DESCRIPTION:
153# Array containing documents passed to dodoc command.
154#
155# Example:
156# @CODE
157# DOCS=( NEWS README )
158# @CODE
159
160# @ECLASS-VARIABLE: HTML_DOCS
161# @DEFAULT_UNSET
162# @DESCRIPTION:
163# Array containing documents passed to dohtml command.
164#
165# Example:
166# @CODE
167# HTML_DOCS=( doc/html/ )
168# @CODE
169
170# @ECLASS-VARIABLE: PATCHES
171# @DEFAULT_UNSET
172# @DESCRIPTION:
173# PATCHES array variable containing all various patches to be applied.
174#
175# Example:
176# @CODE
177# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
178# @CODE
179
123# Determine using IN or OUT source build 180# Determine using IN or OUT source build
124_check_build_dir() { 181_check_build_dir() {
125 : ${ECONF_SOURCE:=${S}} 182 : ${ECONF_SOURCE:=${S}}
126 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then 183 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
127 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}" 184 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
130 fi 187 fi
131 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 188 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
132} 189}
133 190
134# @FUNCTION: remove_libtool_files 191# @FUNCTION: remove_libtool_files
135# @USAGE: [all|none] 192# @USAGE: [all]
136# @DESCRIPTION: 193# @DESCRIPTION:
137# Determines unnecessary libtool files (.la) and libtool static archives (.a) 194# Determines unnecessary libtool files (.la) and libtool static archives (.a)
138# and removes them from installation image. 195# and removes them from installation image.
196#
139# To unconditionally remove all libtool files, pass 'all' as argument. 197# To unconditionally remove all libtool files, pass 'all' as argument.
140# To leave all libtool files alone, pass 'none' as argument. 198# Otherwise, libtool archives required for static linking will be preserved.
141# Unnecessary static archives are removed in any case.
142# 199#
143# In most cases it's not necessary to manually invoke this function. 200# In most cases it's not necessary to manually invoke this function.
144# See autotools-utils_src_install for reference. 201# See autotools-utils_src_install for reference.
145remove_libtool_files() { 202remove_libtool_files() {
146 debug-print-function ${FUNCNAME} "$@" 203 debug-print-function ${FUNCNAME} "$@"
204 local removing_all
205 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
206 if [[ ${#} -eq 1 ]]; then
207 case "${1}" in
208 all)
209 removing_all=1
210 ;;
211 *)
212 die "Invalid argument to ${FUNCNAME}(): ${1}"
213 esac
214 fi
215
216 local pc_libs=()
217 if [[ ! ${removing_all} ]]; then
218 local arg
219 for arg in $(find "${D}" -name '*.pc' -exec \
220 sed -n -e 's;^Libs:;;p' {} +); do
221 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
222 done
223 fi
147 224
148 local f 225 local f
149 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do 226 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}") 227 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
228 local archivefile=${f/%.la/.a}
229 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
230
231 # Remove static libs we're not supposed to link against.
152 if [[ "$1" == 'all' || -z ${shouldnotlink} ]]; then 232 if [[ ${shouldnotlink} ]]; then
153 if [[ "$1" != 'none' ]]; then
154 einfo "Removing unnecessary ${f#${D%/}}" 233 einfo "Removing unnecessary ${archivefile#${D%/}}"
155 rm -f "${f}" 234 rm -f "${archivefile}" || die
156 fi 235 # The .la file may be used by a module loader, so avoid removing it
236 # unless explicitly requested.
237 [[ ${removing_all} ]] || continue
157 fi 238 fi
158 # Remove static libs we're not supposed to link against 239
159 if [[ -n ${shouldnotlink} ]]; then 240 # Remove .la files when:
160 local remove=${f/%.la/.a} 241 # - user explicitly wants us to remove all .la files,
161 [[ "${f}" != "${remove}" ]] || die 'regex sanity check failed' 242 # - respective static archive doesn't exist,
243 # - they are covered by a .pc file already,
244 # - they don't provide any new information (no libs & no flags).
245 local removing
246 if [[ ${removing_all} ]]; then removing='forced'
247 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
248 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
249 removing='covered by .pc'
250 elif [[ ! $(sed -n -e \
251 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
252 "${f}") ]]; then removing='no libs & flags'
253 fi
254
255 if [[ ${removing} ]]; then
162 einfo "Removing unnecessary ${remove#${D%/}}" 256 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
163 rm -f "${remove}" 257 rm -f "${f}" || die
164 fi 258 fi
165 done 259 done
260
261 # check for invalid eclass use
262 # this is the most commonly used function, so do it here
263 _check_build_dir
264 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then
265 eqawarn "autotools-utils used but autotools-utils_src_configure was never called."
266 eqawarn "This is not supported and never was. Please report a bug against"
267 eqawarn "the offending ebuild. This will become a fatal error in a near future."
268 fi
269}
270
271# @FUNCTION: autotools-utils_autoreconf
272# @DESCRIPTION:
273# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
274autotools-utils_autoreconf() {
275 debug-print-function ${FUNCNAME} "$@"
276
277 # Override this func to not require unnecessary eaclocal calls.
278 autotools_check_macro() {
279 local x
280
281 # Add a few additional variants as we don't get expansions.
282 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" AC_CONFIG_HEADER
283
284 for x; do
285 grep -h "^${x}" configure.{ac,in} 2>/dev/null
286 done
287 }
288
289 einfo "Autoreconfiguring '${PWD}' ..."
290
291 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
292 configure.{ac,in} 2>/dev/null)
293 if [[ ${auxdir} ]]; then
294 auxdir=${auxdir%%]}
295 mkdir -p ${auxdir##[}
296 fi
297
298 # Support running additional tools like gnome-autogen.sh.
299 # Note: you need to add additional depends to the ebuild.
300
301 # gettext
302 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
303 echo 'no' | autotools_run_tool glib-gettextize --copy
304 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
305 eautopoint
306 fi
307
308 # intltool
309 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
310 then
311 autotools_run_tool intltoolize --copy --automake
312 fi
313
314 # gtk-doc
315 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
316 autotools_run_tool gtkdocize --copy
317 fi
318
319 # gnome-doc
320 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
321 autotools_run_tool gnome-doc-prepare --copy
322 fi
323
324 # We need to perform the check twice to know whether to run eaclocal.
325 # (_elibtoolize does that itself)
326 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
327 then
328 _elibtoolize --copy --force --install
329 else
330 eaclocal
331 fi
332
333 eautoconf
334 eautoheader
335 eautomake
336
337 local x
338 for x in $(autotools_get_subdirs); do
339 if [[ -d ${x} ]] ; then
340 pushd "${x}" >/dev/null
341 autotools-utils_eautoreconf
342 popd >/dev/null
343 fi
344 done
166} 345}
167 346
168# @FUNCTION: autotools-utils_src_prepare 347# @FUNCTION: autotools-utils_src_prepare
169# @DESCRIPTION: 348# @DESCRIPTION:
170# The src_prepare function. 349# The src_prepare function.
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 epatch_user
359
360 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
361 elibtoolize --patch-only
177} 362}
178 363
179# @FUNCTION: autotools-utils_src_configure 364# @FUNCTION: autotools-utils_src_configure
180# @DESCRIPTION: 365# @DESCRIPTION:
181# The src_configure function. For out of source build it creates build 366# The src_configure function. For out of source build it creates build
182# directory and runs econf there. Configuration parameters defined 367# directory and runs econf there. Configuration parameters defined
183# in myeconfargs are passed here to econf. Additionally following USE 368# in myeconfargs are passed here to econf. Additionally following USE
184# flags are known: 369# flags are known:
185# 370#
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 371# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
189# to econf respectively. 372# to econf respectively.
190autotools-utils_src_configure() { 373autotools-utils_src_configure() {
191 debug-print-function ${FUNCNAME} "$@" 374 debug-print-function ${FUNCNAME} "$@"
192 375
376 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
377 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
378
193 # Common args 379 # Common args
194 local econfargs=() 380 local econfargs=()
195 381
196 # Handle debug found in IUSE
197 if has debug ${IUSE//+}; then
198 econfargs+=($(use_enable debug))
199 fi
200
201 # Handle static-libs found in IUSE, disable them by default 382 # Handle static-libs found in IUSE, disable them by default
202 if has static-libs ${IUSE//+}; then 383 if in_iuse static-libs; then
203 econfargs+=( 384 econfargs+=(
204 --enable-shared 385 --enable-shared
205 $(use_enable static-libs static) 386 $(use_enable static-libs static)
206 ) 387 )
207 fi 388 fi
210 econfargs+=("${myeconfargs[@]}") 391 econfargs+=("${myeconfargs[@]}")
211 392
212 _check_build_dir 393 _check_build_dir
213 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 394 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
214 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 395 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
215 base_src_configure "${econfargs[@]}" "$@" 396 econf "${econfargs[@]}" "$@"
216 popd > /dev/null 397 popd > /dev/null
217} 398}
218 399
219# @FUNCTION: autotools-utils_src_compile 400# @FUNCTION: autotools-utils_src_compile
220# @DESCRIPTION: 401# @DESCRIPTION:
222autotools-utils_src_compile() { 403autotools-utils_src_compile() {
223 debug-print-function ${FUNCNAME} "$@" 404 debug-print-function ${FUNCNAME} "$@"
224 405
225 _check_build_dir 406 _check_build_dir
226 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 407 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
227 base_src_compile "$@" 408 emake "$@" || die 'emake failed'
228 popd > /dev/null 409 popd > /dev/null
229} 410}
230 411
231# @FUNCTION: autotools-utils_src_install 412# @FUNCTION: autotools-utils_src_install
232# @DESCRIPTION: 413# @DESCRIPTION:
239autotools-utils_src_install() { 420autotools-utils_src_install() {
240 debug-print-function ${FUNCNAME} "$@" 421 debug-print-function ${FUNCNAME} "$@"
241 422
242 _check_build_dir 423 _check_build_dir
243 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 424 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
244 base_src_install "$@" 425 emake DESTDIR="${D}" "$@" install || die "emake install failed"
245 popd > /dev/null 426 popd > /dev/null
246 427
428 # XXX: support installing them from builddir as well?
429 if [[ ${DOCS} ]]; then
430 dodoc "${DOCS[@]}" || die "dodoc failed"
431 else
432 local f
433 # same list as in PMS
434 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
435 THANKS BUGS FAQ CREDITS CHANGELOG; do
436 if [[ -s ${f} ]]; then
437 dodoc "${f}" || die "(default) dodoc ${f} failed"
438 fi
439 done
440 fi
441 if [[ ${HTML_DOCS} ]]; then
442 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
443 fi
444
247 # Remove libtool files and unnecessary static libs 445 # 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} 446 remove_libtool_files
251} 447}
252 448
253# @FUNCTION: autotools-utils_src_test 449# @FUNCTION: autotools-utils_src_test
254# @DESCRIPTION: 450# @DESCRIPTION:
255# The autotools src_test function. Runs emake check in build directory. 451# The autotools src_test function. Runs emake check in build directory.

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.34

  ViewVC Help
Powered by ViewVC 1.1.20