autogen.sh 10.3 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-2019 Free Software Foundation, Inc.
5

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
## Author: Glenn Morris <rgm@gnu.org>

## 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
21
## along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
22 23 24

### Commentary:

25 26
## The Emacs repository does not include the configure script (and
## associated helpers).  The first time you fetch Emacs from the repo,
27
## run this script to generate the necessary files.
28
## For more details, see the file INSTALL.REPO.
29 30 31 32

### Code:

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

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


## $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 ()
{
47 48
    vers=`($1 --version) 2> /dev/null` && expr "$vers" : '[^
]* \([0-9][0-9.]*\).*'
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
}

## $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
67
## Return 0 if program is present with version >= minimum version.
68 69 70 71 72
## 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
73
    ## Respect, e.g., $AUTOCONF if it is set, like autoreconf does.
74
    uprog0=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
75

76
    eval uprog=\$${uprog0}
77

78 79 80 81 82
    if [ x"$uprog" = x ]; then
        uprog=$1
    else
        printf '%s' "(using $uprog0=$uprog) "
    fi
83

Glenn Morris's avatar
Glenn Morris committed
84 85 86 87 88
    ## /bin/sh should always define the "command" builtin, but
    ## sometimes it does not on hydra.nixos.org.
    ## /bin/sh = "BusyBox v1.27.2", "built-in shell (ash)".
    ## It seems to be an optional compile-time feature in that shell:
    ## see ASH_CMDCMD in <https://git.busybox.net/busybox/tree/shell/ash.c>.
89
    if command -v command > /dev/null 2>&1; then
90 91 92 93
        command -v $uprog > /dev/null || return 1
    else
        $uprog --version > /dev/null 2>&1 || return 1
    fi
94
    have_version=`get_version $uprog` || return 4
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

    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
}

113
do_check=true
114
do_autoconf=false
115 116
do_git=false

117
for arg; do
118 119
    case $arg in
      --help)
120 121
	exec echo "$0: usage: $0 [--no-check] [target...]
  Targets are: all autoconf git";;
122
      --no-check)
123
        do_check=false;;
124
      all)
125
	do_autoconf=true
126
	test -r .git && do_git=true;;
127
      autoconf)
128
	do_autoconf=true;;
129 130 131 132 133 134 135
      git)
	do_git=true;;
      *)
	echo >&2 "$0: $arg: unknown argument"; exit 1;;
    esac
done

136 137
case $do_autoconf,$do_git in
  false,false)
Paul Eggert's avatar
Paul Eggert committed
138
    do_autoconf=true
139
    test -r .git && do_git=true;;
140
esac
141

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

144
if $do_autoconf; then
145

146 147 148
  if $do_check; then

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

151
    missing=
152

153
    for prog in $progs; do
154

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

157
      eval min=\$${sprog}_min
158

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

161
      check_version $prog $min
162

163
      retval=$?
164

165 166 167 168
      case $retval in
          0) stat="ok" ;;
          1) stat="missing" ;;
          2) stat="too old" ;;
169
          4) stat="broken?" ;;
170 171
          *) stat="unable to check" ;;
      esac
172

173
      echo $stat
174

175 176 177 178
      if [ $retval -ne 0 ]; then
          missing="$missing $prog"
          eval ${sprog}_why=\""$stat"\"
      fi
179

180
    done
181 182


183
    if [ x"$missing" != x ]; then
184

185
      echo '
186
Building Emacs from the repository requires the following specialized programs:'
187

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

191
          eval min=\$${sprog}_min
192

193 194
          echo "$prog (minimum version $min)"
      done
195 196


197
      echo '
198
Your system seems to be missing the following tool(s):'
199

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

203
          eval why=\$${sprog}_why
204

205 206
          echo "$prog ($why)"
      done
207

208
      echo '
209 210 211 212 213 214 215 216 217 218 219 220
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:

221
https://ftp.gnu.org/gnu/PACKAGE/
222 223 224 225 226 227 228

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
229 230
script has made an error, then you can simply re-run this script with
the --no-check option.
231

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

234 235 236 237
      exit 1
    fi

    echo 'Your system has the required tools.'
238

239
  fi                            # do_check
240

Paul Eggert's avatar
Paul Eggert committed
241 242 243 244 245 246 247 248 249 250 251
  # 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
252 253

  echo "Running 'autoreconf -fi -I m4' ..."
254 255 256

  ## 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
257
  autoreconf -fi -I m4 || exit
258 259 260
fi


261
# True if the Git setup was OK before autogen.sh was run.
262

