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

Contents of /eclass/autotools.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.76 - (show annotations) (download)
Sun Jun 1 01:43:06 2008 UTC (6 years, 5 months ago) by vapier
Branch: MAIN
Changes since 1.75: +50 -28 lines
add eclass documentation by mren #210546

1 # Copyright 1999-2008 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.75 2008/04/24 03:15:43 vapier Exp $
4
5 # @ECLASS: autotools.eclass
6 # @MAINTAINER:
7 # base-system@gentoo.org
8 # @BLURB: Regenerates auto* build scripts
9 # @DESCRIPTION:
10 # This eclass is for safely handling autotooled software packages that need to
11 # regenerate their build scripts. All functions will abort in case of errors.
12 #
13 # NB: If you add anything, please comment it!
14
15 inherit eutils libtool
16
17 # @ECLASS-VARIABLE: WANT_AUTOCONF
18 # @DESCRIPTION:
19 # The major version of autoconf your package needs
20 [[ -z ${WANT_AUTOCONF} ]] && WANT_AUTOCONF="latest"
21
22 # @ECLASS-VARIABLE: WANT_AUTOMAKE
23 # @DESCRIPTION:
24 # The major version of automake your package needs
25 [[ -z ${WANT_AUTOMAKE} ]] && WANT_AUTOMAKE="latest"
26
27 _automake_atom="sys-devel/automake"
28 _autoconf_atom="sys-devel/autoconf"
29 if [[ -n ${WANT_AUTOMAKE} ]]; then
30 case ${WANT_AUTOMAKE} in
31 none) _automake_atom="" ;; # some packages don't require automake at all
32 latest) _automake_atom="=sys-devel/automake-1.10*" ;;
33 *) _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}*" ;;
34 esac
35 [[ ${WANT_AUTOMAKE} == "latest" ]] && WANT_AUTOMAKE="1.10"
36 export WANT_AUTOMAKE
37 fi
38
39 if [[ -n ${WANT_AUTOCONF} ]] ; then
40 case ${WANT_AUTOCONF} in
41 none) _autoconf_atom="" ;; # some packages don't require autoconf at all
42 2.1) _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
43 latest|2.5) _autoconf_atom=">=sys-devel/autoconf-2.61" ;;
44 *) _autoconf_atom="INCORRECT-WANT_AUTOCONF-SETTING-IN-EBUILD" ;;
45 esac
46 [[ ${WANT_AUTOCONF} == "latest" ]] && WANT_AUTOCONF="2.5"
47 export WANT_AUTOCONF
48 fi
49 DEPEND="${_automake_atom}
50 ${_autoconf_atom}
51 sys-devel/libtool"
52 RDEPEND=""
53 unset _automake_atom _autoconf_atom
54
55 # @ECLASS-VARIABLE: AM_OPTS
56 # @DESCRIPTION:
57 # Additional options to pass to automake during
58 # eautoreconf call.
59
60 # @ECLASS-VARIABLE: AT_NOELIBTOOLIZE
61 # @DESCRIPTION:
62 # Don't run elibtoolize command if set to 'yes',
63 # useful when elibtoolize needs to be ran with
64 # particular options
65
66 # XXX: M4DIR should be deprecated
67 # @ECLASS-VARIABLE: AT_M4DIR
68 # @DESCRIPTION:
69 # Additional director(y|ies) aclocal should search
70 AT_M4DIR=${AT_M4DIR:-${M4DIR}}
71 AT_GNUCONF_UPDATE="no"
72
73
74 # @FUNCTION: eautoreconf
75 # @DESCRIPTION:
76 # This function mimes the behavior of autoreconf, but uses the different
77 # eauto* functions to run the tools. It doesn't accept parameters, but
78 # the directory with include files can be specified with AT_M4DIR variable.
79 #
80 # Should do a full autoreconf - normally what most people will be interested in.
81 # Also should handle additional directories specified by AC_CONFIG_SUBDIRS.
82 eautoreconf() {
83 local pwd=$(pwd) x auxdir
84
85 if [[ -z ${AT_NO_RECURSIVE} ]]; then
86 # Take care of subdirs
87 for x in $(autotools_get_subdirs); do
88 if [[ -d ${x} ]] ; then
89 cd "${x}"
90 AT_NOELIBTOOLIZE="yes" eautoreconf
91 cd "${pwd}"
92 fi
93 done
94 fi
95
96 auxdir=$(autotools_get_auxdir)
97
98 einfo "Running eautoreconf in '$(pwd)' ..."
99 [[ -n ${auxdir} ]] && mkdir -p ${auxdir}
100 eaclocal
101 if ${LIBTOOLIZE:-libtoolize} -n --install >& /dev/null ; then
102 _elibtoolize --copy --force --install
103 else
104 _elibtoolize --copy --force
105 fi
106 eautoconf
107 eautoheader
108 FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}
109
110 [[ ${AT_NOELIBTOOLIZE} == "yes" ]] && return 0
111
112 # Call it here to prevent failures due to elibtoolize called _before_
113 # eautoreconf.
114 elibtoolize
115
116 return 0
117 }
118
119 # @FUNCTION: eaclocal
120 # @DESCRIPTION:
121 # These functions runs the autotools using autotools_run_tool with the
122 # specified parametes. The name of the tool run is the same of the function
123 # without e prefix.
124 # They also force installing the support files for safety.
125 # Respects AT_M4DIR for additional directories to search for macro's.
126 eaclocal() {
127 local aclocal_opts
128
129 local amflags_file
130 for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
131 [[ -e ${amflags_file} ]] || continue
132 aclocal_opts=$(sed -n '/^ACLOCAL_AMFLAGS[[:space:]]*=/s:[^=]*=::p' ${amflags_file})
133 eval aclocal_opts=\"${aclocal_opts}\"
134 break
135 done
136
137 if [[ -n ${AT_M4DIR} ]] ; then
138 for x in ${AT_M4DIR} ; do
139 case "${x}" in
140 "-I")
141 # We handle it below
142 ;;
143 *)
144 [[ ! -d ${x} ]] && ewarn "eaclocal: '${x}' does not exist"
145 aclocal_opts="${aclocal_opts} -I ${x}"
146 ;;
147 esac
148 done
149 fi
150
151 [[ ! -f aclocal.m4 || -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
152 autotools_run_tool aclocal "$@" ${aclocal_opts}
153 }
154
155 # @FUNCTION: _elibtoolize
156 # @DESCRIPTION:
157 # Runs libtoolize. Note the '_' prefix .. to not collide with elibtoolize() from
158 # libtool.eclass.
159 _elibtoolize() {
160 local opts
161 local lttest
162
163 # Check if we should run libtoolize (AM_PROG_LIBTOOL is an older macro,
164 # check for both it and the current AC_PROG_LIBTOOL)
165 lttest="$(autotools_check_macro "AC_PROG_LIBTOOL")$(autotools_check_macro "AM_PROG_LIBTOOL")"
166 [[ -n $lttest ]] || return 0
167
168 [[ -f GNUmakefile.am || -f Makefile.am ]] && opts="--automake"
169
170 [[ "${USERLAND}" == "Darwin" ]] && LIBTOOLIZE="glibtoolize"
171 autotools_run_tool ${LIBTOOLIZE:-libtoolize} "$@" ${opts}
172
173 # Need to rerun aclocal
174 eaclocal
175 }
176
177 # @FUNCTION: eautoheader
178 # @DESCRIPTION:
179 # Runs autoheader.
180 eautoheader() {
181 # Check if we should run autoheader
182 [[ -n $(autotools_check_macro "AC_CONFIG_HEADERS") ]] || return 0
183 NO_FAIL=1 autotools_run_tool autoheader "$@"
184 }
185
186 # @FUNCTION: eautoconf
187 # @DESCRIPTION:
188 # Runs autoconf.
189 eautoconf() {
190 if [[ ! -f configure.ac && ! -f configure.in ]] ; then
191 echo
192 eerror "No configure.{ac,in} present in '$(pwd | sed -e 's:.*/::')'!"
193 echo
194 die "No configure.{ac,in} present!"
195 fi
196
197 autotools_run_tool autoconf "$@"
198 }
199
200 # @FUNCTION: eautomake
201 # @DESCRIPTION:
202 # Runs automake.
203 eautomake() {
204 local extra_opts
205 local makefile_name
206
207 if [[ -f GNUmakefile.am ]]; then
208 makefile_name="GNUmakefile"
209 elif [[ -f Makefile.am ]]; then
210 makefile_name="Makefile"
211 else
212 return 0
213 fi
214
215 if [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name}.in ]]; then
216 local used_automake
217 local installed_automake
218
219 installed_automake=$(automake --version | head -n 1 | \
220 sed -e 's:.*(GNU automake) ::')
221 used_automake=$(head -n 1 < ${makefile_name}.in | \
222 sed -e 's:.*by automake \(.*\) from .*:\1:')
223
224 if [[ ${installed_automake} != ${used_automake} ]]; then
225 einfo "Automake used for the package (${used_automake}) differs from"
226 einfo "the installed version (${installed_automake})."
227 eautoreconf
228 return 0
229 fi
230 fi
231
232 [[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS ]] \
233 || extra_opts="${extra_opts} --foreign"
234
235 # --force-missing seems not to be recognized by some flavours of automake
236 autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
237 }
238
239 # Internal function to run an autotools' tool
240 autotools_run_tool() {
241 if [[ ${EBUILD_PHASE} != "unpack" ]]; then
242 ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
243 fi
244
245 local STDERR_TARGET="${T}/$$.out"
246 local ris
247
248 printf "***** $1 *****\n***** $*\n\n" > "${STDERR_TARGET%/*}/$1-${STDERR_TARGET##*/}"
249
250 ebegin "Running $@"
251 "$@" >> "${STDERR_TARGET%/*}/$1-${STDERR_TARGET##*/}" 2>&1
252 ris=$?
253 eend ${ris}
254
255 if [[ ${ris} != 0 && ${NO_FAIL} != 1 ]]; then
256 echo
257 eerror "Failed Running $1 !"
258 eerror
259 eerror "Include in your bugreport the contents of:"
260 eerror
261 eerror " ${STDERR_TARGET%/*}/$1-${STDERR_TARGET##*/}"
262 echo
263 die "Failed Running $1 !"
264 fi
265 }
266
267 # Internal function to check for support
268 autotools_check_macro() {
269 [[ -f configure.ac || -f configure.in ]] && \
270 WANT_AUTOCONF="2.5" autoconf --trace=$1 2>/dev/null
271 return 0
272 }
273
274 # Internal function to get additional subdirs to configure
275 autotools_get_subdirs() {
276 local subdirs_scan_out
277
278 subdirs_scan_out=$(autotools_check_macro "AC_CONFIG_SUBDIRS")
279 [[ -n ${subdirs_scan_out} ]] || return 0
280
281 echo "${subdirs_scan_out}" | gawk \
282 '($0 !~ /^[[:space:]]*(#|dnl)/) {
283 if (match($0, /AC_CONFIG_SUBDIRS:(.*)$/, res))
284 print res[1]
285 }' | uniq
286
287 return 0
288 }
289
290 autotools_get_auxdir() {
291 local auxdir_scan_out
292
293 auxdir_scan_out=$(autotools_check_macro "AC_CONFIG_AUX_DIR")
294 [[ -n ${auxdir_scan_out} ]] || return 0
295
296 echo ${auxdir_scan_out} | gawk \
297 '($0 !~ /^[[:space:]]*(#|dnl)/) {
298 if (match($0, /AC_CONFIG_AUX_DIR:(.*)$/, res))
299 print res[1]
300 }' | uniq
301
302 return 0
303 }

  ViewVC Help
Powered by ViewVC 1.1.20