; Improve commentary of Info-default-directory-list
[emacs.git] / autogen.sh
blob76fde9e18d233d6e2a427fcf8fcf20582b1dd728
1 #!/bin/sh
2 ### autogen.sh - tool to help build Emacs from a repository checkout
4 ## Copyright (C) 2011-2017 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"
37 ## Minimum versions we need:
38 autoconf_min=`sed -n 's/^ *AC_PREREQ(\([0-9\.]*\)).*/\1/p' configure.ac`
41 ## $1 = program, eg "autoconf".
42 ## Echo the version string, eg "2.59".
43 ## FIXME does not handle things like "1.4a", but AFAIK those are
44 ## all old versions, so it is OK to fail there.
45 ## Also note that we do not handle micro versions.
46 get_version ()
48 vers=`($1 --version) 2> /dev/null` && expr "$vers" : '[^
49 ]* \([0-9][0-9.]*\).*'
52 ## $1 = version string, eg "2.59"
53 ## Echo the major version, eg "2".
54 major_version ()
56 echo $1 | sed -e 's/\([0-9][0-9]*\)\..*/\1/'
59 ## $1 = version string, eg "2.59"
60 ## Echo the minor version, eg "59".
61 minor_version ()
63 echo $1 | sed -e 's/[0-9][0-9]*\.\([0-9][0-9]*\).*/\1/'
66 ## $1 = program
67 ## $2 = minimum version.
68 ## Return 0 if program is present with version >= minimum version.
69 ## Return 1 if program is missing.
70 ## Return 2 if program is present but too old.
71 ## Return 3 for unexpected error (eg failed to parse version).
72 check_version ()
74 ## Respect, e.g., $AUTOCONF if it is set, like autoreconf does.
75 uprog0=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
77 eval uprog=\$${uprog0}
79 if [ x"$uprog" = x ]; then
80 uprog=$1
81 else
82 printf '%s' "(using $uprog0=$uprog) "
85 command -v $uprog > /dev/null || return 1
86 have_version=`get_version $uprog` || return 4
88 have_maj=`major_version $have_version`
89 need_maj=`major_version $2`
91 [ x"$have_maj" != x ] && [ x"$need_maj" != x ] || return 3
93 [ $have_maj -gt $need_maj ] && return 0
94 [ $have_maj -lt $need_maj ] && return 2
96 have_min=`minor_version $have_version`
97 need_min=`minor_version $2`
99 [ x"$have_min" != x ] && [ x"$need_min" != x ] || return 3
101 [ $have_min -ge $need_min ] && return 0
102 return 2
105 do_check=true
106 do_autoconf=false
107 do_git=false
109 for arg; do
110 case $arg in
111 --help)
112 exec echo "$0: usage: $0 [--no-check] [target...]
113 Targets are: all autoconf git";;
114 --no-check)
115 do_check=false;;
116 all)
117 do_autoconf=true
118 test -e .git && do_git=true;;
119 autoconf)
120 do_autoconf=true;;
121 git)
122 do_git=true;;
124 echo >&2 "$0: $arg: unknown argument"; exit 1;;
125 esac
126 done
128 case $do_autoconf,$do_git in
129 false,false)
130 do_autoconf=true;;
131 esac
133 # Generate Autoconf-related files, if requested.
135 if $do_autoconf; then
137 if $do_check; then
139 echo 'Checking whether you have the necessary tools...
140 (Read INSTALL.REPO for more details on building Emacs)'
142 missing=
144 for prog in $progs; do
146 sprog=`echo "$prog" | sed 's/-/_/g'`
148 eval min=\$${sprog}_min
150 printf '%s' "Checking for $prog (need at least version $min) ... "
152 check_version $prog $min
154 retval=$?
156 case $retval in
157 0) stat="ok" ;;
158 1) stat="missing" ;;
159 2) stat="too old" ;;
160 4) stat="broken?" ;;
161 *) stat="unable to check" ;;
162 esac
164 echo $stat
166 if [ $retval -ne 0 ]; then
167 missing="$missing $prog"
168 eval ${sprog}_why=\""$stat"\"
171 done
174 if [ x"$missing" != x ]; then
176 echo '
177 Building Emacs from the repository requires the following specialized programs:'
179 for prog in $progs; do
180 sprog=`echo "$prog" | sed 's/-/_/g'`
182 eval min=\$${sprog}_min
184 echo "$prog (minimum version $min)"
185 done
188 echo '
189 Your system seems to be missing the following tool(s):'
191 for prog in $missing; do
192 sprog=`echo "$prog" | sed 's/-/_/g'`
194 eval why=\$${sprog}_why
196 echo "$prog ($why)"
197 done
199 echo '
200 If you think you have the required tools, please add them to your PATH
201 and re-run this script.
203 Otherwise, please try installing them.
204 On systems using rpm and yum, try: "yum install PACKAGE"
205 On systems using dpkg and apt, try: "apt-get install PACKAGE"
206 Then re-run this script.
208 If you do not have permission to do this, or if the version provided
209 by your system is too old, it is normally straightforward to build
210 these packages from source. You can find the sources at:
212 ftp://ftp.gnu.org/gnu/PACKAGE/
214 Download the package (make sure you get at least the minimum version
215 listed above), extract it using tar, then run configure, make,
216 make install. Add the installation directory to your PATH and re-run
217 this script.
219 If you know that the required versions are in your PATH, but this
220 script has made an error, then you can simply re-run this script with
221 the --no-check option.
223 Please report any problems with this script to bug-gnu-emacs@gnu.org .'
225 exit 1
228 echo 'Your system has the required tools.'
230 fi # do_check
232 # Build aclocal.m4 here so that autoreconf need not use aclocal.
233 # aclocal is part of Automake and might not be installed, and
234 # autoreconf skips aclocal if aclocal.m4 is already supplied.
235 ls m4/*.m4 | LC_ALL=C sort | sed 's,.*\.m4$,m4_include([&]),' \
236 > aclocal.m4.tmp || exit
237 if cmp -s aclocal.m4.tmp aclocal.m4; then
238 rm -f aclocal.m4.tmp
239 else
240 echo "Building aclocal.m4 ..."
241 mv aclocal.m4.tmp aclocal.m4
242 fi || exit
244 echo "Running 'autoreconf -fi -I m4' ..."
246 ## Let autoreconf figure out what, if anything, needs doing.
247 ## Use autoreconf's -f option in case autoreconf itself has changed.
248 autoreconf -fi -I m4 || exit
252 # True if the Git setup was OK before autogen.sh was run.
254 git_was_ok=true
256 if $do_git; then
257 case `cp --help 2>/dev/null` in
258 *--backup*--verbose*)
259 cp_options='--backup=numbered --verbose';;
261 cp_options='-f';;
262 esac
266 # Like 'git config NAME VALUE' but verbose on change and exiting on failure.
267 # Also, do not configure unless requested.
269 git_config ()
271 name=$1
272 value=$2
274 ovalue=`git config --get "$name"` && test "$ovalue" = "$value" || {
275 if $do_git; then
276 if $git_was_ok; then
277 echo 'Configuring local git repository...'
278 case $cp_options in
279 --backup=*)
280 config=$git_common_dir/config
281 cp $cp_options --force -- "$config" "$config" || exit;;
282 esac
284 echo "git config $name '$value'"
285 git config "$name" "$value" || exit
287 git_was_ok=false
291 ## Configure Git, if requested.
293 # Get location of Git's common configuration directory. For older Git
294 # versions this is just '.git'. Newer Git versions support worktrees.
296 { test -e .git &&
297 git_common_dir=`git rev-parse --no-flags --git-common-dir 2>/dev/null` &&
298 test -n "$git_common_dir"
299 } || git_common_dir=.git
300 hooks=$git_common_dir/hooks
302 # Check hashes when transferring objects among repositories.
304 git_config transfer.fsckObjects true
307 # Configure 'git diff' hunk header format.
309 git_config diff.elisp.xfuncname \
310 '^\(def[^[:space:]]+[[:space:]]+([^()[:space:]]+)'
311 git_config 'diff.m4.xfuncname' '^((m4_)?define|A._DEFUN(_ONCE)?)\([^),]*'
312 git_config 'diff.make.xfuncname' \
313 '^([$.[:alnum:]_].*:|[[:alnum:]_]+[[:space:]]*([*:+]?[:?]?|!?)=|define .*)'
314 git_config 'diff.shell.xfuncname' \
315 '^([[:space:]]*[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(\)|[[:alpha:]_][[:alnum:]_]*=)'
316 git_config diff.texinfo.xfuncname \
317 '^@node[[:space:]]+([^,[:space:]][^,]+)'
320 # Install Git hooks.
322 tailored_hooks=
323 sample_hooks=
325 for hook in commit-msg pre-commit; do
326 cmp -- build-aux/git-hooks/$hook "$hooks/$hook" >/dev/null 2>&1 ||
327 tailored_hooks="$tailored_hooks $hook"
328 done
329 for hook in applypatch-msg pre-applypatch; do
330 cmp -- "$hooks/$hook.sample" "$hooks/$hook" >/dev/null 2>&1 ||
331 sample_hooks="$sample_hooks $hook"
332 done
334 if test -n "$tailored_hooks$sample_hooks"; then
335 if $do_git; then
336 echo "Installing git hooks..."
338 if test -n "$tailored_hooks"; then
339 for hook in $tailored_hooks; do
340 dst=$hooks/$hook
341 cp $cp_options -- build-aux/git-hooks/$hook "$dst" || exit
342 chmod -- a-w "$dst" || exit
343 done
346 if test -n "$sample_hooks"; then
347 for hook in $sample_hooks; do
348 dst=$hooks/$hook
349 cp $cp_options -- "$dst.sample" "$dst" || exit
350 chmod -- a-w "$dst" || exit
351 done
353 else
354 git_was_ok=false
358 if test ! -f configure; then
359 echo "You can now run '$0 autoconf'."
360 elif test -e .git && test $git_was_ok = false && test $do_git = false; then
361 echo "You can now run '$0 git'."
362 elif test ! -f config.status ||
363 test -n "`find configure src/config.in -newer config.status`"; then
364 echo "You can now run './configure'."
367 exit 0
369 ### autogen.sh ends here