263
git_was_ok=true
264

265 266 267 268 269 270 271 272
if $do_git; then
    case `cp --help 2>/dev/null` in
      *--backup*--verbose*)
	cp_options='--backup=numbered --verbose';;
      *)
	cp_options='-f';;
    esac
fi
273

274

275 276
# Like 'git config NAME VALUE' but verbose on change and exiting on failure.
# Also, do not configure unless requested.
277

278 279
git_config ()
{
280 281
    $do_git || return

282 283 284 285
    name=$1
    value=$2

    ovalue=`git config --get "$name"` && test "$ovalue" = "$value" || {
286 287 288 289 290 291 292 293 294 295 296
       if $git_was_ok; then
	   echo 'Configuring local git repository...'
	   case $cp_options in
	       --backup=*)
		   config=$git_common_dir/config
		   cp $cp_options --force -- "$config" "$config" || exit;;
	   esac
       fi
       echo "git config $name '$value'"
       git config "$name" "$value" || exit
       git_was_ok=false
297 298 299 300 301
    }
}

## Configure Git, if requested.

302 303 304
# Get location of Git's common configuration directory.  For older Git
# versions this is just '.git'.  Newer Git versions support worktrees.

305
{ test -r .git &&
Paul Eggert's avatar
Paul Eggert committed
306 307 308
  git_common_dir=`git rev-parse --no-flags --git-common-dir 2>/dev/null` &&
  test -n "$git_common_dir"
} || git_common_dir=.git
309 310
hooks=$git_common_dir/hooks

311 312 313 314 315 316
# Check hashes when transferring objects among repositories.

git_config transfer.fsckObjects true


# Configure 'git diff' hunk header format.
317

318 319
git_config diff.elisp.xfuncname \
	   '^\(def[^[:space:]]+[[:space:]]+([^()[:space:]]+)'
320 321 322 323 324
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:]_]*=)'
325 326
git_config diff.texinfo.xfuncname \
	   '^@node[[:space:]]+([^,[:space:]][^,]+)'
327 328


329
# Install Git hooks.
330

331 332
tailored_hooks=
sample_hooks=
333

334
for hook in commit-msg pre-commit; do
335
    cmp -- build-aux/git-hooks/$hook "$hooks/$hook" >/dev/null 2>&1 ||
336
	tailored_hooks="$tailored_hooks $hook"
337
done
338 339 340 341 342 343 344 345 346 347 348 349

git_sample_hook_src ()
{
    hook=$1
    src=$hooks/$hook.sample
    if test ! -r "$src"; then
	case $hook in
	    applypatch-msg) src=build-aux/git-hooks/commit-msg;;
	    pre-applypatch) src=build-aux/git-hooks/pre-commit;;
	esac
    fi
}
350
for hook in applypatch-msg pre-applypatch; do
351 352
    git_sample_hook_src $hook
    cmp -- "$src" "$hooks/$hook" >/dev/null 2>&1 ||
353
	sample_hooks="$sample_hooks $hook"
354
done
355

356 357
if test -n "$tailored_hooks$sample_hooks"; then
    if $do_git; then
358 359
	echo "Installing git hooks..."

360 361 362 363 364
	if test ! -d "$hooks"; then
	    printf "mkdir -p -- '%s'\\n" "$hooks"
	    mkdir -p -- "$hooks" || exit
	fi

365 366
	if test -n "$tailored_hooks"; then
	    for hook in $tailored_hooks; do
367 368 369
		dst=$hooks/$hook
		cp $cp_options -- build-aux/git-hooks/$hook "$dst" || exit
		chmod -- a-w "$dst" || exit
370 371 372 373 374
	    done
	fi

	if test -n "$sample_hooks"; then
	    for hook in $sample_hooks; do
375
		git_sample_hook_src $hook
376
		dst=$hooks/$hook
377
		cp $cp_options -- "$src" "$dst" || exit
378
		chmod -- a-w "$dst" || exit
379 380
	    done
	fi
381 382
    else
	git_was_ok=false
383 384 385
    fi
fi

386 387
if test ! -f configure; then
    echo "You can now run '$0 autoconf'."
388
elif test -r .git && test $git_was_ok = false && test $do_git = false; then
389 390
    echo "You can now run '$0 git'."
elif test ! -f config.status ||
Paul Eggert's avatar
Paul Eggert committed
391
	test -n "`find configure src/config.in -newer config.status`"; then
392 393
    echo "You can now run './configure'."
fi
394 395 396 397

exit 0

### autogen.sh ends here