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