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 progname="$0"
  10
  11 ### Exit if a command fails.
  12 ### set -e
  13
  14 ### Print out each line we read, for debugging's sake.
  15 ### set -v
  16
  17 clean_up=yes
  18 make_tar=yes
  19 newer=""
  20
  21 while [ $# -gt 0 ]; do
  22   case "$1" in
  23     ## This option tells make-dist not to delete the staging directory
  24     ## after it's done making the tar file.
  25     "--no-clean-up" )
  26       clean_up=no
  27     ;;
  28     ## This option tells make-dist not to make a tar file.  Since it's
  29     ## rather pointless to build the whole staging directory and then
  30     ## nuke it, using this option also selects '--no-clean-up'.
  31     "--no-tar" )
  32       make_tar=no
  33       clean_up=no
  34     ;;
  35     ## This option tells make-dist to make the distribution normally, then
  36     ## remove all files older than the given timestamp file.  This is useful
  37     ## for creating incremental or patch distributions.
  38     "--newer")
  39       newer="$2"
  40       new_extension=".new"
  41       shift
  42     ;;
  43     ## This option tells make-dist to use `compress' instead of gzip.
  44     ## Normally, make-dist uses gzip whenever it is present.
  45     "--compress")
  46       default_gzip="compress"
  47     ;;
  48     * )
  49       echo "${progname}: Unrecognized argument: $1" >&2
  50       exit 1
  51     ;;
  52   esac
  53   shift
  54 done
  55
  56 ### Make sure we're running in the right place.
  57 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/version.el ]; then
  58   echo "${progname}: Can't find \`src/lisp.h' and \`lisp/version.el'." >&2
  59   echo "${progname} must be run in the top directory of the Emacs" >&2
  60   echo "distribution tree.  cd to that directory and try again." >&2
  61   exit 1
  62 fi
  63
  64 ### Find out which version of Emacs this is.
  65 shortversion=`grep 'defconst[    ]*emacs-version' lisp/version.el \
  66          | sed -e 's/^.*"\([0-9][0-9]*\.[0-9][0-9]*\).*$/\1/'`
  67 version=`grep 'defconst[         ]*emacs-version' lisp/version.el \
  68          | sed -e 's/^[^"]*"\([^"]*\)".*$/\1/'`
  69 if [ ! "${version}" ]; then
  70   echo "${progname}: can't find current Emacs version in \`./lisp/version.el'." >&2
  71   exit 1
  72 fi
  73
  74 echo $version and $shortversion
  75
  76 if grep -s "GNU Emacs version ${shortversion}" ./man/emacs.texi > /dev/null; then
  77   true
  78 else
  79   echo "You must update the version number in \`./man/emacs.texi'"
  80   sleep 5
  81 fi
  82
  83 ### Make sure we don't already have a directory  emacs-${version}.
  84
  85 emacsname="emacs-${version}${new_extension}"
  86
  87 if [ -d ${emacsname} ]
  88 then
  89   echo Directory "${emacsname}" already exists >&2
  90   exit 1
  91 fi
  92
  93 ### Make sure the subdirectory is available.
  94 tempparent="make-dist.tmp.$$"
  95 if [ -d ${tempparent} ]; then
  96   echo "${progname}: staging directory \`${tempparent}' already exists.
  97 Perhaps a previous invocation of \`${progname}' failed to clean up after
  98 itself.  Check that directories whose names are of the form
  99 \`make-dist.tmp.NNNNN' don't contain any important information, remove
 100 them, and try again." >&2
 101   exit 1
 102 fi
 103
 104 ### Check for .elc files with no corresponding .el file.
 105 ls -1 lisp/*.el | sed 's/\.el$/.elc/' > /tmp/el
 106 ls -1 lisp/*.elc > /tmp/elc
 107 bogosities="`comm -13 /tmp/el /tmp/elc`"
 108 if [ "${bogosities}" != "" ]; then
 109   echo "The following .elc files have no corresponding .el files:"
 110   echo "${bogosities}"
 111 fi
 112 rm -f /tmp/el /tmp/elc
 113
 114 ### Make sure configure is newer than configure.in.
 115 if [ "x`ls -t configure configure.in | head -1`" != "xconfigure" ]; then
 116   echo "\`./configure.in' seems to be newer than \`./configure.'" >&2
 117   echo "Attempting to run autoconf." >&2
 118   autoconf
 119 fi
 120
 121 ### Update getdate.c.
 122 (cd lib-src; make -f Makefile getdate.c YACC="bison -y")
 123
 124 echo "Creating staging directory: \`${tempparent}'"
 125
 126 mkdir ${tempparent}
 127 tempdir="${tempparent}/${emacsname}"
 128
 129 ### This trap ensures that the staging directory will be cleaned up even
 130 ### when the script is interrupted in mid-career.
 131 if [ "${clean_up}" = yes ]; then
 132   trap "echo 'Interrupted...cleaning up the staging directory.'; rm -rf ${tempparent}; exit 1" 1 2 15
 133 fi
 134
 135 echo "Creating top directory: \`${tempdir}'"
 136 mkdir ${tempdir}
 137
 138 ### We copy in the top-level files before creating the subdirectories in
 139 ### hopes that this will make the top-level files appear first in the
 140 ### tar file; this means that people can start reading the INSTALL and
 141 ### README while the rest of the tar file is still unpacking.  Whoopee.
 142 echo "Making links to top-level files."
 143 ln GETTING.GNU.SOFTWARE INSTALL PROBLEMS README move-if-change ${tempdir}
 144 ln ChangeLog Makefile.in build-ins.in configure configure.in ${tempdir}
 145 ln config.bat make-dist vpath.sed ${tempdir}
 146 ### Copy these files; they're cross-filesystem symlinks.
 147 cp config.sub ${tempdir}
 148 cp config.guess ${tempdir}
 149 cp install.sh ${tempdir}
 150
 151 echo "Updating version number in README."
 152 (cd ${tempdir}
 153  awk \
 154    '$1 " " $2 " " $3 " " $4 " " $5 == "This directory tree holds version" { $6 = version; print $0 }
 155     $1 " " $2 " " $3 " " $4 " " $5 != "This directory tree holds version"' \
 156    version=${version} README > tmp.README
 157  mv tmp.README README)
 158
 159
 160 echo "Creating subdirectories."
 161 # I think we're not going to distribute anything in external-lisp, so
 162 # I've removed it from this list.
 163 for subdir in lisp lisp/term site-lisp \
 164               src src/m src/s src/bitmaps lib-src oldXMenu lwlib \
 165               etc lock cpp info man msdos shortnames vms; do
 166   mkdir ${tempdir}/${subdir}
 167 done
 168
 169 echo "Making links to \`lisp'."
 170 ### Don't distribute TAGS, =*.el files, site-init.el, site-load.el, or default.el.
 171 (cd lisp
 172  ln [a-zA-Z]*.el ../${tempdir}/lisp
 173  ln [a-zA-Z]*.elc ../${tempdir}/lisp
 174  ln [a-zA-Z]*.dat ../${tempdir}/lisp
 175  ## simula.el doesn't keep abbreviations in simula.defns any more.
 176  ## ln [a-zA-Z]*.defns ../${tempdir}/lisp
 177  ln ChangeLog Makefile ChangeLog.? README dired.todo ../${tempdir}/lisp
 178  cd ../${tempdir}/lisp
 179  rm -f TAGS =*
 180  rm -f site-init site-init.el site-init.elc
 181  rm -f site-load site-load.el site-load.elc
 182  rm -f default default.el default.elc)
 183
 184 #echo "Making links to \`lisp/calc-2.02'."
 185 #### Don't distribute =*.el files, TAGS or backups.
 186 #(cd lisp/calc-2.02
 187 # ln [a-zA-Z]*.el ../../${tempdir}/lisp/calc-2.02
 188 # ln [a-zA-Z]*.elc ../../${tempdir}/lisp/calc-2.02
 189 # ln calc.info* calc.texinfo calc-refcard.* ../../${tempdir}/lisp/calc-2.02
 190 # ln INSTALL Makefile README README.prev ../../${tempdir}/lisp/calc-2.02
 191 # cd ../../${tempdir}/lisp/calc-2.02
 192 # rm -f *~ TAGS)
 193
 194 echo "Making links to \`lisp/term'."
 195 ### Don't distribute =*.el files or TAGS.
 196 (cd lisp/term
 197  ln [a-zA-Z]*.el ../../${tempdir}/lisp/term
 198  ln [a-zA-Z]*.elc ../../${tempdir}/lisp/term
 199  ln README ../../${tempdir}/lisp/term
 200  rm -f =* TAGS)
 201
 202 ### echo "Making links to \`external-lisp'."
 203 ### ### Don't distribute =*.el files or TAGS.
 204 ### (cd external-lisp
 205 ###  ln [a-zA-Z]*.el ../${tempdir}/external-lisp
 206 ###  ln [a-zA-Z]*.elc ../${tempdir}/external-lisp
 207 ###  ln ChangeLog README ../${tempdir}/external-lisp
 208 ###  rm -f =* TAGS)
 209
 210 echo "Making links to \`src'."
 211 ### Don't distribute =*.[ch] files, or the configured versions of
 212 ### config.h.in, paths.h.in, or Makefile.in.in, or TAGS.
 213 (cd src
 214  echo "  (If we can't link gmalloc.c, that's okay.)"
 215  ln [a-zA-Z]*.c ../${tempdir}/src
 216  ## Might be a symlink to a file on another filesystem.
 217  test -f ../${tempdir}/src/gmalloc.c || cp gmalloc.c ../${tempdir}/src
 218  ln [a-zA-Z]*.h ../${tempdir}/src
 219  ln [a-zA-Z]*.s ../${tempdir}/src
 220  ln README Makefile.in.in ChangeLog ChangeLog.? config.h.in paths.h.in \
 221     ../${tempdir}/src
 222  ln .gdbinit .dbxinit ../${tempdir}/src
 223  ln *.opt vms-pp.trans ../${tempdir}/src
 224  cd ../${tempdir}/src
 225  rm -f config.h paths.h Makefile
 226  rm -f =* TAGS)
 227
 228 echo "Making links to \`src/bitmaps'."
 229 (cd src/bitmaps
 230  ln README *.xbm ../../${tempdir}/src/bitmaps)
 231
 232 echo "Making links to \`src/m'."
 233 (cd src/m
 234  ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/m)
 235
 236 echo "Making links to \`src/s'."
 237 (cd src/s
 238  ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/s)
 239
 240 echo "Making links to \`lib-src'."
 241 (cd lib-src
 242  ln [a-zA-Z]*.[chy] [a-zA-Z]*.lex ../${tempdir}/lib-src
 243  ln ChangeLog Makefile.in.in README testfile vcdiff ../${tempdir}/lib-src
 244  ln emacs.csh rcs2log rcs-checkin ../${tempdir}/lib-src
 245  cd ../${tempdir}/lib-src
 246  rm -f getdate.tab.c y.tab.c y.tab.h
 247  rm -f =* TAGS)
 248
 249 echo "Making links to \`msdos'."
 250 (cd msdos
 251  ln  ChangeLog emacs.ico emacs.pif ../${tempdir}/msdos
 252  ln mainmake sed[123].inp ../${tempdir}/msdos
 253  cd ../${tempdir}/msdos
 254  rm -f =*)
 255
 256 echo "Making links to \`oldXMenu'."
 257 (cd oldXMenu
 258  ln *.c *.h *.in ../${tempdir}/oldXMenu
 259  ln README Imakefile ChangeLog ../${tempdir}/oldXMenu
 260  ln compile.com descrip.mms ../${tempdir}/oldXMenu)
 261
 262 echo "Making links to \`lwlib'."
 263 (cd lwlib
 264  ln *.c *.h *.in ../${tempdir}/lwlib
 265  ln README Imakefile ChangeLog ../${tempdir}/lwlib)
 266
 267 echo "Making links to \`etc'."
 268 ### Don't distribute = files, TAGS, DOC files, backups, autosaves, or
 269 ### tex litter.
 270 (cd etc
 271  ln `ls -d * | grep -v 'RCS' | grep -v 'Old'` ../${tempdir}/etc
 272  cd ../${tempdir}/etc
 273  rm -f DOC* *~ \#*\# *.dvi *.log *,v =* core
 274  rm -f TAGS)
 275
 276 echo "Making links to \`cpp'."
 277 (cd cpp
 278  ln cccp.c cexp.y Makefile README ../${tempdir}/cpp)
 279
 280 echo "Making links to \`info'."
 281 # Don't distribute backups or autosaves.
 282 (cd info
 283  ln [a-zA-Z]* ../${tempdir}/info
 284  cd ../${tempdir}/info
 285  # Avoid an error when expanding the wildcards later.
 286  ln emacs dummy~ ; ln emacs \#dummy\#
 287  rm -f *~ \#*\# core)
 288
 289 echo "Making links to \`man'."
 290 (cd man
 291  ln *.texi *.aux *.cps *.fns *.kys *.vrs ../${tempdir}/man
 292  test -f README && ln README ../${tempdir}/man
 293  test -f Makefile && ln Makefile ../${tempdir}/man
 294  ln ChangeLog split-man ../${tempdir}/man
 295  cp texinfo.tex texindex.c getopt.c ../${tempdir}/man
 296  cd ../${tempdir}/man
 297  rm -f \#*\# =* *~ core emacs-index* *.Z *.z xmail
 298  rm -f emacs.?? termcap.?? gdb.?? *.log *.toc *.dvi *.oaux)
 299
 300 echo "Making links to \`shortnames'."
 301 (cd shortnames
 302  ln *.c ../${tempdir}/shortnames
 303  ln Makefile reserved special ../${tempdir}/shortnames)
 304
 305 echo "Making links to \`vms'."
 306 (cd vms
 307  ln [0-9a-zA-Z]* ../${tempdir}/vms
 308  cd ../${tempdir}/vms
 309  rm -f *~)
 310
 311 ### It would be nice if they could all be symlinks to etc's copy, but
 312 ### you're not supposed to have any symlinks in distribution tar files.
 313 echo "Making sure copying notices are all copies of \`etc/COPYING'."
 314 rm -f ${tempdir}/etc/COPYING
 315 cp etc/COPYING ${tempdir}/etc/COPYING
 316 for subdir in lisp src lib-src info shortnames msdos; do
 317   if [ -f ${tempdir}/${subdir}/COPYING ]; then
 318     rm ${tempdir}/${subdir}/COPYING
 319   fi
 320   cp etc/COPYING ${tempdir}/${subdir}
 321 done
 322
 323 #### Make sure that there aren't any hard links between files in the
 324 #### distribution; people with afs can't deal with that.  Okay,
 325 #### actually we just re-copy anything with a link count greater
 326 #### than two.
 327 echo "Breaking intra-tree links."
 328 find ${tempdir} ! -type d -links +2 \
 329   -exec cp -p {} $$ \; -exec rm -f {} \; -exec mv $$ {} \;
 330
 331 if [ "${newer}" ]; then
 332   echo "Removing files older than $newer."
 333   ## We remove .elc files unconditionally, on the theory that anyone picking
 334   ## up an incremental distribution already has a running Emacs to byte-compile
 335   ## them with.
 336   find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
 337 fi
 338
 339 if [ "${make_tar}" = yes ]; then
 340   if [ "${default_gzip}" = "" ]; then
 341     echo "Looking for gzip."
 342     temppath=`echo $PATH | sed 's/^:/.:/
 343                                 s/::/:.:/g
 344                                 s/:$/:./
 345                                 s/:/ /g'`
 346     default_gzip=`(
 347       for dir in ${temppath}; do
 348         if [ -f ${dir}/gzip ]; then echo 'gzip --best'; exit 0; fi
 349       done
 350       echo compress
 351     )`
 352   fi
 353   case "${default_gzip}" in
 354     compress* ) gzip_extension=.Z ;;
 355     * )         gzip_extension=.gz ;;
 356   esac
 357   echo "Creating tar file."
 358   (cd ${tempparent} ; tar cvf - ${emacsname} ) \
 359     | ${default_gzip} \
 360     > ${emacsname}.tar${gzip_extension}
 361 fi
 362
 363 if [ "${clean_up}" = yes ]; then
 364   echo "Cleaning up the staging directory."
 365   rm -rf ${tempparent}
 366 else
 367   (cd ${tempparent}; mv ${emacsname} ..)
 368   rm -rf ${tempparent}
 369 fi
 370
 371 ### make-dist ends here