admin/quick-install-emacs

   1 #!/bin/sh
   2 ### quick-install-emacs --- do a halfway-decent job of installing emacs quickly
   3
   4 ## Copyright (C) 2001-2014 Free Software Foundation, Inc.
   5
   6 ## Author: Miles Bader <miles@gnu.org>
   7
   8 ## This file is part of GNU Emacs.
   9
  10 ## GNU Emacs is free software: you can redistribute it and/or modify
  11 ## it under the terms of the GNU General Public License as published by
  12 ## the Free Software Foundation, either version 3 of the License, or
  13 ## (at your option) any later version.
  14
  15 ## GNU Emacs is distributed in the hope that it will be useful,
  16 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ## GNU General Public License for more details.
  19
  20 ## You should have received a copy of the GNU General Public License
  21 ## along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23
  24 ### Commentary:
  25
  26 ## This script is mainly intended for emacs maintainer or pretesters who
  27 ## install emacs very often.  See the --help output for more details.
  28
  29
  30 PUBLIC_LIBSRC_BINARIES='emacsclient etags ctags ebrowse'
  31 PUBLIC_LIBSRC_SCRIPTS='grep-changelog'
  32
  33 AVOID="CVS -DIC README COPYING ChangeLog ~ [.]orig$ [.]rej$ Makefile$ Makefile.in$ makefile$ makefile.w32-in$ stamp-subdir [.]cvsignore [.]arch-ids [{]arch[}] [.][cho]$ make-docfile"
  34
  35 # Prune old binaries lying around in the source tree
  36 PRUNE=no
  37 # Re-install files even if they already exist
  38 FORCE=no
  39 # Command verbose flag
  40 VERBOSE=''
  41
  42 me="`basename $0`"
  43
  44 # Install commands (if the user specifies the `--verbose' option, it is
  45 # passed to these commands, so that feature only works if these commands
  46 # implement it too)
  47 LINK='cp -lf'
  48 COPY='cp -f'
  49 REMOVE='rm -r'
  50 MKDIR='mkdir -p'
  51
  52 # Used to execute commands once we create them
  53 EXEC='sh'
  54
  55 NAWK=/usr/bin/nawk
  56
  57 # avoid non-standard command output from non-C locales
  58 unset LANG LC_ALL LC_MESSAGES
  59
  60 # Some messages
  61 USAGE="Usage: $me [OPTION...] BUILD_TREE [PREFIX]"
  62 TRY="Try "\`"$me --help' for more information."
  63
  64 # Parse command-line options
  65 while :; do
  66   case "$1" in
  67     -n|--dry-run)
  68       EXEC=cat; shift;;
  69     -p|--prune)
  70       PRUNE=yes; shift;;
  71     -P|--no-prune)
  72       PRUNE=no; shift;;
  73     --prune-only)
  74       PRUNE=only; shift;;
  75     -f|--force)
  76       FORCE=yes; shift;;
  77     -v|--verbose)
  78       VERBOSE="-v"; shift;;
  79     --help)
  80       cat <<EOF
  81 $USAGE
  82 Install emacs quickly
  83
  84   -n, --dry-run              print installation commands instead of
  85                              executing them
  86
  87   -f, --force                install even files that haven't changed
  88   -v, --verbose              print messages describing what is done
  89
  90   -p, --prune                prune old generated files
  91   -P, --no-prune             don't prune old generated files (default)
  92       --prune-only           prune old generated files, but don't install
  93
  94       --help                 display this help and exit
  95       --version              output version information and exit
  96
  97 $me install emacs \`incrementally,' that is, it will
  98 install only those files that have changed since the last time it was
  99 invoked, and remove any obsolete files from the installation
 100 directories.  It also uses hard-links into the source and build trees to
 101 do the install, so it uses much less space than the default Makefile
 102 install target; however, this also means that $me can
 103 not install onto a disk partition other than the one on which the source
 104 and build directories reside.
 105
 106 Optionally, $me can also remove old versions of
 107 automatically generated files that are version-specific (such as the
 108 versioned emacs executables in the \`src' directory).
 109 The latter action is called \`pruning,' and
 110 can be enabled using the \`-p' or \`--prune' options.
 111 EOF
 112       exit 0
 113       ;;
 114     --version)
 115       cat <<EOF
 116 $me 1.6
 117
 118 Written by Miles Bader <miles@gnu.org>
 119 EOF
 120       exit 0
 121       ;;
 122     -[!-]?*)
 123       # split concatenated single-letter options apart
 124       FIRST="$1"; shift
 125       set -- `echo $FIRST | sed 's/-\(.\)\(.*\)/-\1 -\2/'` "$@"
 126       ;;
 127     -*)
 128       echo 1>&2 "$me: unrecognized option "\`"$1'"
 129       echo 1>&2 "$TRY"
 130       exit 1
 131       ;;
 132     *)
 133       break;
 134   esac
 135 done
 136
 137 LINK_CMD="$LINK $VERBOSE"
 138 REMOVE_CMD="$REMOVE $VERBOSE"
 139
 140 case $# in
 141   1) BUILD="$1";;
 142   2) BUILD="$1"; prefix="$2";;
 143   *)
 144     echo 1>&2 "$USAGE"
 145     echo 1>&2 "$TRY"
 146     exit 1
 147     ;;
 148 esac
 149
 150 if test ! -d "$BUILD"; then
 151   echo 1>&2 "$me: $BUILD: Build tree not found"
 152   exit 2
 153 elif test ! -r "$BUILD/config.status"; then
 154   echo 1>&2 "$me: $BUILD: Not a proper build tree, config.status not found"
 155   exit 2
 156 fi
 157
 158 CONFIG_STATUS="$BUILD/config.status"
 159 get_config_var ()
 160 {
 161   { sed -n "s/^S[[]\"$1\"[]]=\"\([^\"]*\)\"/\1/p" $CONFIG_STATUS | sed q | grep ''; } ||
 162   { sed -n "s/^s\(.\)@$1@\1\(|#_!!_#|\)*\(.*\)\1.*$/\3/p" $CONFIG_STATUS | sed q | grep ''; } ||
 163   {
 164     echo 1>&2 "$me: $1: Configuration variable not found in $CONFIG_STATUS"
 165     exit 4
 166   }
 167 }
 168
 169 test x"$SRC" = x && { SRC="`get_config_var srcdir`" || exit 4 ; }
 170 test x"$prefix" = x && { prefix="`get_config_var prefix`" || exit 4 ; }
 171 test x"$ARCH" = x && { ARCH="`get_config_var host`" || exit 4 ; }
 172
 173 VERSION=`
 174   sed -n 's/^AC_INIT(emacs,[     ]*\([^  )]*\).*/\1/p' <$SRC/configure.ac
 175 ` || exit 4
 176 test -n "$VERSION" || { echo >&2 "$me: no version in configure.ac"; exit 4; }
 177
 178 DST_SHARE="$prefix/share/emacs/$VERSION"
 179 DST_BIN="$prefix/bin"
 180 DST_LIBEXEC="$prefix/libexec/emacs/$VERSION/$ARCH"
 181
 182 # There are various common places for the info dir to be, so try to
 183 # use whatever's already there, defaulting to (and preferring)
 184 # .../share/info.
 185 #
 186 DST_INFO=''
 187 for D in "$prefix/share/info" "$prefix/info"; do
 188   if test -d "$D"; then
 189     DST_INFO="$D"
 190     break
 191   fi
 192 done
 193 DST_INFO=${DST_INFO:-"$prefix/share/info"}
 194
 195 maybe_mkdir ()
 196 {
 197   if ! test -d "$1"; then
 198     $MKDIR $VERBOSE "$1" 2>&1 | sed "s/^mkdir:/$me:/" 1>&2
 199   fi
 200 }
 201
 202 maybe_mkdir "$DST_BIN"
 203 maybe_mkdir "$DST_SHARE"
 204 maybe_mkdir "$DST_SHARE/site-lisp"
 205 maybe_mkdir "$DST_LIBEXEC"
 206 maybe_mkdir "$DST_INFO"
 207
 208 (  # start of command-generating sub-shell
 209
 210 PRUNED=""
 211 if test x"$PRUNE" != xno; then
 212   for D in `ls -1t $BUILD/src/emacs-$VERSION.* | sed 1d`; do
 213     echo $REMOVE_CMD $D
 214     PRUNED="$PRUNED $D"
 215   done
 216 fi
 217
 218 test x"$PRUNE" = xonly && exit 0
 219
 220 maybe_emit_copy ()
 221 {
 222   if test "$FORCE" = yes || ! cmp -s $1 $2; then
 223     echo $LINK_CMD $1 $2
 224   fi
 225 }
 226
 227 maybe_emit_copy $BUILD/src/emacs $DST_BIN/emacs
 228 maybe_emit_copy $BUILD/src/emacs $DST_BIN/emacs-$VERSION
 229
 230 for F in $PUBLIC_LIBSRC_BINARIES; do
 231   maybe_emit_copy $BUILD/lib-src/$F $DST_BIN/$F
 232 done
 233 for F in $PUBLIC_LIBSRC_SCRIPTS; do
 234   maybe_emit_copy $SRC/lib-src/$F $DST_BIN/$F
 235 done
 236
 237 if test x"$SRC" = x"$BUILD"; then
 238   PFXS="$BUILD"
 239 else
 240   PFXS="$SRC $BUILD"
 241 fi
 242
 243 for SUBDIR in lisp leim etc lib-src info; do
 244   # defaults
 245   SHARED=no
 246   FORCED=''
 247   AVOID_PAT="`echo "($AVOID)" | tr ' ' '|'`"
 248
 249   # Set subdir-specific values
 250   case $SUBDIR in
 251     lisp|leim)
 252       DST="$DST_SHARE/$SUBDIR"
 253       ;;
 254     etc)
 255       DST="$DST_SHARE/$SUBDIR"
 256       # COPYING is in the avoid list, but there should be a copy of it in
 257       # the install etc dir, so make that here.
 258       FORCED="$DST/COPYING"
 259       ;;
 260     lib-src)
 261       DST="$DST_LIBEXEC"
 262       AVOID_PAT="`echo "($AVOID ($PUBLIC_LIBSRC_BINARIES $PUBLIC_LIBSRC_SCRIPTS)\$)" | tr ' ' '|'`"
 263       ;;
 264     info)
 265       DST="$DST_INFO"
 266       SHARED=yes
 267       ;;
 268   esac
 269
 270   for PFX in $PFXS; do
 271     if [ -d $PFX/$SUBDIR ]; then
 272       for DIR in `(cd $PFX/$SUBDIR; find . -type d -print | sed 's@^./@@')`; do
 273         if [ -d $DST/$DIR ]; then
 274           echo Directory $DST/$DIR exists
 275         else
 276           echo Directory $DST/$DIR non-existent
 277           if [ "`echo $DIR | egrep -v "$AVOID_PAT"`" ]; then
 278             maybe_mkdir $DST/$DIR
 279           fi
 280         fi
 281       done
 282       diff -sqr $PFX/$SUBDIR $DST
 283     fi
 284   done | $NAWK '
 285 BEGIN {
 286   src_pat = "^'"$SRC"'/'"$SUBDIR"'/"
 287   build_pat = "^'"$BUILD"'/'"$SUBDIR"'/"
 288   dst_pat = "^'"$DST"'/"
 289   dst_pfx = "'"$DST"'/"
 290   avoid_pat = "'"$AVOID_PAT"'"
 291   force = ("'"$FORCE"'" == "yes")
 292   shared = ("'"$SHARED"'" == "yes")
 293   init_bool_array(pruned, "'"$PRUNED"'")
 294   init_bool_array(forced, "'"$FORCED"'")
 295 }
 296 function init_bool_array(array, string,  a,k)
 297 {
 298   split (string, a)
 299   for (k in a)
 300     array[a[k]] = 1
 301 }
 302 function install(src, dst)
 303 {
 304   if (! (src in pruned)) {
 305     cp[src] = dst;
 306     from[dst] = src;
 307     delete rm[dst];
 308   }
 309 }
 310 function update(src, dst, copy)
 311 {
 312   if (src in pruned) {
 313     rm[dst] = 1;
 314     delete from[dst]
 315   } else {
 316     if (copy)
 317       cp[src] = dst;
 318     from[dst] = src;
 319     delete rm[dst];
 320   }
 321 }
 322 function uninstall(dst)
 323 {
 324   if (!(dst in from))
 325     rm[dst] = 1;
 326 }
 327 /^Directory / {
 328   if ($2 ~ avoid_pat) {
 329     if ($NF == "exists")
 330       uninstall($2)
 331   } else
 332     update(0, $2, 0)
 333   next
 334 }
 335 /^Files / {
 336   if ($4 ~ avoid_pat && !($4 in forced))
 337     uninstall($4)
 338   else if ($NF == "identical")
 339     update($2, $4, force)
 340   else
 341     update($2, $4, 1)
 342   next
 343 }
 344 /^Only /  {
 345   pfx = $3
 346   sub (/:$/, "/", pfx)
 347
 348   if (pfx ~ dst_pat) {
 349     if (! shared)
 350       uninstall(pfx $4)
 351   } else {
 352     subdir = pfx
 353     if (subdir ~ src_pat)
 354       sub (src_pat, "", subdir)
 355     else
 356       sub (build_pat, "", subdir)
 357
 358     dst = dst_pfx subdir $4
 359     if (! (dst ~ avoid_pat))
 360       install(pfx $4, dst)
 361   }
 362   next
 363 }
 364 END {
 365   for (f in rm)
 366     print "'"$REMOVE_CMD"' " f
 367   for (f in cp)
 368     print "'"$LINK_CMD"' " f " " cp[f]
 369 }
 370 '
 371 done
 372
 373 ) | eval $EXEC