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 automake"
  36
  37 ## Minimum versions we need:
  38 autoconf_min=`sed -n 's/^ *AC_PREREQ(\([0-9\.]*\)).*/\1/p' configure.ac`
  39
  40 ## This will need improving if more options are ever added to the
  41 ## AM_INIT_AUTOMAKE call.
  42 automake_min=`sed -n 's/^ *AM_INIT_AUTOMAKE(\([0-9\.]*\)).*/\1/p' configure.ac`
  43
  44
  45 ## $1 = program, eg "autoconf".
  46 ## Echo the version string, eg "2.59".
  47 ## FIXME does not handle things like "1.4a", but AFAIK those are
  48 ## all old versions, so it is OK to fail there.
  49 ## Also note that we do not handle micro versions.
  50 get_version ()
  51 {
  52     ## Remove eg "./autogen.sh: line 50: autoconf: command not found".
  53     $1 --version 2>&1 | sed -e '/not found/d' -e 's/.* //' -n -e '1 s/\([0-9][0-9\.]*\).*/\1/p'
  54 }
  55
  56 ## $1 = version string, eg "2.59"
  57 ## Echo the major version, eg "2".
  58 major_version ()
  59 {
  60     echo $1 | sed -e 's/\([0-9][0-9]*\)\..*/\1/'
  61 }
  62
  63 ## $1 = version string, eg "2.59"
  64 ## Echo the minor version, eg "59".
  65 minor_version ()
  66 {
  67     echo $1 | sed -e 's/[0-9][0-9]*\.\([0-9][0-9]*\).*/\1/'
  68 }
  69
  70 ## $1 = program
  71 ## $2 = minimum version.
  72 ## Return 0 if program is present with version >= minimum version.
  73 ## Return 1 if program is missing.
  74 ## Return 2 if program is present but too old.
  75 ## Return 3 for unexpected error (eg failed to parse version).
  76 check_version ()
  77 {
  78     ## Respect eg $AUTOMAKE if it is set, like autoreconf does.
  79     uprog=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
  80
  81     eval uprog=\$${uprog}
  82
  83     [ x"$uprog" = x ] && uprog=$1
  84
  85     have_version=`get_version $uprog`
  86
  87     [ x"$have_version" = x ] && return 1
  88
  89     have_maj=`major_version $have_version`
  90     need_maj=`major_version $2`
  91
  92     [ x"$have_maj" != x ] && [ x"$need_maj" != x ] || return 3
  93
  94     [ $have_maj -gt $need_maj ] && return 0
  95     [ $have_maj -lt $need_maj ] && return 2
  96
  97     have_min=`minor_version $have_version`
  98     need_min=`minor_version $2`
  99
 100     [ x"$have_min" != x ] && [ x"$need_min" != x ] || return 3
 101
 102     [ $have_min -ge $need_min ] && return 0
 103     return 2
 104 }
 105
 106 do_check=true
 107 do_autoconf=false
 108 do_git=false
 109
 110 for arg; do
 111     case $arg in
 112       --help)
 113         exec echo "$0: usage: $0 [--no-check] [target...]
 114   Targets are: all autoconf git";;
 115       --no-check)
 116         do_check=false;;
 117       all)
 118         do_autoconf=true
 119         test -e .git && do_git=true;;
 120       autoconf)
 121         do_autoconf=true;;
 122       git)
 123         do_git=true;;
 124       *)
 125         echo >&2 "$0: $arg: unknown argument"; exit 1;;
 126     esac
 127 done
 128
 129 case $do_autoconf,$do_git in
 130   false,false)
 131     do_autoconf=true;;
 132 esac
 133
 134 # Generate Autoconf and Automake related files, if requested.
 135
 136 if $do_autoconf; then
 137
 138   if $do_check; then
 139
 140     echo 'Checking whether you have the necessary tools...
 141 (Read INSTALL.REPO for more details on building Emacs)'
 142
 143     missing=
 144
 145     for prog in $progs; do
 146
 147       sprog=`echo "$prog" | sed 's/-/_/g'`
 148
 149       eval min=\$${sprog}_min
 150
 151       printf '%s' "Checking for $prog (need at least version $min) ... "
 152
 153       check_version $prog $min
 154
 155       retval=$?
 156
 157       case $retval in
 158           0) stat="ok" ;;
 159           1) stat="missing" ;;
 160           2) stat="too old" ;;
 161           *) stat="unable to check" ;;
 162       esac
 163
 164       echo $stat
 165
 166       if [ $retval -ne 0 ]; then
 167           missing="$missing $prog"
 168           eval ${sprog}_why=\""$stat"\"
 169       fi
 170
 171     done
 172
 173
 174     if [ x"$missing" != x ]; then
 175
 176       echo '
 177 Building Emacs from the repository requires the following specialized programs:'
 178
 179       for prog in $progs; do
 180           sprog=`echo "$prog" | sed 's/-/_/g'`
 181
 182           eval min=\$${sprog}_min
 183
 184           echo "$prog (minimum version $min)"
 185       done
 186
 187
 188       echo '
 189 Your system seems to be missing the following tool(s):'
 190
 191       for prog in $missing; do
 192           sprog=`echo "$prog" | sed 's/-/_/g'`
 193
 194           eval why=\$${sprog}_why
 195
 196           echo "$prog ($why)"
 197       done
 198
 199       echo '
 200 If you think you have the required tools, please add them to your PATH
 201 and re-run this script.
 202
 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.
 207
 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:
 211
 212 ftp://ftp.gnu.org/gnu/PACKAGE/
 213
 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.
 218
 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.
 222
 223 Please report any problems with this script to bug-gnu-emacs@gnu.org .'
 224
 225       exit 1
 226     fi
 227
 228     echo 'Your system has the required tools.'
 229
 230   fi                            # do_check
 231
 232   ## Create nt/gnulib.mk if it doesn't exist, as autoreconf will need it.
 233   if test ! -f nt/gnulib.mk; then
 234       echo 'Inferring nt/gnulib.mk from lib/gnulib.mk ...'
 235       metascript='/^[^#]/s|^.*$|/^## begin  *gnulib module &/,/^## end  *gnulib module &/d|p'
 236       script=`sed -n "$metascript" nt/gnulib-modules-to-delete.cfg` || exit
 237       sed "$script" lib/gnulib.mk > nt/gnulib.mk || exit
 238   fi
 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
 246   ## Create a timestamp, so that './autogen.sh; make' doesn't
 247   ## cause 'make' to needlessly run 'autoheader'.
 248   echo timestamp > src/stamp-h.in || exit
 249 fi
 250
 251
 252 # True if the Git setup was OK before autogen.sh was run.
 253
 254 git_was_ok=true
 255
 256 if $do_git; then
 257     case `cp --help 2>/dev/null` in
 258       *--backup*--verbose*)
 259         cp_options='--backup=numbered --verbose';;
 260       *)
 261         cp_options='-f';;
 262     esac
 263 fi
 264
 265
 266 # Like 'git config NAME VALUE' but verbose on change and exiting on failure.
 267 # Also, do not configure unless requested.
 268
 269 git_config ()
 270 {
 271     name=$1
 272     value=$2
 273
 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
 283             fi
 284             echo "git config $name '$value'"
 285             git config "$name" "$value" || exit
 286         fi
 287         git_was_ok=false
 288     }
 289 }
 290
 291 ## Configure Git, if requested.
 292
 293 # Get location of Git's common configuration directory.  For older Git
 294 # versions this is just '.git'.  Newer Git versions support worktrees.
 295
 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
 301
 302 # Check hashes when transferring objects among repositories.
 303
 304 git_config transfer.fsckObjects true
 305
 306
 307 # Configure 'git diff' hunk header format.
 308
 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:]][^,]+)'
 318
 319
 320 # Install Git hooks.
 321
 322 tailored_hooks=
 323 sample_hooks=
 324
 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
 333
 334 if test -n "$tailored_hooks$sample_hooks"; then
 335     if $do_git; then
 336         echo "Installing git hooks..."
 337
 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
 344         fi
 345
 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
 352         fi
 353     else
 354         git_was_ok=false
 355     fi
 356 fi
 357
 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 src/stamp-h.in -newer config.status`"; then
 364     echo "You can now run './configure'."
 365 fi
 366
 367 exit 0
 368
 369 ### autogen.sh ends here