More fixes in the Emacs manual
[emacs.git] / autogen.sh
blobacebc2381a3f675d8566fa139f857cf025df6537
1 #!/bin/sh
2 ### autogen.sh - tool to help build Emacs from a repository checkout
4 ## Copyright (C) 2011-2018 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 <https://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 -r .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 test -r .git && do_git=true;;
132 esac
134 # Generate Autoconf-related files, if requested.
136 if $do_autoconf; then
138 if $do_check; then
140 echo 'Checking whether you have the necessary tools...
141 (Read INSTALL.REPO for more details on building Emacs)'
143 missing=
145 for prog in $progs; do
147 sprog=`echo "$prog" | sed 's/-/_/g'`
149 eval min=\$${sprog}_min
151 printf '%s' "Checking for $prog (need at least version $min) ... "
153 check_version $prog $min
155 retval=$?
157 case $retval in
158 0) stat="ok" ;;
159 1) stat="missing" ;;
160 2) stat="too old" ;;
161 4) stat="broken?" ;;
162 *) stat="unable to check" ;;
163 esac
165 echo $stat
167 if [ $retval -ne 0 ]; then
168 missing="$missing $prog"
169 eval ${sprog}_why=\""$stat"\"
172 done
175 if [ x"$missing" != x ]; then
177 echo '
178 Building Emacs from the repository requires the following specialized programs:'
180 for prog in $progs; do
181 sprog=`echo "$prog" | sed 's/-/_/g'`
183 eval min=\$${sprog}_min
185 echo "$prog (minimum version $min)"
186 done
189 echo '
190 Your system seems to be missing the following tool(s):'
192 for prog in $missing; do
193 sprog=`echo "$prog" | sed 's/-/_/g'`
195 eval why=\$${sprog}_why
197 echo "$prog ($why)"
198 done
200 echo '
201 If you think you have the required tools, please add them to your PATH
202 and re-run this script.
204 Otherwise, please try installing them.
205 On systems using rpm and yum, try: "yum install PACKAGE"
206 On systems using dpkg and apt, try: "apt-get install PACKAGE"
207 Then re-run this script.
209 If you do not have permission to do this, or if the version provided
210 by your system is too old, it is normally straightforward to build
211 these packages from source. You can find the sources at:
213 https://ftp.gnu.org/gnu/PACKAGE/
215 Download the package (make sure you get at least the minimum version
216 listed above), extract it using tar, then run configure, make,
217 make install. Add the installation directory to your PATH and re-run
218 this script.
220 If you know that the required versions are in your PATH, but this
221 script has made an error, then you can simply re-run this script with
222 the --no-check option.
224 Please report any problems with this script to bug-gnu-emacs@gnu.org .'
226 exit 1
229 echo 'Your system has the required tools.'
231 fi # do_check
233 # Build aclocal.m4 here so that autoreconf need not use aclocal.
234 # aclocal is part of Automake and might not be installed, and
235 # autoreconf skips aclocal if aclocal.m4 is already supplied.
236 ls m4/*.m4 | LC_ALL=C sort | sed 's,.*\.m4$,m4_include([&]),' \
237 > aclocal.m4.tmp || exit
238 if cmp -s aclocal.m4.tmp aclocal.m4; then
239 rm -f aclocal.m4.tmp
240 else
241 echo "Building aclocal.m4 ..."
242 mv aclocal.m4.tmp aclocal.m4
243 fi || exit
245 echo "Running 'autoreconf -fi -I m4' ..."
247 ## Let autoreconf figure out what, if anything, needs doing.
248 ## Use autoreconf's -f option in case autoreconf itself has changed.
249 autoreconf -fi -I m4 || exit
253 # True if the Git setup was OK before autogen.sh was run.
255 git_was_ok=true
257 if $do_git; then
258 case `cp --help 2>/dev/null` in
259 *--backup*--verbose*)
260 cp_options='--backup=numbered --verbose';;
262 cp_options='-f';;
263 esac
267 # Like 'git config NAME VALUE' but verbose on change and exiting on failure.
268 # Also, do not configure unless requested.
270 git_config ()
272 $do_git || return
274 name=$1
275 value=$2
277 ovalue=`git config --get "$name"` && test "$ovalue" = "$value" || {
278 if $git_was_ok; then
279 echo 'Configuring local git repository...'
280 case $cp_options in
281 --backup=*)
282 config=$git_common_dir/config
283 cp $cp_options --force -- "$config" "$config" || exit;;
284 esac
286 echo "git config $name '$value'"
287 git config "$name" "$value" || exit
288 git_was_ok=false
292 ## Configure Git, if requested.
294 # Get location of Git's common configuration directory. For older Git
295 # versions this is just '.git'. Newer Git versions support worktrees.
297 { test -r .git &&
298 git_common_dir=`git rev-parse --no-flags --git-common-dir 2>/dev/null` &&
299 test -n "$git_common_dir"
300 } || git_common_dir=.git
301 hooks=$git_common_dir/hooks
303 # Check hashes when transferring objects among repositories.
305 git_config transfer.fsckObjects true
308 # Configure 'git diff' hunk header format.
310 git_config diff.elisp.xfuncname \
311 '^\(def[^[:space:]]+[[:space:]]+([^()[:space:]]+)'
312 git_config 'diff.m4.xfuncname' '^((m4_)?define|A._DEFUN(_ONCE)?)\([^),]*'
313 git_config 'diff.make.xfuncname' \
314 '^([$.[:alnum:]_].*:|[[:alnum:]_]+[[:space:]]*([*:+]?[:?]?|!?)=|define .*)'
315 git_config 'diff.shell.xfuncname' \
316 '^([[:space:]]*[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(\)|[[:alpha:]_][[:alnum:]_]*=)'
317 git_config diff.texinfo.xfuncname \
318 '^@node[[:space:]]+([^,[:space:]][^,]+)'
321 # Install Git hooks.
323 tailored_hooks=
324 sample_hooks=
326 for hook in commit-msg pre-commit; do
327 cmp -- build-aux/git-hooks/$hook "$hooks/$hook" >/dev/null 2>&1 ||
328 tailored_hooks="$tailored_hooks $hook"
329 done
331 git_sample_hook_src ()
333 hook=$1
334 src=$hooks/$hook.sample
335 if test ! -r "$src"; then
336 case $hook in
337 applypatch-msg) src=build-aux/git-hooks/commit-msg;;
338 pre-applypatch) src=build-aux/git-hooks/pre-commit;;
339 esac
342 for hook in applypatch-msg pre-applypatch; do
343 git_sample_hook_src $hook
344 cmp -- "$src" "$hooks/$hook" >/dev/null 2>&1 ||
345 sample_hooks="$sample_hooks $hook"
346 done
348 if test -n "$tailored_hooks$sample_hooks"; then
349 if $do_git; then
350 echo "Installing git hooks..."
352 if test ! -d "$hooks"; then
353 printf "mkdir -p -- '%s'\\n" "$hooks"
354 mkdir -p -- "$hooks" || exit
357 if test -n "$tailored_hooks"; then
358 for hook in $tailored_hooks; do
359 dst=$hooks/$hook
360 cp $cp_options -- build-aux/git-hooks/$hook "$dst" || exit
361 chmod -- a-w "$dst" || exit
362 done
365 if test -n "$sample_hooks"; then
366 for hook in $sample_hooks; do
367 git_sample_hook_src $hook
368 dst=$hooks/$hook
369 cp $cp_options -- "$src" "$dst" || exit
370 chmod -- a-w "$dst" || exit
371 done
373 else
374 git_was_ok=false
378 if test ! -f configure; then
379 echo "You can now run '$0 autoconf'."
380 elif test -r .git && test $git_was_ok = false && test $do_git = false; then
381 echo "You can now run '$0 git'."
382 elif test ! -f config.status ||
383 test -n "`find configure src/config.in -newer config.status`"; then
384 echo "You can now run './configure'."
387 exit 0
389 ### autogen.sh ends here