Minor corrections in ELisp manual
[emacs.git] / autogen.sh
blobbc9c5a008e034479aa1c146332de6f0b318399c4
1 #!/bin/sh
2 ### autogen.sh - tool to help build Emacs from a repository checkout
4 ## Copyright (C) 2011-2015 Free Software Foundation, Inc.
6 ## Author: Glenn Morris <rgm@gnu.org>
7 ## Maintainer: emacs-devel@gnu.org
9 ## This file is part of GNU Emacs.
11 ## GNU Emacs is free software: you can redistribute it and/or modify
12 ## it under the terms of the GNU General Public License as published by
13 ## the Free Software Foundation, either version 3 of the License, or
14 ## (at your option) any later version.
16 ## GNU Emacs is distributed in the hope that it will be useful,
17 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ## GNU General Public License for more details.
21 ## You should have received a copy of the GNU General Public License
22 ## along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ### Commentary:
26 ## The Emacs repository does not include the configure script (and
27 ## associated helpers). The first time you fetch Emacs from the repo,
28 ## run this script to generate the necessary files.
29 ## For more details, see the file INSTALL.REPO.
31 ### Code:
33 ## Tools we need:
34 ## Note that we respect the values of AUTOCONF etc, like autoreconf does.
35 progs="autoconf automake"
37 ## Minimum versions we need:
38 autoconf_min=`sed -n 's/^ *AC_PREREQ(\([0-9\.]*\)).*/\1/p' configure.ac`
40 ## This will need improving if more options are ever added to the
41 ## AM_INIT_AUTOMAKE call.
42 automake_min=`sed -n 's/^ *AM_INIT_AUTOMAKE(\([0-9\.]*\)).*/\1/p' configure.ac`
45 ## $1 = program, eg "autoconf".
46 ## Echo the version string, eg "2.59".
47 ## FIXME does not handle things like "1.4a", but AFAIK those are
48 ## all old versions, so it is OK to fail there.
49 ## Also note that we do not handle micro versions.
50 get_version ()
52 ## Remove eg "./autogen.sh: line 50: autoconf: command not found".
53 $1 --version 2>&1 | sed -e '/not found/d' -e 's/.* //' -n -e '1 s/\([0-9][0-9\.]*\).*/\1/p'
56 ## $1 = version string, eg "2.59"
57 ## Echo the major version, eg "2".
58 major_version ()
60 echo $1 | sed -e 's/\([0-9][0-9]*\)\..*/\1/'
63 ## $1 = version string, eg "2.59"
64 ## Echo the minor version, eg "59".
65 minor_version ()
67 echo $1 | sed -e 's/[0-9][0-9]*\.\([0-9][0-9]*\).*/\1/'
70 ## $1 = program
71 ## $2 = minimum version.
72 ## Return 0 if program is present with version >= minimum version.
73 ## Return 1 if program is missing.
74 ## Return 2 if program is present but too old.
75 ## Return 3 for unexpected error (eg failed to parse version).
76 check_version ()
78 ## Respect eg $AUTOMAKE if it is set, like autoreconf does.
79 uprog=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
81 eval uprog=\$${uprog}
83 [ x"$uprog" = x ] && uprog=$1
85 have_version=`get_version $uprog`
87 [ x"$have_version" = x ] && return 1
89 have_maj=`major_version $have_version`
90 need_maj=`major_version $2`
92 [ x"$have_maj" != x ] && [ x"$need_maj" != x ] || return 3
94 [ $have_maj -gt $need_maj ] && return 0
95 [ $have_maj -lt $need_maj ] && return 2
97 have_min=`minor_version $have_version`
98 need_min=`minor_version $2`
100 [ x"$have_min" != x ] && [ x"$need_min" != x ] || return 3
102 [ $have_min -ge $need_min ] && return 0
103 return 2
107 cat <<EOF
108 Checking whether you have the necessary tools...
109 (Read INSTALL.REPO for more details on building Emacs)
113 missing=
115 for prog in $progs; do
117 sprog=`echo "$prog" | sed 's/-/_/g'`
119 eval min=\$${sprog}_min
121 echo "Checking for $prog (need at least version $min)..."
123 check_version $prog $min
125 retval=$?
127 case $retval in
128 0) stat="ok" ;;
129 1) stat="missing" ;;
130 2) stat="too old" ;;
131 *) stat="unable to check" ;;
132 esac
134 echo $stat
136 if [ $retval -ne 0 ]; then
137 missing="$missing $prog"
138 eval ${sprog}_why=\""$stat"\"
141 done
144 if [ x"$missing" != x ]; then
146 cat <<EOF
148 Building Emacs from the repository requires the following specialized programs:
151 for prog in $progs; do
152 sprog=`echo "$prog" | sed 's/-/_/g'`
154 eval min=\$${sprog}_min
156 echo "$prog (minimum version $min)"
157 done
160 cat <<EOF
162 Your system seems to be missing the following tool(s):
165 for prog in $missing; do
166 sprog=`echo "$prog" | sed 's/-/_/g'`
168 eval why=\$${sprog}_why
170 echo "$prog ($why)"
171 done
173 cat <<EOF
175 If you think you have the required tools, please add them to your PATH
176 and re-run this script.
178 Otherwise, please try installing them.
179 On systems using rpm and yum, try: "yum install PACKAGE"
180 On systems using dpkg and apt, try: "apt-get install PACKAGE"
181 Then re-run this script.
183 If you do not have permission to do this, or if the version provided
184 by your system is too old, it is normally straightforward to build
185 these packages from source. You can find the sources at:
187 ftp://ftp.gnu.org/gnu/PACKAGE/
189 Download the package (make sure you get at least the minimum version
190 listed above), extract it using tar, then run configure, make,
191 make install. Add the installation directory to your PATH and re-run
192 this script.
194 If you know that the required versions are in your PATH, but this
195 script has made an error, then you can simply run
197 autoreconf -fi -I m4
199 instead of this script.
201 Please report any problems with this script to bug-gnu-emacs@gnu.org .
204 exit 1
207 echo 'Your system has the required tools.'
208 echo "Running 'autoreconf -fi -I m4' ..."
211 ## Let autoreconf figure out what, if anything, needs doing.
212 ## Use autoreconf's -f option in case autoreconf itself has changed.
213 autoreconf -fi -I m4 || exit $?
215 ## Create a timestamp, so that './autogen.sh; make' doesn't
216 ## cause 'make' to needlessly run 'autoheader'.
217 echo timestamp > src/stamp-h.in || exit
219 ## Install Git hooks, if using Git.
220 if test -d .git/hooks; then
221 tailored_hooks=
222 sample_hooks=
224 for hook in commit-msg pre-commit; do
225 cmp build-aux/git-hooks/$hook .git/hooks/$hook >/dev/null 2>&1 ||
226 tailored_hooks="$tailored_hooks $hook"
227 done
228 for hook in applypatch-msg pre-applypatch; do
229 test ! -r .git/hooks/$hook.sample ||
230 cmp .git/hooks/$hook.sample .git/hooks/$hook >/dev/null 2>&1 ||
231 sample_hooks="$sample_hooks $hook"
232 done
234 if test -n "$tailored_hooks$sample_hooks"; then
235 echo "Installing git hooks..."
237 case `cp --help 2>/dev/null` in
238 *--backup*--verbose*)
239 cp_options='--backup=numbered --verbose';;
241 cp_options='-f';;
242 esac
244 if test -n "$tailored_hooks"; then
245 for hook in $tailored_hooks; do
246 cp $cp_options build-aux/git-hooks/$hook .git/hooks || exit
247 chmod a-w .git/hooks/$hook || exit
248 done
251 if test -n "$sample_hooks"; then
252 for hook in $sample_hooks; do
253 cp $cp_options .git/hooks/$hook.sample .git/hooks/$hook || exit
254 chmod a-w .git/hooks/$hook || exit
255 done
260 echo "You can now run './configure'."
262 exit 0
264 ### autogen.sh ends here