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