/[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.11 Revision 1.75
1# Copyright 1999-2010 Gentoo Foundation 1# Copyright 1999-2015 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.11 2011/09/12 20:32:41 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.75 2015/06/07 12:55:46 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
31# IUSE="debug doc examples qt4 static-libs tiff" 35# IUSE="debug doc examples qt4 static-libs tiff"
32# 36#
33# CDEPEND=" 37# CDEPEND="
34# media-libs/libpng:0 38# media-libs/libpng:0
35# qt4? ( 39# qt4? (
36# x11-libs/qt-core:4 40# dev-qt/qtcore:4
37# x11-libs/qt-gui:4 41# dev-qt/qtgui:4
38# ) 42# )
39# tiff? ( media-libs/tiff:0 ) 43# tiff? ( media-libs/tiff:0 )
40# " 44# "
41# RDEPEND="${CDEPEND} 45# RDEPEND="${CDEPEND}
42# !media-gfx/bar 46# !media-gfx/bar
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
69# autotools-utils_src_compile 74# autotools-utils_src_compile
70# use doc && autotools-utils_src_compile docs 75# use doc && autotools-utils_src_compile docs
71# } 76# }
72# 77#
73# src_install() { 78# src_install() {
74# use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/") 79# use doc && HTML_DOCS=("${BUILD_DIR}/apidocs/html/")
75# autotools-utils_src_install 80# autotools-utils_src_install
76# if use examples; then 81# if use examples; then
77# dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\ 82# dobin "${BUILD_DIR}"/foo_example{1,2,3} \\
78# || die 'dobin examples failed' 83# || die 'dobin examples failed'
79# fi 84# fi
80# } 85# }
81# 86#
82# @CODE 87# @CODE
83 88
84# 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!
85 90
86case ${EAPI:-0} in 91case ${EAPI:-0} in
87 2|3|4) ;; 92 2|3|4|5) ;;
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 before calling inherit 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: 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.
125#
126# This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127# It is set under that name for compatibility.
99 128
100# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD 129# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130# @DEFAULT_UNSET
101# @DESCRIPTION: 131# @DESCRIPTION:
102# Set to enable in-source build. 132# Set to enable in-source build.
103 133
104# @ECLASS-VARIABLE: ECONF_SOURCE 134# @ECLASS-VARIABLE: ECONF_SOURCE
135# @DEFAULT_UNSET
105# @DESCRIPTION: 136# @DESCRIPTION:
106# Specify location of autotools' configure script. By default it uses ${S}. 137# Specify location of autotools' configure script. By default it uses ${S}.
107 138
139# @ECLASS-VARIABLE: DOCS
140# @DEFAULT_UNSET
141# @DESCRIPTION:
142# Array containing documents passed to dodoc command.
143#
144# In EAPIs 4+, can list directories as well.
145#
146# Example:
147# @CODE
148# DOCS=( NEWS README )
149# @CODE
150
151# @ECLASS-VARIABLE: HTML_DOCS
152# @DEFAULT_UNSET
153# @DESCRIPTION:
154# Array containing documents passed to dohtml command.
155#
156# Example:
157# @CODE
158# HTML_DOCS=( doc/html/ )
159# @CODE
160
161# @ECLASS-VARIABLE: PATCHES
162# @DEFAULT_UNSET
163# @DESCRIPTION:
164# PATCHES array variable containing all various patches to be applied.
165#
166# Example:
167# @CODE
168# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
169# @CODE
170
171# @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
172# @DEFAULT_UNSET
173# @DESCRIPTION:
174# Sets the mode of pruning libtool files. The values correspond to
175# prune_libtool_files parameters, with leading dashes stripped.
176#
177# Defaults to pruning the libtool files when static libraries are not
178# installed or can be linked properly without them. Libtool files
179# for modules (plugins) will be kept in case plugin loader needs them.
180#
181# If set to 'modules', the .la files for modules will be removed
182# as well. This is often the preferred option.
183#
184# If set to 'all', all .la files will be removed unconditionally. This
185# option is discouraged and shall be used only if 'modules' does not
186# remove the files.
187#
188# If set to 'none', no .la files will be pruned ever. Use in corner
189# cases only.
190
191# Determine using IN or OUT source build
192_check_build_dir() {
193 : ${ECONF_SOURCE:=${S}}
194 # Respect both the old variable and the new one, depending
195 # on which one was set by the ebuild.
196 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
197 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
198 eqawarn "Please migrate the ebuild to use the new one."
199
200 # In the next call, both variables will be set already
201 # and we'd have to know which one takes precedence.
202 _RESPECT_AUTOTOOLS_BUILD_DIR=1
203 fi
204
205 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
206 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
207 else
208 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
209 : ${BUILD_DIR:=${ECONF_SOURCE}}
210 else
211 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
212 fi
213 fi
214
215 # Backwards compatibility for getting the value.
216 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
217 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
218}
219
220# @FUNCTION: autotools-utils_src_prepare
221# @DESCRIPTION:
222# The src_prepare function.
223#
224# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
225autotools-utils_src_prepare() {
226 debug-print-function ${FUNCNAME} "$@"
227
228 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
229
230 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
231
232 at_checksum() {
233 find '(' -name 'Makefile.am' \
234 -o -name 'configure.ac' \
235 -o -name 'configure.in' ')' \
236 -exec cksum {} + | sort -k2
237 }
238
239 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
240 epatch_user
241 if [[ ! ${want_autoreconf} ]]; then
242 if [[ ${checksum} != $(at_checksum) ]]; then
243 einfo 'Will autoreconfigure due to user patches applied.'
244 want_autoreconf=yep
245 fi
246 fi
247
248 [[ ${want_autoreconf} ]] && eautoreconf
249 elibtoolize --patch-only
250}
251
252# @FUNCTION: autotools-utils_src_configure
253# @DESCRIPTION:
254# The src_configure function. For out of source build it creates build
255# directory and runs econf there. Configuration parameters defined
256# in myeconfargs are passed here to econf. Additionally following USE
257# flags are known:
258#
259# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
260# to econf respectively.
261
108# @ECLASS-VARIABLE: myeconfargs 262# @VARIABLE: myeconfargs
263# @DEFAULT_UNSET
109# @DESCRIPTION: 264# @DESCRIPTION:
110# Optional econf arguments as Bash array. Should be defined before calling src_configure. 265# Optional econf arguments as Bash array. Should be defined before calling src_configure.
111# @CODE 266# @CODE
112# src_configure() { 267# src_configure() {
113# local myeconfargs=( 268# local myeconfargs=(
117# $(use_enable threads multithreading) 272# $(use_enable threads multithreading)
118# ) 273# )
119# autotools-utils_src_configure 274# autotools-utils_src_configure
120# } 275# }
121# @CODE 276# @CODE
122
123# Determine using IN or OUT source build
124_check_build_dir() {
125 : ${ECONF_SOURCE:=${S}}
126 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
127 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
128 else
129 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build}
130 fi
131 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
132}
133
134# @FUNCTION: remove_libtool_files
135# @USAGE: [all|none]
136# @DESCRIPTION:
137# Determines unnecessary libtool files (.la) and libtool static archives (.a)
138# and removes them from installation image.
139# To unconditionally remove all libtool files, pass 'all' as argument.
140# To leave all libtool files alone, pass 'none' as argument.
141# Unnecessary static archives are removed in any case.
142#
143# In most cases it's not necessary to manually invoke this function.
144# See autotools-utils_src_install for reference.
145remove_libtool_files() {
146 debug-print-function ${FUNCNAME} "$@"
147
148 local f
149 for f in $(find "${D}" -type f -name '*.la'); do
150 # Keep only .la files with shouldnotlink=yes - likely plugins
151 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
152 if [[ "$1" == 'all' || -z ${shouldnotlink} ]]; then
153 if [[ "$1" != 'none' ]]; then
154 einfo "Removing unnecessary ${f}"
155 rm -f "${f}"
156 fi
157 fi
158 # Remove static libs we're not supposed to link against
159 if [[ -n ${shouldnotlink} ]]; then
160 local remove=${f/%.la/.a}
161 [[ "${f}" != "${remove}" ]] || die 'regex sanity check failed'
162 einfo "Removing unnecessary ${remove}"
163 rm -f "${remove}"
164 fi
165 done
166}
167
168# @FUNCTION: autotools-utils_src_prepare
169# @DESCRIPTION:
170# The src_prepare function.
171#
172# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
173autotools-utils_src_prepare() {
174 debug-print-function ${FUNCNAME} "$@"
175
176 base_src_prepare
177}
178
179# @FUNCTION: autotools-utils_src_configure
180# @DESCRIPTION:
181# The src_configure function. For out of source build it creates build
182# directory and runs econf there. Configuration parameters defined
183# in myeconfargs are passed here to econf. Additionally following USE
184# flags are known:
185#
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
189# to econf respectively.
190autotools-utils_src_configure() { 277autotools-utils_src_configure() {
191 debug-print-function ${FUNCNAME} "$@" 278 debug-print-function ${FUNCNAME} "$@"
192 279
280 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
281 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
282
283 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
284
193 # Common args 285 # Common args
194 local econfargs=() 286 local econfargs=()
195 287
196 # Handle debug found in IUSE 288 _check_build_dir
197 if has debug ${IUSE//+}; then 289 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
198 econfargs+=($(use_enable debug)) 290 econfargs+=(
291 --docdir="${EPREFIX}"/usr/share/doc/${PF}
292 )
199 fi 293 fi
200 294
201 # Handle static-libs found in IUSE, disable them by default 295 # Handle static-libs found in IUSE, disable them by default
202 if has static-libs ${IUSE//+}; then 296 if in_iuse static-libs; then
203 econfargs+=( 297 econfargs+=(
204 --enable-shared 298 --enable-shared
205 $(use_enable static-libs static) 299 $(use_enable static-libs static)
206 ) 300 )
207 fi 301 fi
208 302
209 # Append user args 303 # Append user args
210 econfargs+=("${myeconfargs[@]}") 304 econfargs+=("${myeconfargs[@]}")
211 305
212 _check_build_dir 306 mkdir -p "${BUILD_DIR}" || die
213 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
214 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 307 pushd "${BUILD_DIR}" > /dev/null || die
215 base_src_configure "${econfargs[@]}" "$@" 308 econf "${econfargs[@]}" "$@"
216 popd > /dev/null 309 popd > /dev/null || die
217} 310}
218 311
219# @FUNCTION: autotools-utils_src_compile 312# @FUNCTION: autotools-utils_src_compile
220# @DESCRIPTION: 313# @DESCRIPTION:
221# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 314# The autotools src_compile function, invokes emake in specified BUILD_DIR.
222autotools-utils_src_compile() { 315autotools-utils_src_compile() {
223 debug-print-function ${FUNCNAME} "$@" 316 debug-print-function ${FUNCNAME} "$@"
224 317
225 _check_build_dir 318 _check_build_dir
226 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 319 pushd "${BUILD_DIR}" > /dev/null || die
227 base_src_compile "$@" 320 emake "$@" || die 'emake failed'
228 popd > /dev/null 321 popd > /dev/null || die
229} 322}
230 323
231# @FUNCTION: autotools-utils_src_install 324# @FUNCTION: autotools-utils_src_install
232# @DESCRIPTION: 325# @DESCRIPTION:
233# The autotools src_install function. Runs emake install, unconditionally 326# The autotools src_install function. Runs emake install, unconditionally
238# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 331# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
239autotools-utils_src_install() { 332autotools-utils_src_install() {
240 debug-print-function ${FUNCNAME} "$@" 333 debug-print-function ${FUNCNAME} "$@"
241 334
242 _check_build_dir 335 _check_build_dir
243 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 336 pushd "${BUILD_DIR}" > /dev/null || die
244 base_src_install "$@" 337 emake DESTDIR="${D}" "$@" install || die "emake install failed"
245 popd > /dev/null 338 popd > /dev/null || die
339
340 # Move docs installed by autotools (in EAPI < 4).
341 if [[ ${EAPI} == [23] ]] \
342 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
343 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
344 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
345 else
346 mkdir "${T}"/temp-docdir
347 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
348 || die "moving docs to tempdir failed"
349
350 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
351 rm -r "${T}"/temp-docdir || die
352 fi
353 fi
354
355 # XXX: support installing them from builddir as well?
356 if declare -p DOCS &>/dev/null; then
357 # an empty list == don't install anything
358 if [[ ${DOCS[@]} ]]; then
359 if [[ ${EAPI} == [23] ]]; then
360 dodoc "${DOCS[@]}" || die
361 else
362 # dies by itself
363 dodoc -r "${DOCS[@]}"
364 fi
365 fi
366 else
367 local f
368 # same list as in PMS
369 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
370 THANKS BUGS FAQ CREDITS CHANGELOG; do
371 if [[ -s ${f} ]]; then
372 dodoc "${f}" || die "(default) dodoc ${f} failed"
373 fi
374 done
375 fi
376 if [[ ${HTML_DOCS} ]]; then
377 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
378 fi
246 379
247 # Remove libtool files and unnecessary static libs 380 # Remove libtool files and unnecessary static libs
248 local args 381 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
249 has static-libs ${IUSE//+} && ! use static-libs || args='none' 382 if [[ ${prune_ltfiles} != none ]]; then
250 remove_libtool_files ${args} 383 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
384 fi
251} 385}
252 386
253# @FUNCTION: autotools-utils_src_test 387# @FUNCTION: autotools-utils_src_test
254# @DESCRIPTION: 388# @DESCRIPTION:
255# The autotools src_test function. Runs emake check in build directory. 389# The autotools src_test function. Runs emake check in build directory.
256autotools-utils_src_test() { 390autotools-utils_src_test() {
257 debug-print-function ${FUNCNAME} "$@" 391 debug-print-function ${FUNCNAME} "$@"
258 392
259 _check_build_dir 393 _check_build_dir
260 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 394 pushd "${BUILD_DIR}" > /dev/null || die
261 # Run default src_test as defined in ebuild.sh 395
262 default_src_test 396 if make -ni check "${@}" &>/dev/null; then
397 emake check "${@}" || die 'emake check failed.'
398 elif make -ni test "${@}" &>/dev/null; then
399 emake test "${@}" || die 'emake test failed.'
400 fi
401
263 popd > /dev/null 402 popd > /dev/null || die
264} 403}

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.75

  ViewVC Help
Powered by ViewVC 1.1.20