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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.61 - (show annotations) (download)
Fri Dec 14 08:40:18 2012 UTC (18 months, 3 weeks ago) by mgorny
Branch: MAIN
Changes since 1.60: +9 -2 lines
Support directories in DOCS, in EAPI 4+.

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.60 2012/12/03 12:05:51 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 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=("${BUILD_DIR}/apidocs/html/")
80 # autotools-utils_src_install
81 # if use examples; then
82 # dobin "${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|5) ;;
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_DEPEND:=no}
115
116 inherit autotools eutils libtool
117
118 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
119
120 # @ECLASS-VARIABLE: BUILD_DIR
121 # @DEFAULT_UNSET
122 # @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 #
126 # This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127 # It is set under that name for compatibility.
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 # In EAPIs 4+, can list directories as well.
161 #
162 # Example:
163 # @CODE
164 # DOCS=( NEWS README )
165 # @CODE
166
167 # @ECLASS-VARIABLE: HTML_DOCS
168 # @DEFAULT_UNSET
169 # @DESCRIPTION:
170 # Array containing documents passed to dohtml command.
171 #
172 # Example:
173 # @CODE
174 # HTML_DOCS=( doc/html/ )
175 # @CODE
176
177 # @ECLASS-VARIABLE: PATCHES
178 # @DEFAULT_UNSET
179 # @DESCRIPTION:
180 # PATCHES array variable containing all various patches to be applied.
181 #
182 # Example:
183 # @CODE
184 # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
185 # @CODE
186
187 # Determine using IN or OUT source build
188 _check_build_dir() {
189 : ${ECONF_SOURCE:=${S}}
190 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
191 BUILD_DIR="${ECONF_SOURCE}"
192 else
193 # Respect both the old variable and the new one, depending
194 # on which one was set by the ebuild.
195 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
196 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
197 eqawarn "Please migrate the ebuild to use the new one."
198
199 # In the next call, both variables will be set already
200 # and we'd have to know which one takes precedence.
201 _RESPECT_AUTOTOOLS_BUILD_DIR=1
202 fi
203
204 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
205 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
206 else
207 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
208 fi
209 fi
210
211 # Backwards compatibility for getting the value.
212 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
213 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
214 }
215
216 # @FUNCTION: remove_libtool_files
217 # @USAGE: [all]
218 # @DESCRIPTION:
219 # Determines unnecessary libtool files (.la) and libtool static archives (.a)
220 # and removes them from installation image.
221 #
222 # To unconditionally remove all libtool files, pass 'all' as argument.
223 # Otherwise, libtool archives required for static linking will be preserved.
224 #
225 # In most cases it's not necessary to manually invoke this function.
226 # See autotools-utils_src_install for reference.
227 remove_libtool_files() {
228 debug-print-function ${FUNCNAME} "$@"
229 local removing_all
230
231 eqawarn "The remove_libtool_files() function was deprecated."
232 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
233
234 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
235 if [[ ${#} -eq 1 ]]; then
236 case "${1}" in
237 all)
238 removing_all=1
239 ;;
240 *)
241 die "Invalid argument to ${FUNCNAME}(): ${1}"
242 esac
243 fi
244
245 local pc_libs=()
246 if [[ ! ${removing_all} ]]; then
247 local arg
248 for arg in $(find "${D}" -name '*.pc' -exec \
249 sed -n -e 's;^Libs:;;p' {} +); do
250 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
251 done
252 fi
253
254 local f
255 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
256 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
257 local archivefile=${f/%.la/.a}
258 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
259
260 # Remove static libs we're not supposed to link against.
261 if [[ ${shouldnotlink} ]]; then
262 einfo "Removing unnecessary ${archivefile#${D%/}}"
263 rm -f "${archivefile}" || die
264 # The .la file may be used by a module loader, so avoid removing it
265 # unless explicitly requested.
266 [[ ${removing_all} ]] || continue
267 fi
268
269 # Remove .la files when:
270 # - user explicitly wants us to remove all .la files,
271 # - respective static archive doesn't exist,
272 # - they are covered by a .pc file already,
273 # - they don't provide any new information (no libs & no flags).
274 local removing
275 if [[ ${removing_all} ]]; then removing='forced'
276 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
277 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
278 removing='covered by .pc'
279 elif [[ ! $(sed -n -e \
280 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
281 "${f}") ]]; then removing='no libs & flags'
282 fi
283
284 if [[ ${removing} ]]; then
285 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
286 rm -f "${f}" || die
287 fi
288 done
289 }
290
291 # @FUNCTION: autotools-utils_autoreconf
292 # @DESCRIPTION:
293 # Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
294 autotools-utils_autoreconf() {
295 debug-print-function ${FUNCNAME} "$@"
296
297 eqawarn "The autotools-utils_autoreconf() function was deprecated."
298 eqawarn "Please call autotools-utils_src_prepare()"
299 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
300
301 # Override this func to not require unnecessary eaclocal calls.
302 autotools_check_macro() {
303 local x
304
305 # Add a few additional variants as we don't get expansions.
306 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
307 AC_CONFIG_HEADER AM_CONFIG_HEADER
308
309 for x; do
310 grep -h "^${x}" configure.{ac,in} 2>/dev/null
311 done
312 }
313
314 einfo "Autoreconfiguring '${PWD}' ..."
315
316 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
317 configure.{ac,in} 2>/dev/null)
318 if [[ ${auxdir} ]]; then
319 auxdir=${auxdir%%]}
320 mkdir -p ${auxdir##[}
321 fi
322
323 # Support running additional tools like gnome-autogen.sh.
324 # Note: you need to add additional depends to the ebuild.
325
326 # gettext
327 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
328 echo 'no' | autotools_run_tool glib-gettextize --copy --force
329 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
330 eautopoint --force
331 fi
332
333 # intltool
334 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
335 then
336 autotools_run_tool intltoolize --copy --automake --force
337 fi
338
339 # gtk-doc
340 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
341 autotools_run_tool gtkdocize --copy
342 fi
343
344 # gnome-doc
345 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
346 autotools_run_tool gnome-doc-prepare --copy --force
347 fi
348
349 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
350 then
351 _elibtoolize --copy --force --install
352 fi
353
354 eaclocal
355 eautoconf
356 eautoheader
357 FROM_EAUTORECONF=sure eautomake
358
359 local x
360 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
361 if [[ -d ${x} ]] ; then
362 pushd "${x}" >/dev/null || die
363 autotools-utils_autoreconf
364 popd >/dev/null || die
365 fi
366 done
367 }
368
369 # @FUNCTION: autotools-utils_src_prepare
370 # @DESCRIPTION:
371 # The src_prepare function.
372 #
373 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
374 autotools-utils_src_prepare() {
375 debug-print-function ${FUNCNAME} "$@"
376
377 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
378
379 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
380
381 at_checksum() {
382 find '(' -name 'Makefile.am' \
383 -o -name 'configure.ac' \
384 -o -name 'configure.in' ')' \
385 -exec cksum {} + | sort -k2
386 }
387
388 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
389 epatch_user
390 if [[ ! ${want_autoreconf} ]]; then
391 if [[ ${checksum} != $(at_checksum) ]]; then
392 einfo 'Will autoreconfigure due to user patches applied.'
393 want_autoreconf=yep
394 fi
395 fi
396
397 [[ ${want_autoreconf} ]] && eautoreconf
398 elibtoolize --patch-only
399 }
400
401 # @FUNCTION: autotools-utils_src_configure
402 # @DESCRIPTION:
403 # The src_configure function. For out of source build it creates build
404 # directory and runs econf there. Configuration parameters defined
405 # in myeconfargs are passed here to econf. Additionally following USE
406 # flags are known:
407 #
408 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
409 # to econf respectively.
410 autotools-utils_src_configure() {
411 debug-print-function ${FUNCNAME} "$@"
412
413 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
414 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
415
416 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
417
418 # Common args
419 local econfargs=()
420
421 _check_build_dir
422 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
423 econfargs+=(
424 --docdir="${EPREFIX}"/usr/share/doc/${PF}
425 )
426 fi
427
428 # Handle static-libs found in IUSE, disable them by default
429 if in_iuse static-libs; then
430 econfargs+=(
431 --enable-shared
432 $(use_enable static-libs static)
433 )
434 fi
435
436 # Append user args
437 econfargs+=("${myeconfargs[@]}")
438
439 mkdir -p "${BUILD_DIR}" || die
440 pushd "${BUILD_DIR}" > /dev/null || die
441 econf "${econfargs[@]}" "$@"
442 popd > /dev/null || die
443 }
444
445 # @FUNCTION: autotools-utils_src_compile
446 # @DESCRIPTION:
447 # The autotools src_compile function, invokes emake in specified BUILD_DIR.
448 autotools-utils_src_compile() {
449 debug-print-function ${FUNCNAME} "$@"
450
451 _check_build_dir
452 pushd "${BUILD_DIR}" > /dev/null || die
453 emake "$@" || die 'emake failed'
454 popd > /dev/null || die
455 }
456
457 # @FUNCTION: autotools-utils_src_install
458 # @DESCRIPTION:
459 # The autotools src_install function. Runs emake install, unconditionally
460 # removes unnecessary static libs (based on shouldnotlink libtool property)
461 # and removes unnecessary libtool files when static-libs USE flag is defined
462 # and unset.
463 #
464 # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
465 autotools-utils_src_install() {
466 debug-print-function ${FUNCNAME} "$@"
467
468 _check_build_dir
469 pushd "${BUILD_DIR}" > /dev/null || die
470 emake DESTDIR="${D}" "$@" install || die "emake install failed"
471 popd > /dev/null || die
472
473 # Move docs installed by autotools (in EAPI < 4).
474 if [[ ${EAPI} == [23] ]] \
475 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
476 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
477 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
478 else
479 mkdir "${T}"/temp-docdir
480 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
481 || die "moving docs to tempdir failed"
482
483 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
484 rm -r "${T}"/temp-docdir || die
485 fi
486 fi
487
488 # XXX: support installing them from builddir as well?
489 if [[ ${DOCS} ]]; then
490 if [[ ${EAPI} == [23] ]]; then
491 dodoc "${DOCS[@]}" || die
492 else
493 # dies by itself
494 dodoc -r "${DOCS[@]}"
495 fi
496 else
497 local f
498 # same list as in PMS
499 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
500 THANKS BUGS FAQ CREDITS CHANGELOG; do
501 if [[ -s ${f} ]]; then
502 dodoc "${f}" || die "(default) dodoc ${f} failed"
503 fi
504 done
505 fi
506 if [[ ${HTML_DOCS} ]]; then
507 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
508 fi
509
510 # Remove libtool files and unnecessary static libs
511 prune_libtool_files
512 }
513
514 # @FUNCTION: autotools-utils_src_test
515 # @DESCRIPTION:
516 # The autotools src_test function. Runs emake check in build directory.
517 autotools-utils_src_test() {
518 debug-print-function ${FUNCNAME} "$@"
519
520 _check_build_dir
521 pushd "${BUILD_DIR}" > /dev/null || die
522 # Run default src_test as defined in ebuild.sh
523 default_src_test
524 popd > /dev/null || die
525 }

  ViewVC Help
Powered by ViewVC 1.1.20