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 newer 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     * )
  44       echo "${progname}: Unrecognized argument: $1" >&2
  45       exit 1
  46     ;;
  47   esac
  48   shift
  49 done
  50
  51 # Make sure we're running in the right place.
  52 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/version.el ]; then
  53   echo "${progname}: Can't find \`src/lisp.h' and \`lisp/version.el'." >&2
  54   echo "${progname} must be run in the top directory of the Emacs" >&2
  55   echo "distribution tree.  Cd to that directory and try again." >&2
  56   exit 1
  57 fi
  58
  59 # Find out which version of Emacs this is.
  60 version=`grep 'defconst[         ]*emacs-version' lisp/version.el \
  61          | sed -e 's/^.*"\([0-9][0-9]*\.[0-9][0-9]*\)\..*$/\1/'`
  62 if [ ! "${version}" ]; then
  63   echo "${progname}: can't find current emacs version in \`./lisp/version.el'." >&2
  64   exit 1
  65 fi
  66
  67 # Make sure the subdirectory is available.
  68 tempparent="make-dist.tmp.$$"
  69 if [ -d ${tempparent} ]; then
  70   echo "${progname}: staging directory \`${tempparent}' already exists.
  71 Perhaps a previous invocation of \`${progname}' failed to clean up after
  72 itself.  Check that directories whose names are of the form
  73 \`make-dist.tmp.NNNNN' don't contain any important information, remove
  74 them, and try again." >&2
  75   exit 1
  76 fi
  77
  78 echo "Creating staging directory: \`${tempparent}'"
  79 mkdir ${tempparent}
  80 emacsname="emacs-${version}${new_extension}"
  81 tempdir="${tempparent}/${emacsname}"
  82
  83 # This trap ensures that the staging directory will be cleaned up even
  84 # when the script is interrupted in mid-career.
  85 if [ "${clean_up}" = yes ]; then
  86   trap "echo 'Interrupted...cleaning up the staging directory.'; rm -rf ${tempparent}; exit 1" 1 2 15
  87 fi
  88
  89 echo "Creating top directory: \`${tempdir}'"
  90 mkdir ${tempdir}
  91
  92 # We copy in the top-level files before creating the subdirectories in
  93 # hopes that this will make the top-level files appear first in the
  94 # tar file; this means that people can start reading the INSTALL and
  95 # README while the rest of the tar file is still unpacking.  Whoopee.
  96 echo "Making links to top-level files."
  97 ln GETTING.GNU.SOFTWARE INSTALL PROBLEMS README move-if-change ${tempdir}
  98 ln ChangeLog Makefile.in build-install.in configure make-dist ${tempdir}
  99
 100 echo "Creating subdirectories."
 101 for subdir in lisp lisp/term local-lisp external-lisp \
 102               src src/m src/s lib-src oldXMenu \
 103               etc lock arch-lib cpp info man shortnames; do
 104   mkdir ${tempdir}/${subdir}
 105 done
 106
 107 echo "Making links to \`lisp'."
 108 # Don't distribute =*.el files, site-init.el, site-load.el, or default.el.
 109 (cd lisp
 110  ln [a-zA-Z]*.el ../${tempdir}/lisp
 111  ln [a-zA-Z]*.elc ../${tempdir}/lisp
 112  # simula.el doesn't keep abbreviations in simula.defns any more.
 113  # ln [a-zA-Z]*.defns ../${tempdir}/lisp
 114  ln ChangeLog README ../${tempdir}/lisp
 115  cd ../${tempdir}/lisp
 116  rm -f site-init site-init.el site-init.elc
 117  rm -f site-load site-load.el site-load.elc
 118  rm -f default default.el default.elc)
 119
 120 echo "Making links to \`lisp/term'."
 121 # Don't distribute =*.el files.
 122 (cd lisp/term
 123  ln [a-zA-Z]*.el ../../${tempdir}/lisp/term
 124  ln [a-zA-Z]*.elc ../../${tempdir}/lisp/term
 125  ln README ../../${tempdir}/lisp/term)
 126
 127 echo "Making links to \`external-lisp'."
 128 # Don't distribute =*.el files.
 129 (cd external-lisp
 130  ln [a-zA-Z]*.el ../${tempdir}/external-lisp
 131  ln [a-zA-Z]*.elc ../${tempdir}/external-lisp
 132  ln ChangeLog README ../${tempdir}/external-lisp)
 133
 134 echo "Making links to \`src'."
 135 # Don't distribute =*.[ch] files, or the configured versions of
 136 # config.h.in, paths.h.in, or Makefile.in.
 137 (cd src
 138  ln [a-zA-Z]*.c ../${tempdir}/src
 139  ln [a-zA-Z]*.h ../${tempdir}/src
 140  ln [a-zA-Z]*.s ../${tempdir}/src
 141  ln README Makefile.in ymakefile ChangeLog config.h.in paths.h.in \
 142     ../${tempdir}/src
 143  ln .gdbinit .dbxinit ../${tempdir}/src
 144  ln *.com *.opt vms-pp.trans vmsbuild ../${tempdir}/src
 145  cd ../${tempdir}/src
 146  rm -f config.h paths.h Makefile
 147  if [ -z "${newer}" ]; then
 148    etags *.h *.c ../lisp/*.el
 149  fi)
 150
 151 echo "Making links to \`src/m'."
 152 (cd src/m
 153  ln README *.h ../../${tempdir}/src/m)
 154
 155 echo "Making links to \`src/s'."
 156 (cd src/s
 157  ln README *.h ../../${tempdir}/src/s)
 158
 159 echo "Making links to \`lib-src'."
 160 (cd lib-src
 161  ln [a-zA-Z]*.c [a-zA-Z]*.h [a-zA-Z]*.y [a-zA-Z]*.lex ../${tempdir}/lib-src
 162  ln ChangeLog Makefile.in README testfile vcdiff rcs2log ../${tempdir}/lib-src
 163  cd ../${tempdir}/lib-src
 164  rm -f getdate.c getdate.tab.c y.tab.c y.tab.h)
 165
 166 echo "Making links to \`oldXMenu'."
 167 (cd oldXMenu
 168  ln *.c *.h ../${tempdir}/oldXMenu
 169  ln README Makefile Imakefile ChangeLog ../${tempdir}/oldXMenu)
 170
 171 echo "Making links to \`etc'."
 172 # Don't distribute DOC files, backups, autosaves, or tex litter.
 173 (cd etc
 174  ln [0-9a-zA-Z]* ../${tempdir}/etc
 175  cd ../${tempdir}/etc
 176  # Avoid an error when expanding the wildcards later.
 177  for dummy in DOC-dummy dummy~ \#dummy\# dummy.dvi dummy.log; do
 178    ln MACHINES ${dummy}
 179  done
 180  rm -f DOC* *~ \#*\# *.dvi *.log core)
 181
 182 # For now, we comment these out, since I'm not changing them any.
 183 #!! echo "Making links to \`cpp'."
 184 #!! (cd cpp
 185 #!!  ln cccp.c cexp.y Makefile README ../${tempdir}/cpp)
 186 #!!
 187 #!! echo "Making links to \`info'."
 188 #!! # Don't distribute backups or autosaves.
 189 #!! (cd info
 190 #!!  ln [a-zA-Z]* ../${tempdir}/info
 191 #!!  cd ../${tempdir}/info
 192 #!!  # Avoid an error when expanding the wildcards later.
 193 #!!  ln emacs dummy~ ; ln emacs \#dummy\#
 194 #!!  rm -f *~ \#*\# core)
 195 #!!
 196 #!! echo "Making links to \`man'."
 197 #!! (cd man
 198 #!!  ln *.tex *.texinfo *.texi *.aux *.cps *.fns *.kys *.vrs ../${tempdir}/man
 199 #!!  ln *.c ../${tempdir}/man
 200 #!!  ln ChangeLog Makefile README split-man ../${tempdir}/man)
 201
 202 echo "Making links to \`shortnames'."
 203 (cd shortnames
 204  ln *.c ../${tempdir}/shortnames
 205  ln Makefile reserved special ../${tempdir}/shortnames)
 206
 207 echo "Making sure copying notices are all symlinks to \`etc/COPYING'."
 208 rm -f ${tempdir}/etc/COPYING
 209 cp etc/COPYING ${tempdir}/etc/COPYING
 210 for subdir in lisp external-lisp src lib-src info shortnames; do
 211   if [ -f ${tempdir}/${subdir}/COPYING ]; then
 212     rm ${tempdir}/${subdir}/COPYING
 213   fi
 214   ln -s ../etc/COPYING ${tempdir}/${subdir}
 215 done
 216
 217 if [ "${newer}" ]; then
 218   echo "Removing files older than $newer."
 219   # We remove .elc files unconditionally, on the theory that anyone picking
 220   # up an incremental distribution already has a running Emacs to byte-compile
 221   # them with.
 222   find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
 223 fi
 224
 225 if [ "${make_tar}" = yes ]; then
 226   echo "Creating tar file."
 227   (cd ${tempparent}; tar cvf - ${emacsname}) | compress > ${emacsname}.tar.Z
 228 fi
 229
 230 if [ "${clean_up}" = yes ]; then
 231   echo "Cleaning up the staging directory."
 232   rm -rf ${tempparent}
 233 fi
 234
 235 # make-dist ends here