make-dist

   1 #!/bin/sh
   2
   3 #### make-dist: create an Emacs distribution tar file from the current
   4 #### source tree.  This basically creates a duplicate directory
   5 #### structure, and then hard links into it only those files that should
   6 #### be distributed.  This means that if you add a file with an odd name,
   7 #### you should make sure that this script will include it.
   8
   9 # Copyright (C) 1995 Free Software Foundation, Inc.
  10 #
  11 # This file is part of GNU Emacs.
  12 #
  13 # GNU Emacs is free software; you can redistribute it and/or modify
  14 # it under the terms of the GNU General Public License as published by
  15 # the Free Software Foundation; either version 2, or (at your option)
  16 # any later version.
  17 #
  18 # GNU Emacs is distributed in the hope that it will be useful,
  19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 # GNU General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with GNU Emacs; see the file COPYING.  If not, write to the
  25 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  26 # Boston, MA 02111-1307, USA.
  27
  28 progname="$0"
  29
  30 ### Exit if a command fails.
  31 ### set -e
  32
  33 ### Print out each line we read, for debugging's sake.
  34 ### set -v
  35
  36 ## Don't protect any files.
  37 umask 0
  38
  39 update=yes
  40 clean_up=no
  41 make_tar=no
  42 newer=""
  43
  44 while [ $# -gt 0 ]; do
  45   case "$1" in
  46     ## This option tells make-dist to delete the staging directory
  47     ## when done.  It is useless to use this unless you make a tar file.
  48     "--clean-up" )
  49       clean_up=yes
  50     ;;
  51     ## This option tells make-dist to make a tar file.
  52     "--tar" )
  53       make_tar=yes
  54     ;;
  55     ## This option tells make-dist not to recompile or do analogous things.
  56     "--no-update" )
  57       update=no
  58     ;;
  59     ## This option tells make-dist to make the distribution normally, then
  60     ## remove all files older than the given timestamp file.  This is useful
  61     ## for creating incremental or patch distributions.
  62     "--newer")
  63       newer="$2"
  64       new_extension=".new"
  65       shift
  66     ;;
  67     ## This option tells make-dist to use `compress' instead of gzip.
  68     ## Normally, make-dist uses gzip whenever it is present.
  69     "--compress")
  70       default_gzip="compress"
  71     ;;
  72     * )
  73       echo "${progname}: Unrecognized argument: $1" >&2
  74       exit 1
  75     ;;
  76   esac
  77   shift
  78 done
  79
  80 ### Make sure we're running in the right place.
  81 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/version.el ]; then
  82   echo "${progname}: Can't find \`src/lisp.h' and \`lisp/version.el'." >&2
  83   echo "${progname} must be run in the top directory of the Emacs" >&2
  84   echo "distribution tree.  cd to that directory and try again." >&2
  85   exit 1
  86 fi
  87
  88 ### Find where to run Emacs.
  89 if [ $update = yes ];
  90 then
  91   if [ -f src/emacs ];
  92   then
  93     EMACS=`pwd`/src/emacs
  94   else
  95     if [ x$EMACS = x ];
  96     then
  97       echo You must specify the EMACS environment variable 2>&1
  98       exit 1
  99     fi
 100   fi
 101 fi
 102
 103 ### Find out which version of Emacs this is.
 104 shortversion=`grep 'defconst[    ]*emacs-version' lisp/version.el \
 105          | sed -e 's/^.*"\([0-9][0-9]*\.[0-9][0-9]*\).*$/\1/'`
 106 version=`grep 'defconst[         ]*emacs-version' lisp/version.el \
 107          | sed -e 's/^[^"]*"\([^"]*\)".*$/\1/'`
 108 if [ ! "${version}" ]; then
 109   echo "${progname}: can't find current Emacs version in \`./lisp/version.el'" >&2
 110   exit 1
 111 fi
 112
 113 echo Version numbers are $version and $shortversion
 114
 115 if [ $update = yes ];
 116 then
 117   if grep -s "GNU Emacs version ${shortversion}" ./man/emacs.texi > /dev/null; then
 118     true
 119   else
 120     echo "You must update the version number in \`./man/emacs.texi'"
 121     sleep 5
 122   fi
 123 fi
 124
 125 ### Make sure we don't already have a directory  emacs-${version}.
 126
 127 emacsname="emacs-${version}${new_extension}"
 128
 129 if [ -d ${emacsname} ]
 130 then
 131   echo Directory "${emacsname}" already exists >&2
 132   exit 1
 133 fi
 134
 135 ### Make sure the subdirectory is available.
 136 tempparent="make-dist.tmp.$$"
 137 if [ -d ${tempparent} ]; then
 138   echo "${progname}: staging directory \`${tempparent}' already exists.
 139 Perhaps a previous invocation of \`${progname}' failed to clean up after
 140 itself.  Check that directories whose names are of the form
 141 \`make-dist.tmp.NNNNN' don't contain any important information, remove
 142 them, and try again." >&2
 143   exit 1
 144 fi
 145
 146 ### Check for .elc files with no corresponding .el file.
 147 ls -1 lisp/[a-z]*.el | sed 's/\.el$/.elc/' > /tmp/el
 148 ls -1 lisp/[a-z]*.elc > /tmp/elc
 149 bogosities="`comm -13 /tmp/el /tmp/elc`"
 150 if [ "${bogosities}" != "" ]; then
 151   echo "The following .elc files have no corresponding .el files:"
 152   echo "${bogosities}"
 153 fi
 154 rm -f /tmp/el /tmp/elc
 155
 156 ### Check for .el files with no corresponding .elc file.
 157 (cd lisp; ls -1 [a-z]*.el) > /tmp/el
 158 (cd lisp; ls -1 [a-z]*.elc) | sed 's/\.elc$/.el/' > /tmp/elc
 159 losers="`comm -23 /tmp/el /tmp/elc`"
 160 for file in $losers; do
 161   if ! grep -q "dontcompilefiles:.* $file\($\| \)" lisp/Makefile; then
 162     bogosities="$file $bogosities"
 163   fi
 164 done
 165 if [ "${bogosities}" != "" ]; then
 166   echo "The following .elc files have no corresponding .el files:"
 167   echo "${bogosities}"
 168 fi
 169 rm -f /tmp/el /tmp/elc
 170
 171 ### Check for .el files that would overflow the 14-char limit if compiled.
 172 long=`find lisp -name '[a-zA-Z0-9]??????????*.el' -print`
 173 if [ "$long" != "" ]; then
 174   echo "The following .el file names are too long:"
 175   echo "$long"
 176 fi
 177
 178 ### Make sure configure is newer than configure.in.
 179 if [ "x`ls -t configure configure.in | head -1`" != "xconfigure" ]; then
 180   echo "\`./configure.in' is newer than \`./configure'" >&2
 181   echo "Running autoconf" >&2
 182   autoconf || { x=$?; echo Autoconf FAILED! >&2; exit $x; }
 183 fi
 184
 185 if [ $update = yes ];
 186 then
 187   echo "Updating Info files"
 188
 189   (cd man; make info)
 190
 191   echo "Recompiling Lisp files"
 192
 193   $EMACS -batch -f batch-byte-recompile-directory lisp
 194
 195   echo "Updating finder, custom and autoload data"
 196
 197   (cd lisp; make updates)
 198 fi
 199
 200 echo "Making lisp/MANIFEST"
 201
 202 (cd lisp; head -1 [!=]*.el | grep '^;' | sed -e 's/;;; //' > MANIFEST)
 203
 204 echo "Creating staging directory: \`${tempparent}'"
 205
 206 mkdir ${tempparent}
 207 tempdir="${tempparent}/${emacsname}"
 208
 209 ### This trap ensures that the staging directory will be cleaned up even
 210 ### when the script is interrupted in mid-career.
 211 if [ "${clean_up}" = yes ]; then
 212   trap "echo 'Interrupted...cleaning up the staging directory'; rm -rf ${tempparent}; exit 1" 1 2 15
 213 fi
 214
 215 echo "Creating top directory: \`${tempdir}'"
 216 mkdir ${tempdir}
 217
 218 ### We copy in the top-level files before creating the subdirectories in
 219 ### hopes that this will make the top-level files appear first in the
 220 ### tar file; this means that people can start reading the INSTALL and
 221 ### README while the rest of the tar file is still unpacking.  Whoopee.
 222 echo "Making links to top-level files"
 223 ln GETTING.GNU.SOFTWARE INSTALL PROBLEMS README BUGS move-if-change ${tempdir}
 224 ln ChangeLog Makefile.in configure configure.in ${tempdir}
 225 ln config.bat make-dist update-subdirs vpath.sed ${tempdir}
 226 ### Copy these files; they're cross-filesystem symlinks.
 227 cp mkinstalldirs ${tempdir}
 228 cp config.sub ${tempdir}
 229 cp config.guess ${tempdir}
 230 cp install.sh ${tempdir}
 231
 232 echo "Updating version number in README"
 233 (cd ${tempdir}
 234  awk \
 235    '$1 " " $2 " " $3 " " $4 " " $5 == "This directory tree holds version" { $6 = version; print $0 }
 236     $1 " " $2 " " $3 " " $4 " " $5 != "This directory tree holds version"' \
 237    version=${version} README > tmp.README
 238  mv tmp.README README)
 239
 240
 241 echo "Creating subdirectories"
 242 for subdir in lisp site-lisp \
 243               src src/m src/s src/bitmaps lib-src oldXMenu lwlib \
 244               nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet \
 245               etc etc/e lock cpp info man msdos vms; do
 246   mkdir ${tempdir}/${subdir}
 247 done
 248
 249 echo "Making links to \`lisp' and its subdirectories"
 250 ### Don't distribute TAGS, =*.el files, site-init.el, site-load.el, or default.el.
 251 (cd lisp
 252  ln [a-zA-Z]*.el ../${tempdir}/lisp
 253  ln [a-zA-Z]*.elc ../${tempdir}/lisp
 254  ln [a-zA-Z]*.dat ../${tempdir}/lisp
 255  ## simula.el doesn't keep abbreviations in simula.defns any more.
 256  ## ln [a-zA-Z]*.defns ../${tempdir}/lisp
 257  ln ChangeLog Makefile makefile.nt ChangeLog.? README ../${tempdir}/lisp
 258  (cd ../${tempdir}/lisp
 259   rm -f TAGS =*
 260   rm -f site-init site-init.el site-init.elc
 261   rm -f site-load site-load.el site-load.elc
 262   rm -f site-start site-start.el site-start.elc
 263   rm -f default default.el default.elc
 264   )
 265
 266  ## Find all subdirs of lisp dir
 267  for file in `find . -type d -print`; do
 268    case $file in
 269      . | .. | */Old | */RCS)
 270        ;;
 271      *)
 272        if [ -d $file ]; then
 273          subdirs="$file $subdirs"
 274        fi
 275        ;;
 276    esac
 277  done
 278
 279  for file in $subdirs; do
 280    echo "  lisp/$file"
 281    mkdir ../${tempdir}/lisp/$file
 282    ln $file/[a-zA-Z]*.el ../${tempdir}/lisp/$file
 283    ln $file/[a-zA-Z]*.elc ../${tempdir}/lisp/$file
 284    if [ -f $file/README ]; then
 285      ln $file/README ../${tempdir}/lisp/$file
 286    fi
 287    rm -f $file/=* $file/TAGS
 288  done )
 289
 290 echo "Making links to \`src'"
 291 ### Don't distribute =*.[ch] files, or the configured versions of
 292 ### config.in, paths.in, or Makefile.in, or TAGS.
 293 (cd src
 294  echo "  (It is ok if ln fails in some cases.)"
 295  ln [a-zA-Z]*.c ../${tempdir}/src
 296  ln [a-zA-Z]*.h ../${tempdir}/src
 297  ln [a-zA-Z]*.s ../${tempdir}/src
 298  ln [a-zA-Z]*.in ../${tempdir}/src
 299  ln [a-zA-Z]*.opt ../${tempdir}/src
 300  ## If we ended up with a symlink, or if we did not get anything
 301  ## due to a cross-device symlink, copy the file.
 302  for file in [a-zA-Z]*.[hcs] [a-zA-Z]*.in [a-zA-Z]*.opt; do
 303    if test -f ../${tempdir}/src/$file; then
 304      # test -f appears to succeed for a symlink
 305      if test -L ../${tempdir}/src/$file; then
 306        rm ../${tempdir}/src/$file
 307        cp $file ../${tempdir}/src
 308        chmod a-w ../${tempdir}/src/$file
 309      fi
 310    else
 311      rm ../${tempdir}/src/$file
 312      cp $file ../${tempdir}/src
 313      chmod a-w ../${tempdir}/src/$file
 314    fi
 315  done
 316  ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
 317  ln makefile.nt vms-pp.trans ../${tempdir}/src
 318  ln .gdbinit .dbxinit ../${tempdir}/src
 319  cd ../${tempdir}/src
 320  rm -f config.h paths.h Makefile Makefile.c
 321  rm -f =* TAGS)
 322
 323 echo "Making links to \`src/bitmaps'"
 324 (cd src/bitmaps
 325  ln README *.xbm ../../${tempdir}/src/bitmaps)
 326
 327 echo "Making links to \`src/m'"
 328 (cd src/m
 329  # We call files for miscellaneous input (to linker etc) .inp.
 330  ln README [a-zA-Z0-9]*.h *.inp ../../${tempdir}/src/m)
 331
 332 echo "Making links to \`src/s'"
 333 (cd src/s
 334  ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/s)
 335
 336 echo "Making links to \`lib-src'"
 337 (cd lib-src
 338  ln [a-zA-Z]*.[chy] ../${tempdir}/lib-src
 339  ln ChangeLog Makefile.in README testfile vcdiff ../${tempdir}/lib-src
 340  ln emacs.csh rcs2log rcs-checkin makefile.nt ../${tempdir}/lib-src
 341  ## If we ended up with a symlink, or if we did not get anything
 342  ## due to a cross-device symlink, copy the file.
 343  for file in [a-zA-Z]*.[chy]; do
 344    if test -f ../${tempdir}/lib-src/$file; then
 345      # test -f appears to succeed for a symlink
 346      if test -L ../${tempdir}/lib-src/$file; then
 347        rm ../${tempdir}/lib-src/$file
 348        cp $file ../${tempdir}/lib-src
 349        chmod a-w ../${tempdir}/lib-src/$file
 350      fi
 351    else
 352      rm ../${tempdir}/lib-src/$file
 353      cp $file ../${tempdir}/lib-src
 354      chmod a-w ../${tempdir}/lib-src/$file
 355    fi
 356  done
 357  cd ../${tempdir}/lib-src
 358  rm -f Makefile.c
 359  rm -f =* TAGS)
 360
 361 echo "Making links to \`nt'"
 362 (cd nt
 363  ln emacs.ico emacs.rc config.nt [a-z]*.in [a-z]*.c ../${tempdir}/nt
 364  ln [a-z]*.bat [a-z]*.h makefile.def makefile.nt ../${tempdir}/nt
 365  ln TODO ChangeLog INSTALL README ../${tempdir}/nt)
 366
 367 echo "Making links to \`nt/inc'"
 368 (cd nt/inc
 369  ln [a-z]*.h ../../${tempdir}/nt/inc)
 370
 371 echo "Making links to \`nt/inc/sys'"
 372 (cd nt/inc/sys
 373  ln [a-z]*.h ../../../${tempdir}/nt/inc/sys)
 374
 375 echo "Making links to \`nt/inc/arpa'"
 376 (cd nt/inc/arpa
 377  ln [a-z]*.h ../../../${tempdir}/nt/inc/arpa)
 378
 379 echo "Making links to \`nt/inc/netinet'"
 380 (cd nt/inc/netinet
 381  ln [a-z]*.h ../../../${tempdir}/nt/inc/netinet)
 382
 383 echo "Making links to \`msdos'"
 384 (cd msdos
 385  ln  ChangeLog emacs.ico emacs.pif ../${tempdir}/msdos
 386  ln is_exec.c sigaction.c mainmake mainmake.v2 sed*.inp ../${tempdir}/msdos
 387  cd ../${tempdir}/msdos
 388  rm -f =*)
 389
 390 echo "Making links to \`oldXMenu'"
 391 (cd oldXMenu
 392  ln *.c *.h *.in ../${tempdir}/oldXMenu
 393  ln README Imakefile ChangeLog ../${tempdir}/oldXMenu
 394  ln compile.com descrip.mms ../${tempdir}/oldXMenu)
 395
 396 echo "Making links to \`lwlib'"
 397 (cd lwlib
 398  ln *.c *.h *.in ../${tempdir}/lwlib
 399  ln README Imakefile ChangeLog ../${tempdir}/lwlib
 400  cd ../${tempdir}/lwlib
 401  rm -f lwlib-Xol*)
 402
 403 echo "Making links to \`etc'"
 404 ### Don't distribute = files, TAGS, DOC files, backups, autosaves, or
 405 ### tex litter.
 406 (cd etc
 407  ln `ls -d * | grep -v 'RCS' | grep -v 'Old' | grep -v '^e$'` ../${tempdir}/etc
 408  cd ../${tempdir}/etc
 409  rm -f DOC* *~ \#*\# *.dvi *.log *.orig *.rej *,v =* core
 410  rm -f TAGS)
 411
 412 echo "Making links to \`etc/e'"
 413 (cd etc/e
 414  ln `ls -d * | grep -v 'RCS'` ../../${tempdir}/etc/e
 415  cd ../../${tempdir}/etc/e
 416  rm -f *~ \#*\# *,v =* core)
 417
 418 echo "Making links to \`cpp'"
 419 (cd cpp
 420  ln cccp.c cexp.y Makefile README ../${tempdir}/cpp)
 421
 422 echo "Making links to \`info'"
 423 # Don't distribute backups or autosaves.
 424 (cd info
 425  ln [a-zA-Z]* ../${tempdir}/info
 426  cd ../${tempdir}/info
 427  # Avoid an error when expanding the wildcards later.
 428  ln emacs dummy~ ; ln emacs \#dummy\#
 429  rm -f *~ \#*\# core)
 430
 431 echo "Making links to \`man'"
 432 (cd man
 433  ln *.texi *.aux *.cps *.fns *.kys *.vrs ../${tempdir}/man
 434  test -f README && ln README ../${tempdir}/man
 435  test -f Makefile.in && ln Makefile.in ../${tempdir}/man
 436  ln ChangeLog split-man ../${tempdir}/man
 437  cp texinfo.tex ../${tempdir}/man
 438  cd ../${tempdir}/man
 439  rm -f \#*\# =* *~ core emacs-index* *.Z *.z xmail
 440  rm -f emacs.?? termcap.?? gdb.?? *.log *.toc *.dvi *.oaux)
 441
 442 echo "Making links to \`vms'"
 443 (cd vms
 444  ln [0-9a-zA-Z]* ../${tempdir}/vms
 445  cd ../${tempdir}/vms
 446  rm -f *~)
 447
 448 ### It would be nice if they could all be symlinks to etc's copy, but
 449 ### you're not supposed to have any symlinks in distribution tar files.
 450 echo "Making sure copying notices are all copies of \`etc/COPYING'"
 451 rm -f ${tempdir}/etc/COPYING
 452 cp etc/COPYING ${tempdir}/etc/COPYING
 453 for subdir in lisp src lib-src info msdos; do
 454   if [ -f ${tempdir}/${subdir}/COPYING ]; then
 455     rm ${tempdir}/${subdir}/COPYING
 456   fi
 457   cp etc/COPYING ${tempdir}/${subdir}
 458 done
 459
 460 #### Make sure that there aren't any hard links between files in the
 461 #### distribution; people with afs can't deal with that.  Okay,
 462 #### actually we just re-copy anything with a link count greater
 463 #### than two.  (Yes, strictly greater than 2 is correct; since we
 464 #### created these files by linking them in from the original tree,
 465 #### they'll have exactly two links normally.)
 466 ####
 467 #### Commented out since it's not strictly necessary; it should suffice
 468 #### to just break the link on alloca.c.
 469 #echo "Breaking intra-tree links."
 470 #find ${tempdir} ! -type d -links +2 \
 471 #  -exec cp -p {} $$ \; -exec rm -f {} \; -exec mv $$ {} \;
 472 rm -f $tempdir/lib-src/alloca.c
 473 cp $tempdir/src/alloca.c $tempdir/lib-src/alloca.c
 474
 475 if [ "${newer}" ]; then
 476   echo "Removing files older than $newer"
 477   ## We remove .elc files unconditionally, on the theory that anyone picking
 478   ## up an incremental distribution already has a running Emacs to byte-compile
 479   ## them with.
 480   find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
 481 fi
 482
 483 if [ "${make_tar}" = yes ]; then
 484   if [ "${default_gzip}" = "" ]; then
 485     echo "Looking for gzip"
 486     temppath=`echo $PATH | sed 's/^:/.:/
 487                                 s/::/:.:/g
 488                                 s/:$/:./
 489                                 s/:/ /g'`
 490     default_gzip=`(
 491       for dir in ${temppath}; do
 492         if [ -f ${dir}/gzip ]; then echo 'gzip --best'; exit 0; fi
 493       done
 494       echo compress
 495     )`
 496   fi
 497   case "${default_gzip}" in
 498     compress* ) gzip_extension=.Z ;;
 499     * )         gzip_extension=.gz ;;
 500   esac
 501   echo "Creating tar file"
 502   (cd ${tempparent} ; tar cvf - ${emacsname} ) \
 503     | ${default_gzip} \
 504     > ${emacsname}.tar${gzip_extension}
 505 fi
 506
 507 if [ "${clean_up}" = yes ]; then
 508   echo "Cleaning up the staging directory"
 509   rm -rf ${tempparent}
 510 else
 511   (cd ${tempparent}; mv ${emacsname} ..)
 512   rm -rf ${tempparent}
 513 fi
 514
 515 ### make-dist ends here