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