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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.41 - (show annotations) (download)
Sun Jan 15 14:05:14 2012 UTC (2 years, 3 months ago) by mgorny
Branch: MAIN
Changes since 1.40: +9 -5 lines
Pass --docdir to configure only when supported.

1 # Copyright 1999-2012 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.40 2012/01/14 18:53:56 mgorny Exp $
4
5 # @ECLASS: autotools-utils.eclass
6 # @MAINTAINER:
7 # Maciej Mrozowski <reavertm@gentoo.org>
8 # Michał Górny <mgorny@gentoo.org>
9 # @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 # 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.
19 #
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 # x11-libs/qt-core:4
41 # x11-libs/qt-gui:4
42 # )
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 # local myeconfargs=(
65 # $(use_enable debug)
66 # $(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 # use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/")
80 # autotools-utils_src_install
81 # if use examples; then
82 # dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\
83 # || 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 2|3|4) ;;
93 *) die "EAPI=${EAPI} is not supported" ;;
94 esac
95
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
116 AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
117 inherit autotools eutils libtool
118
119 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
120
121 unset _autotools_auto_dep
122
123 # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
124 # @DEFAULT_UNSET
125 # @DESCRIPTION:
126 # Build directory, location where all autotools generated files should be
127 # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
128
129 # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130 # @DEFAULT_UNSET
131 # @DESCRIPTION:
132 # Set to enable in-source build.
133
134 # @ECLASS-VARIABLE: ECONF_SOURCE
135 # @DEFAULT_UNSET
136 # @DESCRIPTION:
137 # Specify location of autotools' configure script. By default it uses ${S}.
138
139 # @ECLASS-VARIABLE: myeconfargs
140 # @DEFAULT_UNSET
141 # @DESCRIPTION:
142 # Optional econf arguments as Bash array. Should be defined before calling src_configure.
143 # @CODE
144 # src_configure() {
145 # local myeconfargs=(
146 # --disable-readline
147 # --with-confdir="/etc/nasty foo confdir/"
148 # $(use_enable debug cnddebug)
149 # $(use_enable threads multithreading)
150 # )
151 # autotools-utils_src_configure
152 # }
153 # @CODE
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
185 # Determine using IN or OUT source build
186 _check_build_dir() {
187 : ${ECONF_SOURCE:=${S}}
188 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
189 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
190 else
191 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build}
192 fi
193 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
194 }
195
196 # @FUNCTION: remove_libtool_files
197 # @USAGE: [all]
198 # @DESCRIPTION:
199 # Determines unnecessary libtool files (.la) and libtool static archives (.a)
200 # and removes them from installation image.
201 #
202 # To unconditionally remove all libtool files, pass 'all' as argument.
203 # Otherwise, libtool archives required for static linking will be preserved.
204 #
205 # In most cases it's not necessary to manually invoke this function.
206 # See autotools-utils_src_install for reference.
207 remove_libtool_files() {
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
229
230 local f
231 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
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.
237 if [[ ${shouldnotlink} ]]; then
238 einfo "Removing unnecessary ${archivefile#${D%/}}"
239 rm -f "${archivefile}" || die
240 # The .la file may be used by a module loader, so avoid removing it
241 # unless explicitly requested.
242 [[ ${removing_all} ]] || continue
243 fi
244
245 # Remove .la files when:
246 # - user explicitly wants us to remove all .la files,
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
261 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
262 rm -f "${f}" || die
263 fi
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).
279 autotools-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
350 }
351
352 # @FUNCTION: autotools-utils_src_prepare
353 # @DESCRIPTION:
354 # The src_prepare function.
355 #
356 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
357 autotools-utils_src_prepare() {
358 debug-print-function ${FUNCNAME} "$@"
359
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
378 }
379
380 # @FUNCTION: autotools-utils_src_configure
381 # @DESCRIPTION:
382 # The src_configure function. For out of source build it creates build
383 # directory and runs econf there. Configuration parameters defined
384 # in myeconfargs are passed here to econf. Additionally following USE
385 # flags are known:
386 #
387 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
388 # to econf respectively.
389 autotools-utils_src_configure() {
390 debug-print-function ${FUNCNAME} "$@"
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
397 # Common args
398 local econfargs=()
399
400 _check_build_dir
401 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep docdir; then
402 econfargs+=(
403 --docdir="${EPREFIX}"/usr/share/doc/${PF}
404 )
405 fi
406
407 # Handle static-libs found in IUSE, disable them by default
408 if in_iuse static-libs; then
409 econfargs+=(
410 --enable-shared
411 $(use_enable static-libs static)
412 )
413 fi
414
415 # Append user args
416 econfargs+=("${myeconfargs[@]}")
417
418 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
419 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
420 econf "${econfargs[@]}" "$@"
421 popd > /dev/null
422 }
423
424 # @FUNCTION: autotools-utils_src_compile
425 # @DESCRIPTION:
426 # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
427 autotools-utils_src_compile() {
428 debug-print-function ${FUNCNAME} "$@"
429
430 _check_build_dir
431 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
432 emake "$@" || die 'emake failed'
433 popd > /dev/null
434 }
435
436 # @FUNCTION: autotools-utils_src_install
437 # @DESCRIPTION:
438 # The autotools src_install function. Runs emake install, unconditionally
439 # removes unnecessary static libs (based on shouldnotlink libtool property)
440 # and removes unnecessary libtool files when static-libs USE flag is defined
441 # and unset.
442 #
443 # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
444 autotools-utils_src_install() {
445 debug-print-function ${FUNCNAME} "$@"
446
447 _check_build_dir
448 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
449 emake DESTDIR="${D}" "$@" install || die "emake install failed"
450 popd > /dev/null
451
452 # Move docs installed by autotools (in EAPI < 4).
453 if [[ ${EAPI} == [23] ]] \
454 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
455 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
456 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
457 else
458 mkdir "${T}"/temp-docdir
459 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
460 || die "moving docs to tempdir failed"
461
462 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
463 rm -r "${T}"/temp-docdir || die
464 fi
465 fi
466
467 # XXX: support installing them from builddir as well?
468 if [[ ${DOCS} ]]; then
469 dodoc "${DOCS[@]}" || die "dodoc failed"
470 else
471 local f
472 # same list as in PMS
473 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
474 THANKS BUGS FAQ CREDITS CHANGELOG; do
475 if [[ -s ${f} ]]; then
476 dodoc "${f}" || die "(default) dodoc ${f} failed"
477 fi
478 done
479 fi
480 if [[ ${HTML_DOCS} ]]; then
481 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
482 fi
483
484 # Remove libtool files and unnecessary static libs
485 remove_libtool_files
486 }
487
488 # @FUNCTION: autotools-utils_src_test
489 # @DESCRIPTION:
490 # The autotools src_test function. Runs emake check in build directory.
491 autotools-utils_src_test() {
492 debug-print-function ${FUNCNAME} "$@"
493
494 _check_build_dir
495 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
496 # Run default src_test as defined in ebuild.sh
497 default_src_test
498 popd > /dev/null
499 }

  ViewVC Help
Powered by ViewVC 1.1.20