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, 1997 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 bogosities=
 161 for file in $losers; do
 162   if ! grep -q "dontcompilefiles:.* $file\($\| \)" lisp/Makefile; then
 163     bogosities="$file $bogosities"
 164   fi
 165 done
 166 if [ "${bogosities}" != "" ]; then
 167   echo "The following .el files have no corresponding .elc files:"
 168   echo "${bogosities}"
 169 fi
 170 rm -f /tmp/el /tmp/elc
 171
 172 ### Check for .el files that would overflow the 14-char limit if compiled.
 173 long=`find lisp -name '[a-zA-Z0-9]??????????*.el' -print`
 174 if [ "$long" != "" ]; then
 175   echo "The following .el file names are too long:"
 176   echo "$long"
 177 fi
 178
 179 ### Make sure configure is newer than configure.in.
 180 if [ "x`ls -t configure configure.in | head -1`" != "xconfigure" ]; then
 181   echo "\`./configure.in' is newer than \`./configure'" >&2
 182   echo "Running autoconf" >&2
 183   autoconf || { x=$?; echo Autoconf FAILED! >&2; exit $x; }
 184 fi
 185
 186 if [ $update = yes ];
 187 then
 188   echo "Updating Info files"
 189
 190   (cd man; make info)
 191
 192   echo "Recompiling Lisp files"
 193
 194   $EMACS -batch -f batch-byte-recompile-directory lisp
 195
 196   echo "Updating finder, custom and autoload data"
 197
 198   (cd lisp; make updates)
 199 fi
 200
 201 echo "Making lisp/MANIFEST"
 202
 203 (cd lisp; head -1 [!=]*.el | grep '^;' | sed -e 's/;;; //' > MANIFEST)
 204
 205 echo "Creating staging directory: \`${tempparent}'"
 206
 207 mkdir ${tempparent}
 208 tempdir="${tempparent}/${emacsname}"
 209
 210 ### This trap ensures that the staging directory will be cleaned up even
 211 ### when the script is interrupted in mid-career.
 212 if [ "${clean_up}" = yes ]; then
 213   trap "echo 'Interrupted...cleaning up the staging directory'; rm -rf ${tempparent}; exit 1" 1 2 15
 214 fi
 215
 216 echo "Creating top directory: \`${tempdir}'"
 217 mkdir ${tempdir}
 218
 219 ### We copy in the top-level files before creating the subdirectories in
 220 ### hopes that this will make the top-level files appear first in the
 221 ### tar file; this means that people can start reading the INSTALL and
 222 ### README while the rest of the tar file is still unpacking.  Whoopee.
 223 echo "Making links to top-level files"
 224 ln GETTING.GNU.SOFTWARE INSTALL PROBLEMS README BUGS move-if-change ${tempdir}
 225 ln ChangeLog Makefile.in configure configure.in ${tempdir}
 226 ln config.bat make-dist update-subdirs vpath.sed ${tempdir}
 227 ### Copy these files; they're cross-filesystem symlinks.
 228 cp mkinstalldirs ${tempdir}
 229 cp config.sub ${tempdir}
 230 cp config.guess ${tempdir}
 231 cp install.sh ${tempdir}
 232
 233 echo "Updating version number in README"
 234 (cd ${tempdir}
 235  awk \
 236    '$1 " " $2 " " $3 " " $4 " " $5 == "This directory tree holds version" { $6 = version; print $0 }
 237     $1 " " $2 " " $3 " " $4 " " $5 != "This directory tree holds version"' \
 238    version=${version} README > tmp.README
 239  mv tmp.README README)
 240
 241
 242 echo "Creating subdirectories"
 243 for subdir in lisp site-lisp \
 244               src src/m src/s src/bitmaps lib-src oldXMenu lwlib \
 245               nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet \
 246               etc etc/e lock cpp info man msdos vms; do
 247   mkdir ${tempdir}/${subdir}
 248 done
 249
 250 echo "Making links to \`lisp' and its subdirectories"
 251 ### Don't distribute TAGS, =*.el files, site-init.el, site-load.el, or default.el.
 252 (cd lisp
 253  ln [a-zA-Z]*.el ../${tempdir}/lisp
 254  ln [a-zA-Z]*.elc ../${tempdir}/lisp
 255  ln [a-zA-Z]*.dat ../${tempdir}/lisp
 256  ## simula.el doesn't keep abbreviations in simula.defns any more.
 257  ## ln [a-zA-Z]*.defns ../${tempdir}/lisp
 258  ln ChangeLog Makefile makefile.nt ChangeLog.? README ../${tempdir}/lisp
 259  (cd ../${tempdir}/lisp
 260   rm -f TAGS =*
 261   rm -f site-init site-init.el site-init.elc
 262   rm -f site-load site-load.el site-load.elc
 263   rm -f site-start site-start.el site-start.elc
 264   rm -f default default.el default.elc
 265   )
 266
 267  ## Find all subdirs of lisp dir
 268  for file in `find . -type d -print`; do
 269    case $file in
 270      . | .. | */Old | */RCS | */=*)
 271        ;;
 272      *)
 273        if [ -d $file ]; then
 274          subdirs="$file $subdirs"
 275        fi
 276        ;;
 277    esac
 278  done
 279
 280  for file in $subdirs; do
 281    echo "  lisp/$file"
 282    mkdir ../${tempdir}/lisp/$file
 283    ln $file/[a-zA-Z]*.el ../${tempdir}/lisp/$file
 284    ln $file/[a-zA-Z]*.elc ../${tempdir}/lisp/$file
 285    if [ -f $file/README ]; then
 286      ln $file/README ../${tempdir}/lisp/$file
 287    fi
 288    rm -f $file/=* $file/TAGS
 289  done )
 290
 291 echo "Making links to \`src'"
 292 ### Don't distribute =*.[ch] files, or the configured versions of
 293 ### config.in, paths.in, or Makefile.in, or TAGS.
 294 (cd src
 295  echo "  (It is ok if ln fails in some cases.)"
 296  ln [a-zA-Z]*.c ../${tempdir}/src
 297  ln [a-zA-Z]*.h ../${tempdir}/src
 298  ln [a-zA-Z]*.s ../${tempdir}/src
 299  ln [a-zA-Z]*.in ../${tempdir}/src
 300  ln [a-zA-Z]*.opt ../${tempdir}/src
 301  ## If we ended up with a symlink, or if we did not get anything
 302  ## due to a cross-device symlink, copy the file.
 303  for file in [a-zA-Z]*.[hcs] [a-zA-Z]*.in [a-zA-Z]*.opt; do
 304    if test -f ../${tempdir}/src/$file; then
 305      # test -f appears to succeed for a symlink
 306      if test -L ../${tempdir}/src/$file; then
 307        rm ../${tempdir}/src/$file
 308        cp $file ../${tempdir}/src
 309        chmod a-w ../${tempdir}/src/$file
 310      fi
 311    else
 312      rm ../${tempdir}/src/$file
 313      cp $file ../${tempdir}/src
 314      chmod a-w ../${tempdir}/src/$file
 315    fi
 316  done
 317  ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
 318  ln makefile.nt vms-pp.trans ../${tempdir}/src
 319  ln .gdbinit .dbxinit ../${tempdir}/src
 320  cd ../${tempdir}/src
 321  rm -f config.h paths.h Makefile Makefile.c
 322  rm -f =* TAGS)
 323
 324 echo "Making links to \`src/bitmaps'"
 325 (cd src/bitmaps
 326  ln README *.xbm ../../${tempdir}/src/bitmaps)
 327
 328 echo "Making links to \`src/m'"
 329 (cd src/m
 330  # We call files for miscellaneous input (to linker etc) .inp.
 331  ln README [a-zA-Z0-9]*.h *.inp ../../${tempdir}/src/m)
 332
 333 echo "Making links to \`src/s'"
 334 (cd src/s
 335  ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/s)
 336
 337 echo "Making links to \`lib-src'"
 338 (cd lib-src
 339  ln [a-zA-Z]*.[chy] ../${tempdir}/lib-src
 340  ln ChangeLog Makefile.in README testfile vcdiff ../${tempdir}/lib-src
 341  ln emacs.csh rcs2log rcs-checkin makefile.nt ../${tempdir}/lib-src
 342  ## If we ended up with a symlink, or if we did not get anything
 343  ## due to a cross-device symlink, copy the file.
 344  for file in [a-zA-Z]*.[chy]; do
 345    if test -f ../${tempdir}/lib-src/$file; then
 346      # test -f appears to succeed for a symlink
 347      if test -L ../${tempdir}/lib-src/$file; then
 348        rm ../${tempdir}/lib-src/$file
 349        cp $file ../${tempdir}/lib-src
 350        chmod a-w ../${tempdir}/lib-src/$file
 351      fi
 352    else
 353      rm ../${tempdir}/lib-src/$file
 354      cp $file ../${tempdir}/lib-src
 355      chmod a-w ../${tempdir}/lib-src/$file
 356    fi
 357  done
 358  cd ../${tempdir}/lib-src
 359  rm -f Makefile.c
 360  rm -f =* TAGS)
 361
 362 echo "Making links to \`nt'"
 363 (cd nt
 364  ln emacs.ico emacs.rc config.nt [a-z]*.in [a-z]*.c ../${tempdir}/nt
 365  ln [a-z]*.bat [a-z]*.h makefile.def makefile.nt ../${tempdir}/nt
 366  ln TODO ChangeLog INSTALL README ../${tempdir}/nt)
 367
 368 echo "Making links to \`nt/inc'"
 369 (cd nt/inc
 370  ln [a-z]*.h ../../${tempdir}/nt/inc)
 371
 372 echo "Making links to \`nt/inc/sys'"
 373 (cd nt/inc/sys
 374  ln [a-z]*.h ../../../${tempdir}/nt/inc/sys)
 375
 376 echo "Making links to \`nt/inc/arpa'"
 377 (cd nt/inc/arpa
 378  ln [a-z]*.h ../../../${tempdir}/nt/inc/arpa)
 379
 380 echo "Making links to \`nt/inc/netinet'"
 381 (cd nt/inc/netinet
 382  ln [a-z]*.h ../../../${tempdir}/nt/inc/netinet)
 383
 384 echo "Making links to \`msdos'"
 385 (cd msdos
 386  ln  ChangeLog emacs.ico emacs.pif ../${tempdir}/msdos
 387  ln is_exec.c sigaction.c mainmake mainmake.v2 sed*.inp ../${tempdir}/msdos
 388  cd ../${tempdir}/msdos
 389  rm -f =*)
 390
 391 echo "Making links to \`oldXMenu'"
 392 (cd oldXMenu
 393  ln *.c *.h *.in ../${tempdir}/oldXMenu
 394  ln README Imakefile ChangeLog ../${tempdir}/oldXMenu
 395  ln compile.com descrip.mms ../${tempdir}/oldXMenu)
 396
 397 echo "Making links to \`lwlib'"
 398 (cd lwlib
 399  ln *.c *.h *.in ../${tempdir}/lwlib
 400  ln README Imakefile ChangeLog ../${tempdir}/lwlib
 401  cd ../${tempdir}/lwlib
 402  rm -f lwlib-Xol*)
 403
 404 echo "Making links to \`etc'"
 405 ### Don't distribute = files, TAGS, DOC files, backups, autosaves, or
 406 ### tex litter.
 407 (cd etc
 408  ln `ls -d * | grep -v 'RCS' | grep -v 'Old' | grep -v '^e$'` ../${tempdir}/etc
 409  ## If we ended up with a symlink, or if we did not get anything
 410  ## due to a cross-device symlink, copy the file.
 411  for file in [a-zA-Z]*.[hcs] [a-zA-Z]*.in [a-zA-Z]*.opt; do
 412    if test -f ../${tempdir}/etc/$file; then
 413      # test -f appears to succeed for a symlink
 414      if test -L ../${tempdir}/etc/$file; then
 415        rm ../${tempdir}/etc/$file
 416        cp $file ../${tempdir}/etc
 417        chmod a-w ../${tempdir}/etc/$file
 418      fi
 419    else
 420      rm ../${tempdir}/etc/$file
 421      cp $file ../${tempdir}/etc
 422      chmod a-w ../${tempdir}/etc/$file
 423    fi
 424  done
 425  cd ../${tempdir}/etc
 426  rm -f DOC* *~ \#*\# *.dvi *.log *.orig *.rej *,v =* core
 427  rm -f TAGS)
 428
 429 echo "Making links to \`etc/e'"
 430 (cd etc/e
 431  ln `ls -d * | grep -v 'RCS'` ../../${tempdir}/etc/e
 432  cd ../../${tempdir}/etc/e
 433  rm -f *~ \#*\# *,v =* core)
 434
 435 echo "Making links to \`cpp'"
 436 (cd cpp
 437  ln cccp.c cexp.y Makefile README ../${tempdir}/cpp)
 438
 439 echo "Making links to \`info'"
 440 # Don't distribute backups or autosaves.
 441 (cd info
 442  ln [a-zA-Z]* ../${tempdir}/info
 443  cd ../${tempdir}/info
 444  # Avoid an error when expanding the wildcards later.
 445  ln emacs dummy~ ; ln emacs \#dummy\#
 446  rm -f *~ \#*\# core)
 447
 448 echo "Making links to \`man'"
 449 (cd man
 450  ln *.texi *.aux *.cps *.fns *.kys *.vrs ../${tempdir}/man
 451  test -f README && ln README ../${tempdir}/man
 452  test -f Makefile.in && ln Makefile.in ../${tempdir}/man
 453  ln ChangeLog split-man ../${tempdir}/man
 454  cp texinfo.tex ../${tempdir}/man
 455  cd ../${tempdir}/man
 456  rm -f \#*\# =* *~ core emacs-index* *.Z *.z xmail
 457  rm -f emacs.?? termcap.?? gdb.?? *.log *.toc *.dvi *.oaux)
 458
 459 echo "Making links to \`vms'"
 460 (cd vms
 461  ln [0-9a-zA-Z]* ../${tempdir}/vms
 462  cd ../${tempdir}/vms
 463  rm -f *~)
 464
 465 ### It would be nice if they could all be symlinks to etc's copy, but
 466 ### you're not supposed to have any symlinks in distribution tar files.
 467 echo "Making sure copying notices are all copies of \`etc/COPYING'"
 468 rm -f ${tempdir}/etc/COPYING
 469 cp etc/COPYING ${tempdir}/etc/COPYING
 470 for subdir in lisp src lib-src info msdos; do
 471   if [ -f ${tempdir}/${subdir}/COPYING ]; then
 472     rm ${tempdir}/${subdir}/COPYING
 473   fi
 474   cp etc/COPYING ${tempdir}/${subdir}
 475 done
 476
 477 #### Make sure that there aren't any hard links between files in the
 478 #### distribution; people with afs can't deal with that.  Okay,
 479 #### actually we just re-copy anything with a link count greater
 480 #### than two.  (Yes, strictly greater than 2 is correct; since we
 481 #### created these files by linking them in from the original tree,
 482 #### they'll have exactly two links normally.)
 483 ####
 484 #### Commented out since it's not strictly necessary; it should suffice
 485 #### to just break the link on alloca.c.
 486 #echo "Breaking intra-tree links."
 487 #find ${tempdir} ! -type d -links +2 \
 488 #  -exec cp -p {} $$ \; -exec rm -f {} \; -exec mv $$ {} \;
 489 rm -f $tempdir/lib-src/alloca.c
 490 cp $tempdir/src/alloca.c $tempdir/lib-src/alloca.c
 491
 492 if [ "${newer}" ]; then
 493   echo "Removing files older than $newer"
 494   ## We remove .elc files unconditionally, on the theory that anyone picking
 495   ## up an incremental distribution already has a running Emacs to byte-compile
 496   ## them with.
 497   find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
 498 fi
 499
 500 if [ "${make_tar}" = yes ]; then
 501   if [ "${default_gzip}" = "" ]; then
 502     echo "Looking for gzip"
 503     temppath=`echo $PATH | sed 's/^:/.:/
 504                                 s/::/:.:/g
 505                                 s/:$/:./
 506                                 s/:/ /g'`
 507     default_gzip=`(
 508       for dir in ${temppath}; do
 509         if [ -f ${dir}/gzip ]; then echo 'gzip --best'; exit 0; fi
 510       done
 511       echo compress
 512     )`
 513   fi
 514   case "${default_gzip}" in
 515     compress* ) gzip_extension=.Z ;;
 516     * )         gzip_extension=.gz ;;
 517   esac
 518   echo "Creating tar file"
 519   (cd ${tempparent} ; tar cvf - ${emacsname} ) \
 520     | ${default_gzip} \
 521     > ${emacsname}.tar${gzip_extension}
 522 fi
 523
 524 if [ "${clean_up}" = yes ]; then
 525   echo "Cleaning up the staging directory"
 526   rm -rf ${tempparent}
 527 else
 528   (cd ${tempparent}; mv ${emacsname} ..)
 529   rm -rf ${tempparent}
 530 fi
 531
 532 ### make-dist ends here