autogen.sh 9.44 KB
Newer Older
1
#!/bin/sh
2
### autogen.sh - tool to help build Emacs from a repository checkout
3

Paul Eggert's avatar
Paul Eggert committed
4
## Copyright (C) 2011-2017 Free Software Foundation, Inc.
5

6
## Author: Glenn Morris <rgm@gnu.org>
7
## Maintainer: emacs-devel@gnu.org
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

## This file is part of GNU Emacs.

## GNU Emacs is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.

## GNU Emacs is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.

## You should have received a copy of the GNU General Public License
## along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

### Commentary:

26 27
## The Emacs repository does not include the configure script (and
## 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.
30 31 32 33

### Code:

## Tools we need:
34
## Note that we respect the values of AUTOCONF etc, like autoreconf does.
Paul Eggert's avatar
Paul Eggert committed
35
progs="autoconf"
36 37

## Minimum versions we need:
38
autoconf_min=`sed -n 's/^ *AC_PREREQ(\([0-9\.]*\)).*/\1/p' configure.ac`
39 40 41 42 43 44 45 46 47


## $1 = program, eg "autoconf".
## Echo the version string, eg "2.59".
## FIXME does not handle things like "1.4a", but AFAIK those are
## all old versions, so it is OK to fail there.
## Also note that we do not handle micro versions.
get_version ()
{
48
    ## Remove eg "./autogen.sh: line 50: autoconf: command not found".
Glenn Morris's avatar
Glenn Morris committed
49
    $1 --version 2>&1 | sed -e '/not found/d' -e 's/.* //' -n -e '1 s/\([0-9][0-9\.]*\).*/\1/p'
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
}

## $1 = version string, eg "2.59"
## Echo the major version, eg "2".
major_version ()
{
    echo $1 | sed -e 's/\([0-9][0-9]*\)\..*/\1/'
}

## $1 = version string, eg "2.59"
## Echo the minor version, eg "59".
minor_version ()
{
    echo $1 | sed -e 's/[0-9][0-9]*\.\([0-9][0-9]*\).*/\1/'
}

## $1 = program
## $2 = minimum version.
Paul Eggert's avatar
Paul Eggert committed
68
## Return 0 if program is present with version >= minimum version.
69 70 71 72 73
## Return 1 if program is missing.
## Return 2 if program is present but too old.
## Return 3 for unexpected error (eg failed to parse version).
check_version ()
{
Paul Eggert's avatar
Paul Eggert committed
74
    ## Respect, e.g., $AUTOCONF if it is set, like autoreconf does.
Glenn Morris's avatar
Glenn Morris committed
75
    uprog=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
76 77 78 79 80 81

    eval uprog=\$${uprog}

    [ x"$uprog" = x ] && uprog=$1

    have_version=`get_version $uprog`
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

    [ x"$have_version" = x ] && return 1

    have_maj=`major_version $have_version`
    need_maj=`major_version $2`

    [ x"$have_maj" != x ] && [ x"$need_maj" != x ] || return 3

    [ $have_maj -gt $need_maj ] && return 0
    [ $have_maj -lt $need_maj ] && return 2

    have_min=`minor_version $have_version`
    need_min=`minor_version $2`

    [ x"$have_min" != x ] && [ x"$need_min" != x ] || return 3

    [ $have_min -ge $need_min ] && return 0
    return 2
}

102
do_check=true
103
do_autoconf=false
104 105
do_git=false

106
for arg; do
107 108
    case $arg in
      --help)
109 110
	exec echo "$0: usage: $0 [--no-check] [target...]
  Targets are: all autoconf git";;
111
      --no-check)
112
        do_check=false;;
113
      all)
114
	do_autoconf=true
115
	test -e .git && do_git=true;;
116
      autoconf)
117
	do_autoconf=true;;
118 119 120 121 122 123 124
      git)
	do_git=true;;
      *)
	echo >&2 "$0: $arg: unknown argument"; exit 1;;
    esac
done

125 126 127 128
case $do_autoconf,$do_git in
  false,false)
    do_autoconf=true;;
esac
129

Paul Eggert's avatar
Paul Eggert committed
130
# Generate Autoconf-related files, if requested.
131

