/[gentoo-x86]/eclass/autotools-utils.eclass
Gentoo

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.73 - (hide annotations) (download)
Tue Mar 11 23:55:44 2014 UTC (5 months, 1 week ago) by floppym
Branch: MAIN
Changes since 1.72: +3 -3 lines
Indicate that AUTOTOOLS_AUTORECONF should be set before calling inherit.

1 floppym 1.73 # Copyright 1999-2014 Gentoo Foundation
2 reavertm 1.1 # Distributed under the terms of the GNU General Public License v2
3 floppym 1.73 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.72 2013/11/24 10:53:13 mgorny Exp $
4 reavertm 1.1
5     # @ECLASS: autotools-utils.eclass
6     # @MAINTAINER:
7     # Maciej Mrozowski <reavertm@gentoo.org>
8 reavertm 1.10 # Michał Górny <mgorny@gentoo.org>
9 reavertm 1.1 # @BLURB: common ebuild functions for autotools-based packages
10     # @DESCRIPTION:
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,
13     # out of source build with overridable build dir location, static archives
14 mgorny 1.28 # handling, libtool files removal.
15     #
16 mgorny 1.56 # Please note that autotools-utils does not support mixing of its phase
17 mgorny 1.28 # functions with regular econf/emake calls. If necessary, please call
18     # autotools-utils_src_compile instead of the latter.
19 reavertm 1.1 #
20     # @EXAMPLE:
21     # Typical ebuild using autotools-utils.eclass:
22     #
23     # @CODE
24     # EAPI="2"
25     #
26     # inherit autotools-utils
27     #
28     # DESCRIPTION="Foo bar application"
29     # HOMEPAGE="http://example.org/foo/"
30     # SRC_URI="mirror://sourceforge/foo/${P}.tar.bz2"
31     #
32     # LICENSE="LGPL-2.1"
33     # KEYWORDS=""
34     # SLOT="0"
35     # IUSE="debug doc examples qt4 static-libs tiff"
36     #
37     # CDEPEND="
38     # media-libs/libpng:0
39     # qt4? (
40 pesa 1.63 # dev-qt/qtcore:4
41     # dev-qt/qtgui:4
42 reavertm 1.1 # )
43     # tiff? ( media-libs/tiff:0 )
44     # "
45     # RDEPEND="${CDEPEND}
46     # !media-gfx/bar
47     # "
48     # DEPEND="${CDEPEND}
49     # doc? ( app-doc/doxygen )
50     # "
51     #
52     # # bug 123456
53     # AUTOTOOLS_IN_SOURCE_BUILD=1
54     #
55     # DOCS=(AUTHORS ChangeLog README "Read me.txt" TODO)
56     #
57     # PATCHES=(
58     # "${FILESDIR}/${P}-gcc44.patch" # bug 123458
59     # "${FILESDIR}/${P}-as-needed.patch"
60     # "${FILESDIR}/${P}-unbundle_libpng.patch"
61     # )
62     #
63     # src_configure() {
64 reavertm 1.6 # local myeconfargs=(
65 mgorny 1.23 # $(use_enable debug)
66 reavertm 1.1 # $(use_with qt4)
67     # $(use_enable threads multithreading)
68     # $(use_with tiff)
69     # )
70     # autotools-utils_src_configure
71     # }
72     #
73     # src_compile() {
74     # autotools-utils_src_compile
75     # use doc && autotools-utils_src_compile docs
76     # }
77     #
78     # src_install() {
79 mgorny 1.58 # use doc && HTML_DOCS=("${BUILD_DIR}/apidocs/html/")
80 reavertm 1.1 # autotools-utils_src_install
81     # if use examples; then
82 mgorny 1.58 # dobin "${BUILD_DIR}"/foo_example{1,2,3} \\
83 reavertm 1.1 # || die 'dobin examples failed'
84     # fi
85     # }
86     #
87     # @CODE
88    
89     # Keep variable names synced with cmake-utils and the other way around!
90    
91     case ${EAPI:-0} in
92 axs 1.57 2|3|4|5) ;;
93 reavertm 1.2 *) die "EAPI=${EAPI} is not supported" ;;
94 reavertm 1.1 esac
95    
96 mgorny 1.32 # @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
97 jlec 1.33 # @DEFAULT_UNSET
98 mgorny 1.32 # @DESCRIPTION:
99 floppym 1.73 # Set to a non-empty value before calling inherit to enable running autoreconf
100 mgorny 1.32 # in src_prepare() and adding autotools dependencies.
101     #
102 mgorny 1.37 # 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 mgorny 1.32 # 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 mgorny 1.51 [[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no}
115 mgorny 1.32
116 mgorny 1.30 inherit autotools eutils libtool
117 reavertm 1.1
118     EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
119    
120 mgorny 1.58 # @ECLASS-VARIABLE: BUILD_DIR
121 mgorny 1.30 # @DEFAULT_UNSET
122 reavertm 1.1 # @DESCRIPTION:
123     # Build directory, location where all autotools generated files should be
124     # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
125 mgorny 1.58 #
126     # This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127     # It is set under that name for compatibility.
128 reavertm 1.1
129     # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130 mgorny 1.30 # @DEFAULT_UNSET
131 reavertm 1.1 # @DESCRIPTION:
132     # Set to enable in-source build.
133    
134     # @ECLASS-VARIABLE: ECONF_SOURCE
135 mgorny 1.30 # @DEFAULT_UNSET
136 reavertm 1.1 # @DESCRIPTION:
137     # Specify location of autotools' configure script. By default it uses ${S}.
138    
139 mgorny 1.30 # @ECLASS-VARIABLE: DOCS
140     # @DEFAULT_UNSET
141     # @DESCRIPTION:
142     # Array containing documents passed to dodoc command.
143     #
144 mgorny 1.61 # In EAPIs 4+, can list directories as well.
145     #
146 mgorny 1.30 # 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 mgorny 1.64 # @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
172 mgorny 1.65 # @DEFAULT_UNSET
173 mgorny 1.64 # @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 mgorny 1.67 #
188     # If set to 'none', no .la files will be pruned ever. Use in corner
189     # cases only.
190 mgorny 1.64
191 reavertm 1.1 # Determine using IN or OUT source build
192     _check_build_dir() {
193     : ${ECONF_SOURCE:=${S}}
194 mgorny 1.72 # 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 reavertm 1.1 else
208 mgorny 1.72 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
209     : ${BUILD_DIR:=${ECONF_SOURCE}}
210 mgorny 1.60 else
211     : ${BUILD_DIR:=${WORKDIR}/${P}_build}
212 mgorny 1.59 fi
213 reavertm 1.1 fi
214 mgorny 1.58
215 mgorny 1.59 # Backwards compatibility for getting the value.
216 mgorny 1.58 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
217     echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
218 reavertm 1.1 }
219    
220     # @FUNCTION: remove_libtool_files
221 mgorny 1.14 # @USAGE: [all]
222 reavertm 1.1 # @DESCRIPTION:
223     # Determines unnecessary libtool files (.la) and libtool static archives (.a)
224     # and removes them from installation image.
225 mgorny 1.14 #
226 reavertm 1.1 # To unconditionally remove all libtool files, pass 'all' as argument.
227 mgorny 1.14 # Otherwise, libtool archives required for static linking will be preserved.
228 reavertm 1.1 #
229     # In most cases it's not necessary to manually invoke this function.
230     # See autotools-utils_src_install for reference.
231     remove_libtool_files() {
232     debug-print-function ${FUNCNAME} "$@"
233 mgorny 1.16 local removing_all
234 mgorny 1.54
235     eqawarn "The remove_libtool_files() function was deprecated."
236     eqawarn "Please use prune_libtool_files() from eutils eclass instead."
237    
238 mgorny 1.16 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
239     if [[ ${#} -eq 1 ]]; then
240     case "${1}" in
241     all)
242     removing_all=1
243     ;;
244     *)
245     die "Invalid argument to ${FUNCNAME}(): ${1}"
246     esac
247     fi
248 reavertm 1.1
249 mgorny 1.19 local pc_libs=()
250     if [[ ! ${removing_all} ]]; then
251     local arg
252     for arg in $(find "${D}" -name '*.pc' -exec \
253     sed -n -e 's;^Libs:;;p' {} +); do
254     [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
255     done
256     fi
257    
258 reavertm 1.1 local f
259 mgorny 1.12 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
260 reavertm 1.1 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
261 mgorny 1.14 local archivefile=${f/%.la/.a}
262 mgorny 1.15 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
263 mgorny 1.14
264 mgorny 1.18 # Remove static libs we're not supposed to link against.
265 mgorny 1.17 if [[ ${shouldnotlink} ]]; then
266     einfo "Removing unnecessary ${archivefile#${D%/}}"
267     rm -f "${archivefile}" || die
268 mgorny 1.18 # The .la file may be used by a module loader, so avoid removing it
269     # unless explicitly requested.
270 mgorny 1.17 [[ ${removing_all} ]] || continue
271     fi
272    
273 mgorny 1.18 # Remove .la files when:
274     # - user explicitly wants us to remove all .la files,
275     # - respective static archive doesn't exist,
276 mgorny 1.19 # - they are covered by a .pc file already,
277 mgorny 1.18 # - they don't provide any new information (no libs & no flags).
278     local removing
279 mgorny 1.20 if [[ ${removing_all} ]]; then removing='forced'
280     elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
281     elif has "$(basename "${f}")" "${pc_libs[@]}"; then
282     removing='covered by .pc'
283 mgorny 1.18 elif [[ ! $(sed -n -e \
284     "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
285 mgorny 1.20 "${f}") ]]; then removing='no libs & flags'
286 mgorny 1.18 fi
287    
288     if [[ ${removing} ]]; then
289 mgorny 1.20 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
290 mgorny 1.15 rm -f "${f}" || die
291 reavertm 1.1 fi
292     done
293     }
294    
295     # @FUNCTION: autotools-utils_src_prepare
296     # @DESCRIPTION:
297     # The src_prepare function.
298     #
299     # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
300     autotools-utils_src_prepare() {
301     debug-print-function ${FUNCNAME} "$@"
302    
303 mgorny 1.32 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
304    
305 mgorny 1.45 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
306    
307 mgorny 1.47 at_checksum() {
308     find '(' -name 'Makefile.am' \
309     -o -name 'configure.ac' \
310     -o -name 'configure.in' ')' \
311     -exec cksum {} + | sort -k2
312     }
313    
314     [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
315 mgorny 1.30 epatch_user
316 mgorny 1.37 if [[ ! ${want_autoreconf} ]]; then
317 mgorny 1.47 if [[ ${checksum} != $(at_checksum) ]]; then
318 mgorny 1.45 einfo 'Will autoreconfigure due to user patches applied.'
319 mgorny 1.37 want_autoreconf=yep
320     fi
321     fi
322 mgorny 1.30
323 mgorny 1.55 [[ ${want_autoreconf} ]] && eautoreconf
324 mgorny 1.25 elibtoolize --patch-only
325 reavertm 1.1 }
326    
327     # @FUNCTION: autotools-utils_src_configure
328     # @DESCRIPTION:
329     # The src_configure function. For out of source build it creates build
330     # directory and runs econf there. Configuration parameters defined
331     # in myeconfargs are passed here to econf. Additionally following USE
332     # flags are known:
333     #
334     # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
335     # to econf respectively.
336 floppym 1.69
337     # @VARIABLE: myeconfargs
338     # @DEFAULT_UNSET
339     # @DESCRIPTION:
340     # Optional econf arguments as Bash array. Should be defined before calling src_configure.
341     # @CODE
342     # src_configure() {
343     # local myeconfargs=(
344     # --disable-readline
345     # --with-confdir="/etc/nasty foo confdir/"
346     # $(use_enable debug cnddebug)
347     # $(use_enable threads multithreading)
348     # )
349     # autotools-utils_src_configure
350     # }
351     # @CODE
352 reavertm 1.1 autotools-utils_src_configure() {
353     debug-print-function ${FUNCNAME} "$@"
354    
355 mgorny 1.22 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
356     || die 'autotools-utils.eclass: myeconfargs has to be an array.'
357    
358 mgorny 1.35 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
359    
360 reavertm 1.1 # Common args
361 mgorny 1.41 local econfargs=()
362    
363     _check_build_dir
364 mgorny 1.43 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
365 mgorny 1.41 econfargs+=(
366     --docdir="${EPREFIX}"/usr/share/doc/${PF}
367     )
368     fi
369 reavertm 1.1
370     # Handle static-libs found in IUSE, disable them by default
371 mgorny 1.24 if in_iuse static-libs; then
372 reavertm 1.1 econfargs+=(
373     --enable-shared
374     $(use_enable static-libs static)
375     )
376     fi
377    
378     # Append user args
379 reavertm 1.5 econfargs+=("${myeconfargs[@]}")
380 reavertm 1.1
381 mgorny 1.58 mkdir -p "${BUILD_DIR}" || die
382     pushd "${BUILD_DIR}" > /dev/null || die
383 mgorny 1.30 econf "${econfargs[@]}" "$@"
384 mgorny 1.52 popd > /dev/null || die
385 reavertm 1.1 }
386    
387     # @FUNCTION: autotools-utils_src_compile
388     # @DESCRIPTION:
389 mgorny 1.58 # The autotools src_compile function, invokes emake in specified BUILD_DIR.
390 reavertm 1.1 autotools-utils_src_compile() {
391     debug-print-function ${FUNCNAME} "$@"
392    
393     _check_build_dir
394 mgorny 1.58 pushd "${BUILD_DIR}" > /dev/null || die
395 mgorny 1.30 emake "$@" || die 'emake failed'
396 mgorny 1.52 popd > /dev/null || die
397 reavertm 1.1 }
398    
399     # @FUNCTION: autotools-utils_src_install
400     # @DESCRIPTION:
401     # The autotools src_install function. Runs emake install, unconditionally
402     # removes unnecessary static libs (based on shouldnotlink libtool property)
403     # and removes unnecessary libtool files when static-libs USE flag is defined
404     # and unset.
405     #
406     # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
407     autotools-utils_src_install() {
408     debug-print-function ${FUNCNAME} "$@"
409    
410     _check_build_dir
411 mgorny 1.58 pushd "${BUILD_DIR}" > /dev/null || die
412 mgorny 1.30 emake DESTDIR="${D}" "$@" install || die "emake install failed"
413 mgorny 1.52 popd > /dev/null || die
414 reavertm 1.1
415 mgorny 1.35 # Move docs installed by autotools (in EAPI < 4).
416 mgorny 1.40 if [[ ${EAPI} == [23] ]] \
417     && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
418 mgorny 1.39 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
419     eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
420     else
421     mkdir "${T}"/temp-docdir
422     mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
423     || die "moving docs to tempdir failed"
424 mgorny 1.35
425 mgorny 1.39 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
426     rm -r "${T}"/temp-docdir || die
427     fi
428 mgorny 1.35 fi
429    
430 mgorny 1.30 # XXX: support installing them from builddir as well?
431 mgorny 1.62 if declare -p DOCS &>/dev/null; then
432     # an empty list == don't install anything
433     if [[ ${DOCS[@]} ]]; then
434     if [[ ${EAPI} == [23] ]]; then
435     dodoc "${DOCS[@]}" || die
436     else
437     # dies by itself
438     dodoc -r "${DOCS[@]}"
439     fi
440 mgorny 1.61 fi
441 mgorny 1.34 else
442     local f
443     # same list as in PMS
444     for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
445     THANKS BUGS FAQ CREDITS CHANGELOG; do
446     if [[ -s ${f} ]]; then
447     dodoc "${f}" || die "(default) dodoc ${f} failed"
448     fi
449     done
450 mgorny 1.30 fi
451     if [[ ${HTML_DOCS} ]]; then
452     dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
453     fi
454    
455 reavertm 1.1 # Remove libtool files and unnecessary static libs
456 mgorny 1.64 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
457 mgorny 1.67 if [[ ${prune_ltfiles} != none ]]; then
458     prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
459     fi
460 reavertm 1.1 }
461    
462     # @FUNCTION: autotools-utils_src_test
463     # @DESCRIPTION:
464     # The autotools src_test function. Runs emake check in build directory.
465     autotools-utils_src_test() {
466     debug-print-function ${FUNCNAME} "$@"
467    
468     _check_build_dir
469 mgorny 1.58 pushd "${BUILD_DIR}" > /dev/null || die
470 mgorny 1.66
471 mgorny 1.70 if make -n check "${@}" &>/dev/null; then
472 mgorny 1.68 emake check "${@}" || die 'emake check failed.'
473 mgorny 1.70 elif make -n test "${@}" &>/dev/null; then
474 mgorny 1.68 emake test "${@}" || die 'emake test failed.'
475     fi
476 mgorny 1.66
477 mgorny 1.52 popd > /dev/null || die
478 reavertm 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20