autogen.sh

   1 #!/bin/sh
   2 ### autogen.sh - tool to help build Emacs from a repository checkout
   3
   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 ## This file is part of GNU Emacs.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 ### Commentary:
  25
  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.
  30
  31 ### Code:
  32
  33 ## Tools we need:
  34 ## Note that we respect the values of AUTOCONF etc, like autoreconf does.
  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 ## $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 ()
  47 {
  48     ## Remove eg "./autogen.sh: line 50: autoconf: command not found".
  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 ## $1 = version string, eg "2.59"
  53 ## Echo the major version, eg "2".
  54 major_version ()
  55 {
  56     echo $1 | sed -e 's/\([0-9][0-9]*\)\..*/\1/'
  57 }
  58
  59 ## $1 = version string, eg "2.59"
  60 ## Echo the minor version, eg "59".
  61 minor_version ()
  62 {
  63     echo $1 | sed -e 's/[0-9][0-9]*\.\([0-9][0-9]*\).*/\1/'
  64 }
  65
  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 ()
  73 {
  74     ## Respect, e.g., $AUTOCONF if it is set, like autoreconf does.
  75     uprog=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
  76
  77     eval uprog=\$${uprog}
  78
  79     [ x"$uprog" = x ] && uprog=$1
  80
  81     have_version=`get_version $uprog`
  82
  83     [ x"$have_version" = x ] && return 1
  84
  85     have_maj=`major_version $have_version`
  86     need_maj=`major_version $2`
  87
  88     [ x"$have_maj" != x ] && [ x"$need_maj" != x ] || return 3
  89
  90     [ $have_maj -gt $need_maj ] && return 0
  91     [ $have_maj -lt $need_maj ] && return 2
  92
  93     have_min=`minor_version $have_version`
  94     need_min=`minor_version $2`
  95
  96     [ x"$have_min" != x ] && [ x"$need_min" != x ] || return 3
  97
  98     [ $have_min -ge $need_min ] && return 0
  99     return 2
 100 }
 101
 102 do_check=true
 103 do_autoconf=false
 104 do_git=false
 105
 106 for arg; do
 107     case $arg in
 108       --help)
 109         exec echo "$0: usage: $0 [--no-check] [target...]
 110   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       git)
 119         do_git=true;;
 120       *)
 121         echo >&2 "$0: $arg: unknown argument"; exit 1;;
 122     esac
 123 done
 124
 125 case $do_autoconf,$do_git in
 126   false,false)
 127     do_autoconf=true;;
 128 esac
 129
 130 # Generate Autoconf-related files, if requested.
 131
 132 if $do_autoconf; then
 133
 134   if $do_check; then
 135
 136     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'`
 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       case $retval in
 154           0) stat="ok" ;;
 155           1) stat="missing" ;;
 156           2) stat="too old" ;;
 157           *) stat="unable to check" ;;
 158       esac
 159
 160       echo $stat
 161
 162       if [ $retval -ne 0 ]; then
 163           missing="$missing $prog"
 164           eval ${sprog}_why=\""$stat"\"
 165       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       for prog in $progs; do
 176           sprog=`echo "$prog" | sed 's/-/_/g'`
 177
 178           eval min=\$${sprog}_min
 179
 180           echo "$prog (minimum version $min)"
 181       done
 182
 183
 184       echo '
 185 Your system seems to be missing the following tool(s):'
 186
 187       for prog in $missing; do
 188           sprog=`echo "$prog" | sed 's/-/_/g'`
 189
 190           eval why=\$${sprog}_why
 191
 192           echo "$prog ($why)"
 193       done
 194
 195       echo '
 196 If you think you have the required tools, please add them to your PATH
 197 and re-run this script.
 198
 199 Otherwise, please try installing them.
 200 On systems using rpm and yum, try: "yum install PACKAGE"
 201 On systems using dpkg and apt, try: "apt-get install PACKAGE"
 202 Then re-run this script.
 203
 204 If you do not have permission to do this, or if the version provided
 205 by your system is too old, it is normally straightforward to build
 206 these packages from source.  You can find the sources at:
 207
 208 ftp://ftp.gnu.org/gnu/PACKAGE/
 209
 210 Download the package (make sure you get at least the minimum version
 211 listed above), extract it using tar, then run configure, make,
 212 make install.  Add the installation directory to your PATH and re-run
 213 this script.
 214
 215 If you know that the required versions are in your PATH, but this
 216 script has made an error, then you can simply re-run this script with
 217 the --no-check option.
 218
 219 Please report any problems with this script to bug-gnu-emacs@gnu.org .'
 220
 221       exit 1
 222     fi
 223
 224     echo 'Your system has the required tools.'
 225
 226   fi                            # do_check
 227
 228   # Build aclocal.m4 here so that autoreconf need not use aclocal.
 229   # aclocal is part of Automake and might not be installed, and
 230   # autoreconf skips aclocal if aclocal.m4 is already supplied.
 231   ls m4/*.m4 | LC_ALL=C sort | sed 's,.*\.m4$,m4_include([&]),' \
 232     > aclocal.m4.tmp || exit
 233   if cmp -s aclocal.m4.tmp aclocal.m4; then
 234     rm -f aclocal.m4.tmp
 235   else
 236     echo "Building aclocal.m4 ..."
 237     mv aclocal.m4.tmp aclocal.m4
 238   fi || exit
 239
 240   echo "Running 'autoreconf -fi -I m4' ..."
 241
 242   ## Let autoreconf figure out what, if anything, needs doing.
 243   ## Use autoreconf's -f option in case autoreconf itself has changed.
 244   autoreconf -fi -I m4 || exit
 245 fi
 246
 247
 248 # True if the Git setup was OK before autogen.sh was run.
 249
 250 git_was_ok=true
 251
 252 if $do_git; then
 253     case `cp --help 2>/dev/null` in
 254       *--backup*--verbose*)
 255         cp_options='--backup=numbered --verbose';;
 256       *)
 257         cp_options='-f';;
 258     esac
 259 fi
 260
 261
 262 # Like 'git config NAME VALUE' but verbose on change and exiting on failure.
 263 # Also, do not configure unless requested.
 264
 265 git_config ()
 266 {
 267     name=$1
 268     value=$2
 269
 270     ovalue=`git config --get "$name"` && test "$ovalue" = "$value" || {
 271         if $do_git; then
 272             if $git_was_ok; then
 273                 echo 'Configuring local git repository...'
 274                 case $cp_options in
 275                   --backup=*)
 276                     config=$git_common_dir/config
 277                     cp $cp_options --force -- "$config" "$config" || exit;;
 278                 esac
 279             fi
 280             echo "git config $name '$value'"
 281             git config "$name" "$value" || exit
 282         fi
 283         git_was_ok=false
 284     }
 285 }
 286
 287 ## Configure Git, if requested.
 288
 289 # Get location of Git's common configuration directory.  For older Git
 290 # versions this is just '.git'.  Newer Git versions support worktrees.
 291
 292 { test -e .git &&
 293   git_common_dir=`git rev-parse --no-flags --git-common-dir 2>/dev/null` &&
 294   test -n "$git_common_dir"
 295 } || git_common_dir=.git
 296 hooks=$git_common_dir/hooks
 297
 298 # Check hashes when transferring objects among repositories.
 299
 300 git_config transfer.fsckObjects true
 301
 302
 303 # Configure 'git diff' hunk header format.
 304
 305 git_config diff.elisp.xfuncname \
 306            '^\(def[^[:space:]]+[[:space:]]+([^()[:space:]]+)'
 307 git_config 'diff.m4.xfuncname' '^((m4_)?define|A._DEFUN(_ONCE)?)\([^),]*'
 308 git_config 'diff.make.xfuncname' \
 309            '^([$.[:alnum:]_].*:|[[:alnum:]_]+[[:space:]]*([*:+]?[:?]?|!?)=|define .*)'
 310 git_config 'diff.shell.xfuncname' \
 311            '^([[:space:]]*[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(\)|[[:alpha:]_][[:alnum:]_]*=)'
 312 git_config diff.texinfo.xfuncname \
 313            '^@node[[:space:]]+([^,[:space:]][^,]+)'
 314
 315
 316 # Install Git hooks.
 317
 318 tailored_hooks=
 319 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 done
 325 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 if test -n "$tailored_hooks$sample_hooks"; then
 331     if $do_git; then
 332         echo "Installing git hooks..."
 333
 334         if test -n "$tailored_hooks"; then
 335             for hook in $tailored_hooks; do
 336                 dst=$hooks/$hook
 337                 cp $cp_options -- build-aux/git-hooks/$hook "$dst" || exit
 338                 chmod -- a-w "$dst" || exit
 339             done
 340         fi
 341
 342         if test -n "$sample_hooks"; then
 343             for hook in $sample_hooks; do
 344                 dst=$hooks/$hook
 345                 cp $cp_options -- "$dst.sample" "$dst" || exit
 346                 chmod -- a-w "$dst" || exit
 347             done
 348         fi
 349     else
 350         git_was_ok=false
 351     fi
 352 fi
 353
 354 if test ! -f configure; then
 355     echo "You can now run '$0 autoconf'."
 356 elif test -e .git && test $git_was_ok = false && test $do_git = false; then
 357     echo "You can now run '$0 git'."
 358 elif test ! -f config.status ||
 359         test -n "`find configure src/config.in -newer config.status`"; then
 360     echo "You can now run './configure'."
 361 fi
 362
 363 exit 0
 364
 365 ### autogen.sh ends here