132
if $do_autoconf; then
133

134 135 136
  if $do_check; then

    echo 'Checking whether you have the necessary tools...
137
(Read INSTALL.REPO for more details on building Emacs)'
138

139
    missing=
140

141
    for prog in $progs; do
142

143
      sprog=`echo "$prog" | sed 's/-/_/g'`
Glenn Morris's avatar
Glenn Morris committed
144

145
      eval min=\$${sprog}_min
146

147
      printf '%s' "Checking for $prog (need at least version $min) ... "
148

149
      check_version $prog $min
150

151
      retval=$?
152

153 154 155 156 157 158
      case $retval in
          0) stat="ok" ;;
          1) stat="missing" ;;
          2) stat="too old" ;;
          *) stat="unable to check" ;;
      esac
159

160
      echo $stat
161

162 163 164 165
      if [ $retval -ne 0 ]; then
          missing="$missing $prog"
          eval ${sprog}_why=\""$stat"\"
      fi
166

167
    done
168 169


170
    if [ x"$missing" != x ]; then
171

172
      echo '
173
Building Emacs from the repository requires the following specialized programs:'
174

175 176
      for prog in $progs; do
          sprog=`echo "$prog" | sed 's/-/_/g'`
Glenn Morris's avatar
Glenn Morris committed
177

178
          eval min=\$${sprog}_min
179

180 181
          echo "$prog (minimum version $min)"
      done
182 183


184
      echo '
185
Your system seems to be missing the following tool(s):'
186

187 188
      for prog in $missing; do
          sprog=`echo "$prog" | sed 's/-/_/g'`
Glenn Morris's avatar
Glenn Morris committed
189

190
          eval why=\$${sprog}_why
191

192 193
          echo "$prog ($why)"
      done
194

195
      echo '
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
If you think you have the required tools, please add them to your PATH
and re-run this script.

Otherwise, please try installing them.
On systems using rpm and yum, try: "yum install PACKAGE"
On systems using dpkg and apt, try: "apt-get install PACKAGE"
Then re-run this script.

If you do not have permission to do this, or if the version provided
by your system is too old, it is normally straightforward to build
these packages from source.  You can find the sources at:

ftp://ftp.gnu.org/gnu/PACKAGE/

Download the package (make sure you get at least the minimum version
listed above), extract it using tar, then run configure, make,
make install.  Add the installation directory to your PATH and re-run
this script.

If you know that the required versions are in your PATH, but this
216 217
script has made an error, then you can simply re-run this script with
the --no-check option.
218

219
Please report any problems with this script to bug-gnu-emacs@gnu.org .'
220

221 222 223 224
      exit 1
    fi

    echo 'Your system has the required tools.'
225

226
  fi                            # do_check
227

