Fix fit-window-to-buffer doc-string.
[emacs.git] / autogen.sh
blob6b7c647c4c56ff81aa98c2f0cdb03ddf9e6978de
1 #!/bin/sh
2 ### autogen.sh - tool to help build Emacs from a bzr checkout
4 ## Copyright (C) 2011-2014 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 bzr repository does not include the configure script
27 ## (and associated helpers). The first time you fetch Emacs from bzr,
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' -n -e '1 s/.* \([1-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 '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 eval min=\$${prog}_min
119 echo "Checking for $prog (need at least version $min)..."
121 check_version $prog $min
123 retval=$?
125 case $retval in
126 0) stat="ok" ;;
127 1) stat="missing" ;;
128 2) stat="too old" ;;
129 *) stat="unable to check" ;;
130 esac
132 echo $stat
134 if [ $retval -ne 0 ]; then
135 missing="$missing $prog"
136 eval ${prog}_why=\""$stat"\"
139 done
142 if [ x"$missing" != x ]; then
144 cat <<EOF
146 Building Emacs from Bzr requires the following specialized programs:
149 for prog in $progs; do
150 eval min=\$${prog}_min
152 echo "$prog (minimum version $min)"
153 done
156 cat <<EOF
158 Your system seems to be missing the following tool(s):
161 for prog in $missing; do
162 eval why=\$${prog}_why
164 echo "$prog ($why)"
165 done
167 cat <<EOF
169 If you think you have the required tools, please add them to your PATH
170 and re-run this script.
172 Otherwise, please try installing them.
173 On systems using rpm and yum, try: "yum install PACKAGE"
174 On systems using dpkg and apt, try: "apt-get install PACKAGE"
175 Then re-run this script.
177 If you do not have permission to do this, or if the version provided
178 by your system is too old, it is normally straightforward to build
179 these packages from source. You can find the sources at:
181 ftp://ftp.gnu.org/gnu/PACKAGE/
183 Download the package (make sure you get at least the minimum version
184 listed above), extract it using tar, then run configure, make,
185 make install. Add the installation directory to your PATH and re-run
186 this script.
188 If you know that the required versions are in your PATH, but this
189 script has made an error, then you can simply run
191 autoreconf -i -I m4
193 instead of this script.
195 Please report any problems with this script to bug-gnu-emacs@gnu.org .
198 exit 1
201 echo "Your system has the required tools, running autoreconf..."
204 ## Let autoreconf figure out what, if anything, needs doing.
205 autoreconf -i -I m4 || exit $?
207 ## Create a timestamp, so that './autogen.sh; make' doesn't
208 ## cause 'make' to needlessly run 'autoheader'.
209 echo timestamp > src/stamp-h.in || exit
211 echo "You can now run \`./configure'."
213 exit 0
215 ### autogen.sh ends here