autogen.sh

   1 #!/bin/sh
   2 ### autogen.sh - tool to help build Emacs from a repository checkout
   3
   4 ## Copyright (C) 2011-2019 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 <https://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     vers=`($1 --version) 2> /dev/null` && expr "$vers" : '[^
  49 ]* \([0-9][0-9.]*\).*'
  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     uprog0=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
  76
  77     eval uprog=\$${uprog0}
  78
  79     if [ x"$uprog" = x ]; then
  80         uprog=$1
  81     else
  82         printf '%s' "(using $uprog0=$uprog) "
  83     fi
  84
  85     ## /bin/sh should always define the "command" builtin, but
  86     ## sometimes it does not on hydra.nixos.org.
  87     ## /bin/sh = "BusyBox v1.27.2", "built-in shell (ash)".
  88     ## It seems to be an optional compile-time feature in that shell:
  89     ## see ASH_CMDCMD in <https://git.busybox.net/busybox/tree/shell/ash.c>.
  90     if command -v command > /dev/null 2>&1; then
  91         command -v $uprog > /dev/null || return 1
  92     else
  93         $uprog --version > /dev/null 2>&1 || return 1
  94     fi
  95     have_version=`get_version $uprog` || return 4
  96
  97     have_maj=`major_version $have_version`
  98     need_maj=`major_version $2`
  99
 100     [ x"$have_maj" != x ] && [ x"$need_maj" != x ] || return 3
 101
 102     [ $have_maj -gt $need_maj ] && return 0
 103     [ $have_maj -lt $need_maj ] && return 2
 104
 105     have_min=`minor_version $have_version`
 106     need_min=`minor_version $2`
 107
 108     [ x"$have_min" != x ] && [ x"$need_min" != x ] || return 3
 109
 110     [ $have_min -ge $need_min ] && return 0
 111     return 2
 112 }
 113
 114 do_check=true
 115 do_autoconf=false
 116 do_git=false
 117
 118 for arg; do
 119     case $arg in
 120       --help)
 121         exec echo "$0: usage: $0 [--no-check] [target...]
 122   Targets are: all autoconf git";;
 123       --no-check)
 124         do_check=false;;
 125       all)
 126         do_autoconf=true
 127         test -r .git && do_git=true;;
 128       autoconf)
 129         do_autoconf=true;;
 130       git)
 131         do_git=true;;
 132       *)
 133         echo >&2 "$0: $arg: unknown argument"; exit 1;;
 134     esac
 135 done
 136
 137 case $do_autoconf,$do_git in
 138   false,false)
 139     do_autoconf=true
 140     test -r .git && do_git=true;;
 141 esac
 142
 143 # Generate Autoconf-related files, if requested.
 144
 145 if $do_autoconf; then
 146
 147   if $do_check; then
 148
 149     echo 'Checking whether you have the necessary tools...
 150 (Read INSTALL.REPO for more details on building Emacs)'
 151
 152     missing=
 153
 154     for prog in $progs; do
 155
 156       sprog=`echo "$prog" | sed 's/-/_/g'`
 157
 158       eval min=\$${sprog}_min
 159
 160       printf '%s' "Checking for $prog (need at least version $min) ... "
 161
 162       check_version $prog $min
 163
 164       retval=$?
 165
 166       case $retval in
 167           0) stat="ok" ;;
 168           1) stat="missing" ;;
 169           2) stat="too old" ;;
 170           4) stat="broken?" ;;
 171           *) stat="unable to check" ;;
 172       esac
 173
 174       echo $stat
 175
 176       if [ $retval -ne 0 ]; then
 177           missing="$missing $prog"
 178           eval ${sprog}_why=\""$stat"\"
 179       fi
 180
 181     done
 182
 183
 184     if [ x"$missing" != x ]; then
 185
 186       echo '
 187 Building Emacs from the repository requires the following specialized programs:'
 188
 189       for prog in $progs; do
 190           sprog=`echo "$prog" | sed 's/-/_/g'`
 191
 192           eval min=\$${sprog}_min
 193
 194           echo "$prog (minimum version $min)"
 195       done
 196
 197
 198       echo '
 199 Your system seems to be missing the following tool(s):'
 200
 201       for prog in $missing; do
 202           sprog=`echo "$prog" | sed 's/-/_/g'`
 203
 204           eval why=\$${sprog}_why
 205
 206           echo "$prog ($why)"
 207       done
 208
 209       echo '
 210 If you think you have the required tools, please add them to your PATH
 211 and re-run this script.
 212
 213 Otherwise, please try installing them.
 214 On systems using rpm and yum, try: "yum install PACKAGE"
 215 On systems using dpkg and apt, try: "apt-get install PACKAGE"
 216 Then re-run this script.
 217
 218 If you do not have permission to do this, or if the version provided
 219 by your system is too old, it is normally straightforward to build
 220 these packages from source.  You can find the sources at:
 221
 222 https://ftp.gnu.org/gnu/PACKAGE/
 223
 224 Download the package (make sure you get at least the minimum version
 225 listed above), extract it using tar, then run configure, make,
 226 make install.  Add the installation directory to your PATH and re-run
 227 this script.
 228
 229 If you know that the required versions are in your PATH, but this
 230 script has made an error, then you can simply re-run this script with
 231 the --no-check option.
 232
 233 Please report any problems with this script to bug-gnu-emacs@gnu.org .'
 234
 235       exit 1
 236     fi
 237
 238     echo 'Your system has the required tools.'
 239
 240   fi                            # do_check
 241
 242   # Build aclocal.m4 here so that autoreconf need not use aclocal.
 243   # aclocal is part of Automake and might not be installed, and
 244   # autoreconf skips aclocal if aclocal.m4 is already supplied.
 245   ls m4/*.m4 | LC_ALL=C sort | sed 's,.*\.m4$,m4_include([&]),' \
 246     > aclocal.m4.tmp || exit
 247   if cmp -s aclocal.m4.tmp aclocal.m4; then
 248     rm -f aclocal.m4.tmp
 249   else
 250     echo "Building aclocal.m4 ..."
 251     mv aclocal.m4.tmp aclocal.m4
 252   fi || exit
 253
 254   echo "Running 'autoreconf -fi -I m4' ..."
 255
 256   ## Let autoreconf figure out what, if anything, needs doing.
 257   ## Use autoreconf's -f option in case autoreconf itself has changed.
 258   autoreconf -fi -I m4 || exit
 259 fi
 260
 261
 262 # True if the Git setup was OK before autogen.sh was run.
 263
 264 git_was_ok=true
 265
 266 if $do_git; then
 267     case `cp --help 2>/dev/null` in
 268       *--backup*--verbose*)
 269         cp_options='--backup=numbered --verbose';;
 270       *)
 271         cp_options='-f';;
 272     esac
 273 fi
 274
 275
 276 # Like 'git config NAME VALUE' but verbose on change and exiting on failure.
 277 # Also, do not configure unless requested.
 278
 279 git_config ()
 280 {
 281     $do_git || return
 282
 283     name=$1
 284     value=$2
 285
 286     ovalue=`git config --get "$name"` && test "$ovalue" = "$value" || {
 287        if $git_was_ok; then
 288            echo 'Configuring local git repository...'
 289            case $cp_options in
 290                --backup=*)
 291                    config=$git_common_dir/config
 292                    cp $cp_options --force -- "$config" "$config" || exit;;
 293            esac
 294        fi
 295        echo "git config $name '$value'"
 296        git config "$name" "$value" || exit
 297        git_was_ok=false
 298     }
 299 }
 300
 301 ## Configure Git, if requested.
 302
 303 # Get location of Git's common configuration directory.  For older Git
 304 # versions this is just '.git'.  Newer Git versions support worktrees.
 305
 306 { test -r .git &&
 307   git_common_dir=`git rev-parse --no-flags --git-common-dir 2>/dev/null` &&
 308   test -n "$git_common_dir"
 309 } || git_common_dir=.git
 310 hooks=$git_common_dir/hooks
 311
 312 # Check hashes when transferring objects among repositories.
 313
 314 git_config transfer.fsckObjects true
 315
 316
 317 # Configure 'git diff' hunk header format.
 318
 319 # This xfuncname is based on Git's built-in 'cpp' pattern.
 320 # The first line rejects jump targets and access declarations.
 321 # The second line matches top-level functions and methods.
 322 # The third line matches preprocessor and DEFUN macros.
 323 git_config diff.cpp.xfuncname \
 324 '!^[ \t]*[A-Za-z_][A-Za-z_0-9]*:[[:space:]]*($|/[/*])
 325 ^((::[[:space:]]*)?[A-Za-z_][A-Za-z_0-9]*[[:space:]]*\(.*)$
 326 ^((#define[[:space:]]|DEFUN).*)$'
 327 git_config diff.elisp.xfuncname \
 328            '^\([^[:space:]]*def[^[:space:]]+[[:space:]]+([^()[:space:]]+)'
 329 git_config 'diff.m4.xfuncname' '^((m4_)?define|A._DEFUN(_ONCE)?)\([^),]*'
 330 git_config 'diff.make.xfuncname' \
 331            '^([$.[:alnum:]_].*:|[[:alnum:]_]+[[:space:]]*([*:+]?[:?]?|!?)=|define .*)'
 332 git_config 'diff.shell.xfuncname' \
 333            '^([[:space:]]*[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(\)|[[:alpha:]_][[:alnum:]_]*=)'
 334 git_config diff.texinfo.xfuncname \
 335            '^@node[[:space:]]+([^,[:space:]][^,]+)'
 336
 337
 338 # Install Git hooks.
 339
 340 tailored_hooks=
 341 sample_hooks=
 342
 343 for hook in commit-msg pre-commit prepare-commit-msg; do
 344     cmp -- build-aux/git-hooks/$hook "$hooks/$hook" >/dev/null 2>&1 ||
 345         tailored_hooks="$tailored_hooks $hook"
 346 done
 347
 348 git_sample_hook_src ()
 349 {
 350     hook=$1
 351     src=$hooks/$hook.sample
 352     if test ! -r "$src"; then
 353         case $hook in
 354             applypatch-msg) src=build-aux/git-hooks/commit-msg;;
 355             pre-applypatch) src=build-aux/git-hooks/pre-commit;;
 356         esac
 357     fi
 358 }
 359 for hook in applypatch-msg pre-applypatch; do
 360     git_sample_hook_src $hook
 361     cmp -- "$src" "$hooks/$hook" >/dev/null 2>&1 ||
 362         sample_hooks="$sample_hooks $hook"
 363 done
 364
 365 if test -n "$tailored_hooks$sample_hooks"; then
 366     if $do_git; then
 367         echo "Installing git hooks..."
 368
 369         if test ! -d "$hooks"; then
 370             printf "mkdir -p -- '%s'\\n" "$hooks"
 371             mkdir -p -- "$hooks" || exit
 372         fi
 373
 374         if test -n "$tailored_hooks"; then
 375             for hook in $tailored_hooks; do
 376                 dst=$hooks/$hook
 377                 cp $cp_options -- build-aux/git-hooks/$hook "$dst" || exit
 378                 chmod -- a-w "$dst" || exit
 379             done
 380         fi
 381
 382         if test -n "$sample_hooks"; then
 383             for hook in $sample_hooks; do
 384                 git_sample_hook_src $hook
 385                 dst=$hooks/$hook
 386                 cp $cp_options -- "$src" "$dst" || exit
 387                 chmod -- a-w "$dst" || exit
 388             done
 389         fi
 390     else
 391         git_was_ok=false
 392     fi
 393 fi
 394
 395 if test ! -f configure; then
 396     echo "You can now run '$0 autoconf'."
 397 elif test -r .git && test $git_was_ok = false && test $do_git = false; then
 398     echo "You can now run '$0 git'."
 399 elif test ! -f config.status ||
 400         test -n "`find configure src/config.in -newer config.status`"; then
 401     echo "You can now run './configure'."
 402 fi
 403
 404 exit 0
 405
 406 ### autogen.sh ends here