Paul Eggert's avatar
Paul Eggert committed
228 229 230 231 232 233 234 235 236 237 238
  # Build aclocal.m4 here so that autoreconf need not use aclocal.
  # aclocal is part of Automake and might not be installed, and
  # autoreconf skips aclocal if aclocal.m4 is already supplied.
  ls m4/*.m4 | LC_ALL=C sort | sed 's,.*\.m4$,m4_include([&]),' \
    > aclocal.m4.tmp || exit
  if cmp -s aclocal.m4.tmp aclocal.m4; then
    rm -f aclocal.m4.tmp
  else
    echo "Building aclocal.m4 ..."
    mv aclocal.m4.tmp aclocal.m4
  fi || exit
239 240

  echo "Running 'autoreconf -fi -I m4' ..."
241 242 243

  ## Let autoreconf figure out what, if anything, needs doing.
  ## Use autoreconf's -f option in case autoreconf itself has changed.
Paul Eggert's avatar
Paul Eggert committed
244
  autoreconf -fi -I m4 || exit
245 246 247
fi


248
# True if the Git setup was OK before autogen.sh was run.
249

250
git_was_ok=true
251

252 253 254 255 256 257 258 259
if $do_git; then
    case `cp --help 2>/dev/null` in
      *--backup*--verbose*)
	cp_options='--backup=numbered --verbose';;
      *)
	cp_options='-f';;
    esac
fi
260

261

262 263
# Like 'git config NAME VALUE' but verbose on change and exiting on failure.
# Also, do not configure unless requested.
264

265 266 267 268 269 270 271 272 273 274 275
git_config ()
{
    name=$1
    value=$2

    ovalue=`git config --get "$name"` && test "$ovalue" = "$value" || {
	if $do_git; then
	    if $git_was_ok; then
		echo 'Configuring local git repository...'
		case $cp_options in
		  --backup=*)
276 277
		    config=$git_common_dir/config
		    cp $cp_options --force -- "$config" "$config" || exit;;
278 279 280 281 282 283 284 285 286 287 288
		esac
	    fi
	    echo "git config $name '$value'"
	    git config "$name" "$value" || exit
	fi
	git_was_ok=false
    }
}

## Configure Git, if requested.

289 290 291
# Get location of Git's common configuration directory.  For older Git
# versions this is just '.git'.  Newer Git versions support worktrees.

Paul Eggert's avatar
Paul Eggert committed
292 293 294 295
{ test -e .git &&
  git_common_dir=`git rev-parse --no-flags --git-common-dir 2>/dev/null` &&
  test -n "$git_common_dir"
} || git_common_dir=.git
296 297
hooks=$git_common_dir/hooks

298 299 300 301 302 303
# Check hashes when transferring objects among repositories.

git_config transfer.fsckObjects true


# Configure 'git diff' hunk header format.
304

305 306
git_config diff.elisp.xfuncname \
	   '^\(def[^[:space:]]+[[:space:]]+([^()[:space:]]+)'
307 308 309 310 311
git_config 'diff.m4.xfuncname' '^((m4_)?define|A._DEFUN(_ONCE)?)\([^),]*'
git_config 'diff.make.xfuncname' \
	   '^([$.[:alnum:]_].*:|[[:alnum:]_]+[[:space:]]*([*:+]?[:?]?|!?)=|define .*)'
git_config 'diff.shell.xfuncname' \
	   '^([[:space:]]*[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(\)|[[:alpha:]_][[:alnum:]_]*=)'
312 313
git_config diff.texinfo.xfuncname \
	   '^@node[[:space:]]+([^,[:space:]][^,]+)'
314 315


316
# Install Git hooks.
317

318 319
tailored_hooks=
sample_hooks=
320

321
for hook in commit-msg pre-commit; do
322
    cmp -- build-aux/git-hooks/$hook "$hooks/$hook" >/dev/null 2>&1 ||
323
	tailored_hooks="$tailored_hooks $hook"
324 325
done
for hook in applypatch-msg pre-applypatch; do
326
    cmp -- "$hooks/$hook.sample" "$hooks/$hook" >/dev/null 2>&1 ||
327
	sample_hooks="$sample_hooks $hook"
328
done
329

330 331
if test -n "$tailored_hooks$sample_hooks"; then
    if $do_git; then
332 333 334 335
	echo "Installing git hooks..."

	if test -n "$tailored_hooks"; then
	    for hook in $tailored_hooks; do
336 337 338
		dst=$hooks/$hook
		cp $cp_options -- build-aux/git-hooks/$hook "$dst" || exit
		chmod -- a-w "$dst" || exit
339 340 341 342 343
	    done
	fi

	if test -n "$sample_hooks"; then
	    for hook in $sample_hooks; do
344 345 346
		dst=$hooks/$hook
		cp $cp_options -- "$dst.sample" "$dst" || exit
		chmod -- a-w "$dst" || exit
347 348
	    done
	fi
349 350
    else
	git_was_ok=false
351 352 353
    fi
fi

354 355
if test ! -f configure; then
    echo "You can now run '$0 autoconf'."
356
elif test -e .git && test $git_was_ok = false && test $do_git = false; then
357 358
    echo "You can now run '$0 git'."
elif test ! -f config.status ||
Paul Eggert's avatar
Paul Eggert committed
359
	test -n "`find configure src/config.in -newer config.status`"; then
360 361
    echo "You can now run './configure'."
fi
362 363 364 365

exit 0

### autogen.sh ends here