make-dist

   1 #!/bin/sh
   2 ### make-dist: create an Emacs distribution tar file from current srcdir
   3
   4 ## Copyright (C) 1995, 1997, 1998, 2000, 2001, 2002, 2003, 2004, 2005,
   5 ##   2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
   6
   7 ## This file is part of GNU Emacs.
   8
   9 ## GNU Emacs is free software: you can redistribute it and/or modify
  10 ## it under the terms of the GNU General Public License as published by
  11 ## the Free Software Foundation, either version 3 of the License, or
  12 ## (at your option) any later version.
  13
  14 ## GNU Emacs is distributed in the hope that it will be useful,
  15 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ## GNU General Public License for more details.
  18
  19 ## You should have received a copy of the GNU General Public License
  20 ## along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 ### Commentary:
  23
  24 ## This basically creates a duplicate directory structure, and then
  25 ## hard links into it only those files that should be distributed.
  26 ## This means that if you add a file with an odd name, you should make
  27 ## sure that this script will include it.
  28
  29 ### Code:
  30
  31 progname="$0"
  32
  33 ### Exit if a command fails.
  34 #set -e
  35
  36 ### Print out each line we read, for debugging's sake.
  37 #set -v
  38
  39 LANGUAGE=C
  40 LC_ALL=C
  41 LC_MESSAGES=
  42 LANG=
  43 export LANGUAGE LC_ALL LC_MESSAGES LANG
  44
  45 ## Don't restrict access to any files.
  46 umask 0
  47
  48 update=yes
  49 check=yes
  50 clean_up=no
  51 make_tar=no
  52 default_gzip=gzip
  53 newer=""
  54
  55 while [ $# -gt 0 ]; do
  56   case "$1" in
  57     ## This option tells make-dist to delete the staging directory
  58     ## when done.  It is useless to use this unless you make a tar file.
  59     "--clean-up" )
  60       clean_up=yes
  61     ;;
  62     ## This option tells make-dist to make a tar file.
  63     "--tar" )
  64       make_tar=yes
  65     ;;
  66     ## This option tells make-dist not to recompile or do analogous things.
  67     "--no-update" )
  68       update=no
  69     ;;
  70     ## This option says don't check for bad file names, etc.
  71     "--no-check" )
  72       check=no
  73     ;;
  74     ## This option tells make-dist to make the distribution normally, then
  75     ## remove all files older than the given timestamp file.  This is useful
  76     ## for creating incremental or patch distributions.
  77     "--newer")
  78       newer="$2"
  79       new_extension=".new"
  80       shift
  81     ;;
  82     ## This option tells make-dist to use `bzip2' instead of gzip.
  83     "--bzip2")
  84       default_gzip="bzip2"
  85     ;;
  86     ## Same with lzma.
  87     "--lzma")
  88       default_gzip="lzma"
  89     ;;
  90
  91     "--snapshot")
  92       clean_up=yes
  93       make_tar=yes
  94       update=no
  95       check=no
  96      ;;
  97
  98     "--help")
  99       echo "Usage: ${progname} [options]"
 100       echo ""
 101       echo "  --bzip2   use bzip2 instead of gzip"
 102       echo "  --clean-up        delete staging directories when done"
 103       echo "  --lzma    use lzma instead of gzip"
 104       echo "  --newer=TIME      don't include files older than TIME"
 105       echo "  --no-check        don't check for bad file names etc."
 106       echo "  --no-update       don't recompile or do analogous things"
 107       echo "  --snapshot        same as --clean-up --no-update --tar --no-check"
 108       echo "  --tar             make a tar file"
 109       echo ""
 110       exit 0
 111     ;;
 112
 113     * )
 114       echo "${progname}: Unrecognized argument: $1" >&2
 115       exit 1
 116     ;;
 117   esac
 118   shift
 119 done
 120
 121 ### Make sure we're running in the right place.
 122 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/subr.el ]; then
 123   echo "${progname}: Can't find \`src/lisp.h' and \`lisp/subr.el'." >&2
 124   echo "${progname} must be run in the top directory of the Emacs" >&2
 125   echo "distribution tree.  cd to that directory and try again." >&2
 126   exit 1
 127 fi
 128
 129 ### Find where to run Emacs.
 130 ### (Accept only absolute file names.)
 131 if [ $update = yes ];
 132 then
 133   unset EMACS_UNIBYTE
 134   if [ -f src/emacs ];
 135   then
 136     EMACS=`pwd`/src/emacs
 137   else
 138     case $EMACS in
 139       /*) ;;
 140       *)
 141         if [ ! -f "$EMACS" ]; then
 142           echo "$0: You must set the EMACS environment variable " \
 143                "to an absolute file name." 2>&1
 144           exit 1
 145         fi;;
 146     esac
 147   fi
 148 fi
 149
 150 ### Find out which version of Emacs this is.
 151 version=`sed -n '/char emacs_version/ s/^[^"]*"\([^"]*\)".*$/\1/p' src/emacs.c`
 152 if [ ! "${version}" ]; then
 153   echo "${progname}: can't find current Emacs version in \`./src/emacs.c'" >&2
 154   exit 1
 155 fi
 156
 157 echo Version number is $version
 158
 159 if [ $update = yes ]; then
 160   if ! grep -q "@set EMACSVER  *${version}" doc/emacs/emacsver.texi || \
 161      ! grep -q "tree holds version  *${version}" README; then
 162     echo "WARNING: README and/or emacsver.texi have the wrong version number"
 163     echo "Consider running M-x set-version from admin/admin.el"
 164     sleep 5
 165   fi
 166 fi
 167
 168 ### Make sure we don't already have a directory  emacs-${version}.
 169
 170 emacsname="emacs-${version}${new_extension}"
 171
 172 if [ -d ${emacsname} ]
 173 then
 174   echo Directory "${emacsname}" already exists >&2
 175   exit 1
 176 fi
 177
 178 ### Make sure the subdirectory is available.
 179 tempparent="make-dist.tmp.$$"
 180 if [ -d ${tempparent} ]; then
 181   echo "${progname}: staging directory \`${tempparent}' already exists.
 182 Perhaps a previous invocation of \`${progname}' failed to clean up after
 183 itself.  Check that directories whose names are of the form
 184 \`make-dist.tmp.NNNNN' don't contain any important information, remove
 185 them, and try again." >&2
 186   exit 1
 187 fi
 188
 189 if [ $check = yes ]; then
 190   ls -1 lisp/[a-zA-Z]*.el lisp/[a-z]*/[a-zA-Z0-9]*.el \
 191         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
 192         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
 193         leim/[a-z]*/[a-z]*.el > /tmp/el
 194
 195   ls -1 lisp/[a-zA-Z]*.elc lisp/[a-z]*/[a-zA-Z0-9]*.elc \
 196         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
 197         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
 198         leim/[a-z]*/[a-z]*.elc > /tmp/elc
 199
 200   ## Check for .elc files with no corresponding .el file.
 201   sed 's/\.el$/.elc/' /tmp/el > /tmp/elelc
 202
 203   bogosities="`comm -13 /tmp/elelc /tmp/elc`"
 204   if [ x"${bogosities}" != x"" ]; then
 205     echo "The following .elc files have no corresponding .el files:"
 206     echo "${bogosities}"
 207   fi
 208
 209   ### Check for .el files with no corresponding .elc file.
 210   sed 's/\.elc$/.el/' /tmp/elc > /tmp/elcel
 211   losers="`comm -23 /tmp/el /tmp/elcel`"
 212
 213   rm -f /tmp/el /tmp/elc /tmp/elcel /tmp/elelc
 214
 215   bogosities=
 216   for file in $losers; do
 217     grep -q "no-byte-compile: t" $file && continue
 218     case $file in
 219       site-init.el | site-load.el | site-start.el | default.el) continue ;;
 220     esac
 221
 222     bogosities="$file $bogosities"
 223
 224   done
 225   if [ x"${bogosities}" != x"" ]; then
 226     echo "The following .el files have no corresponding .elc files:"
 227     echo "${bogosities}"
 228   fi
 229 fi
 230
 231 if [ $update = yes ]; then
 232
 233   ## Make sure configure is newer than configure.in.
 234   if [ "x`ls -t configure configure.in | sed q`" != "xconfigure" ]; then
 235     echo "\`./configure.in' is newer than \`./configure'" >&2
 236     echo "Running autoconf" >&2
 237     autoconf || { x=$?; echo Autoconf FAILED! >&2; exit $x; }
 238   fi
 239
 240   ## Make sure src/stamp-h.in is newer than configure.in.
 241   if [ "x`ls -t src/stamp-h.in configure.in | sed q`" != "xsrc/stamp-h.in" ]; then
 242     echo "\`./configure.in' is newer than \`./src/stamp-h.in'" >&2
 243     echo "Running autoheader" >&2
 244     autoheader || { x=$?; echo Autoheader FAILED! >&2; exit $x; }
 245     rm -f src/stamp-h.in
 246     echo timestamp > src/stamp-h.in
 247   fi
 248
 249   echo "Updating Info files"
 250   (cd doc/emacs; make info)
 251   (cd doc/misc; make info)
 252   (cd doc/lispref; make info)
 253   (cd doc/lispintro; make info)
 254
 255   echo "Updating finder, custom and autoload data"
 256   (cd lisp; make updates EMACS="$EMACS")
 257
 258   if test -f leim/leim-list.el; then
 259     echo "Updating leim-list.el"
 260     (cd leim; make leim-list.el EMACS="$EMACS")
 261   fi
 262
 263   echo "Recompiling Lisp files"
 264   $EMACS -batch -f batch-byte-recompile-directory lisp leim
 265 fi                              # $update = yes
 266
 267 echo "Creating staging directory: \`${tempparent}'"
 268
 269 mkdir ${tempparent}
 270 tempdir="${tempparent}/${emacsname}"
 271
 272 ### This trap ensures that the staging directory will be cleaned up even
 273 ### when the script is interrupted in mid-career.
 274 if [ "${clean_up}" = yes ]; then
 275   trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
 276 fi
 277
 278 echo "Creating top directory: \`${tempdir}'"
 279 mkdir ${tempdir}
 280
 281 ### We copy in the top-level files before creating the subdirectories in
 282 ### hopes that this will make the top-level files appear first in the
 283 ### tar file; this means that people can start reading the INSTALL and
 284 ### README while the rest of the tar file is still unpacking.  Whoopee.
 285 echo "Making links to top-level files"
 286 ln INSTALL README BUGS move-if-change ${tempdir}
 287 ln ChangeLog Makefile.in configure configure.in ${tempdir}
 288 ln config.bat make-dist update-subdirs vpath.sed .dir-locals.el ${tempdir}
 289 ln mkinstalldirs config.sub config.guess install-sh ${tempdir}
 290
 291 echo "Creating subdirectories"
 292 for subdir in site-lisp \
 293               leim leim/CXTERM-DIC leim/MISC-DIC \
 294               leim/SKK-DIC leim/ja-dic leim/quail \
 295               src src/m src/s src/bitmaps lib-src oldXMenu lwlib \
 296               nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
 297               `find etc lisp -type d` \
 298               doc doc/emacs doc/misc doc/man doc/lispref doc/lispintro \
 299               info m4 msdos \
 300               nextstep nextstep/Cocoa nextstep/Cocoa/Emacs.base \
 301               nextstep/Cocoa/Emacs.base/Contents \
 302               nextstep/Cocoa/Emacs.base/Contents/Resources \
 303               nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj \
 304               nextstep/Cocoa/Emacs.xcodeproj \
 305               nextstep/GNUstep \
 306               nextstep/GNUstep/Emacs.base \
 307               nextstep/GNUstep/Emacs.base/Resources
 308 do
 309   ## site-lisp for in-place installs (?).
 310   [ "$subdir" = "site-lisp" ] || [ -d "$subdir" ] || \
 311       echo "WARNING: $subdir not found, making anyway"
 312   echo "  ${tempdir}/${subdir}"
 313   mkdir ${tempdir}/${subdir}
 314 done
 315
 316 echo "Making links to \`lisp' and its subdirectories"
 317 files=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
 318  -o -name 'README*' \)`
 319
 320 ### Don't distribute site-init.el, site-load.el, or default.el.
 321 for file in lisp/Makefile.in lisp/makefile.w32-in $files; do
 322   case $file in
 323     */site-init*|*/site-load*|*/default*) continue ;;
 324   esac
 325   ln $file $tempdir/$file
 326 done
 327
 328 echo "Making links to \`leim' and its subdirectories"
 329 (cd leim
 330  ln makefile.w32-in ../${tempdir}/leim
 331  ln ChangeLog README ../${tempdir}/leim
 332  ln CXTERM-DIC/README CXTERM-DIC/*.tit ../${tempdir}/leim/CXTERM-DIC
 333  ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/leim/SKK-DIC
 334  ln MISC-DIC/README MISC-DIC/*.* ../${tempdir}/leim/MISC-DIC
 335  ln ja-dic/*.el ja-dic/*.elc ../${tempdir}/leim/ja-dic
 336  ln Makefile.in ../${tempdir}/leim/Makefile.in
 337  ln leim-ext.el ../${tempdir}/leim/leim-ext.el
 338  ## Lisp files that start with a capital (also 4Corner.el) are
 339  ## generated from TIT dictionaries so we don't distribute them.
 340  ln quail/[a-z]*.el quail/[a-z]*.elc ../${tempdir}/leim/quail
 341  rm -f ../${tempdir}/leim/quail/quick-b5.*
 342  rm -f ../${tempdir}/leim/quail/quick-cns.*
 343  rm -f ../${tempdir}/leim/quail/tsang-b5.*
 344  rm -f ../${tempdir}/leim/quail/tsang-cns.*)
 345
 346 echo "Making links to \`src'"
 347 ### Don't distribute the configured versions of
 348 ### config.in, paths.in, buildobj.h, or Makefile.in.
 349 (cd src
 350  echo "  (It is ok if ln fails in some cases.)"
 351  ln [a-zA-Z]*.[chm] ../${tempdir}/src
 352  ln [a-zA-Z]*.in ../${tempdir}/src
 353  ln [a-zA-Z]*.mk ../${tempdir}/src
 354  ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
 355  ln makefile.w32-in ../${tempdir}/src
 356  ln .gdbinit .dbxinit ../${tempdir}/src
 357  cd ../${tempdir}/src
 358  rm -f config.h epaths.h Makefile buildobj.h)
 359
 360 echo "Making links to \`src/bitmaps'"
 361 (cd src/bitmaps
 362  ln README *.xbm ../../${tempdir}/src/bitmaps)
 363
 364 echo "Making links to \`src/m'"
 365 (cd src/m
 366  ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/m)
 367
 368 echo "Making links to \`src/s'"
 369 (cd src/s
 370  ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/s)
 371
 372 echo "Making links to \`lib-src'"
 373 (cd lib-src
 374  ln [a-zA-Z]*.[ch] ../${tempdir}/lib-src
 375  ln ChangeLog Makefile.in README testfile vcdiff ../${tempdir}/lib-src
 376  ln grep-changelog rcs2log rcs-checkin ../${tempdir}/lib-src
 377  ln makefile.w32-in ../${tempdir}/lib-src
 378  cd ../${tempdir}/lib-src
 379  rm -f getopt.h)
 380
 381 echo "Making links to \`m4'"
 382 (cd m4
 383  ln *.m4 ../${tempdir}/m4)
 384
 385 ## Exclude README.W32 because it is specific to pre-built binaries(?).
 386 echo "Making links to \`nt'"
 387 (cd nt
 388  ln emacs.manifest emacs.rc emacsclient.rc config.nt ../${tempdir}/nt
 389  ln emacs-src.tags nmake.defs gmake.defs subdirs.el ../${tempdir}/nt
 390  ln [a-z]*.bat [a-z]*.[ch] ../${tempdir}/nt
 391  ln ChangeLog INSTALL README makefile.w32-in ../${tempdir}/nt)
 392
 393 echo "Making links to \`nt/inc' and its subdirectories"
 394 for f in `find nt/inc -type f -name '[a-z]*.h'`; do
 395   ln $f $tempdir/$f
 396 done
 397
 398 echo "Making links to \`nt/icons'"
 399 (cd nt/icons
 400  ln README [a-z]*.ico ../../${tempdir}/nt/icons
 401  ln [a-z]*.cur ../../${tempdir}/nt/icons)
 402
 403 echo "Making links to \`msdos'"
 404 (cd msdos
 405  ln ChangeLog INSTALL README emacs.ico emacs.pif ../${tempdir}/msdos
 406  ln is_exec.c sigaction.c mainmake.v2 sed*.inp ../${tempdir}/msdos)
 407
 408 echo "Making links to \`nextstep'"
 409 (cd nextstep
 410  ln ChangeLog README INSTALL ../${tempdir}/nextstep)
 411
 412 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents'"
 413 (cd nextstep/Cocoa/Emacs.base/Contents
 414  ln Info.plist PkgInfo ../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents)
 415
 416 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents/Resources'"
 417 (cd nextstep/Cocoa/Emacs.base/Contents/Resources
 418  ln Credits.html *.icns ../../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents/Resources)
 419
 420 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj'"
 421 (cd nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj
 422  ln InfoPlist.strings ../../../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj)
 423
 424 echo "Making links to \`nextstep/Cocoa/Emacs.xcodeproj'"
 425 (cd nextstep/Cocoa/Emacs.xcodeproj
 426  ln project.pbxproj ../../../${tempdir}/nextstep/Cocoa/Emacs.xcodeproj)
 427
 428 echo "Making links to \`nextstep/GNUstep/Emacs.base/Resources'"
 429 (cd nextstep/GNUstep/Emacs.base/Resources
 430  ln Emacs.desktop Info-gnustep.plist README emacs.tiff ../../../../${tempdir}/nextstep/GNUstep/Emacs.base/Resources )
 431
 432 echo "Making links to \`oldXMenu'"
 433 (cd oldXMenu
 434  ln *.[ch] *.in ../${tempdir}/oldXMenu
 435  ln README ChangeLog ../${tempdir}/oldXMenu)
 436
 437 echo "Making links to \`lwlib'"
 438 (cd lwlib
 439  ln *.[ch] *.in ../${tempdir}/lwlib
 440  ln README ChangeLog ../${tempdir}/lwlib)
 441
 442 echo "Making links to \`etc' and its subdirectories"
 443 for f in `find etc -type f`; do
 444   case $f in
 445     etc/DOC*) continue ;;
 446   esac
 447   ln $f $tempdir/$f
 448 done
 449
 450 echo "Making links to \`info'"
 451 ln `find info -type f -print` ${tempdir}/info
 452
 453 echo "Making links to \`doc/emacs'"
 454 (cd doc/emacs
 455  ln *.texi *.in makefile.w32-in ChangeLog* ../../${tempdir}/doc/emacs)
 456
 457 echo "Making links to \`doc/misc'"
 458 (cd doc/misc
 459  ln *.texi *.tex *.in makefile.w32-in gnus-news.el ChangeLog* ../../${tempdir}/doc/misc)
 460
 461 echo "Making links to \`doc/lispref'"
 462 (cd doc/lispref
 463  ln *.texi *.in makefile.w32-in README ChangeLog* ../../${tempdir}/doc/lispref
 464  ln *.txt *.el spellfile tindex.pl ../../${tempdir}/doc/lispref
 465  ln two-volume.make ../../${tempdir}/doc/lispref)
 466
 467 echo "Making links to \`doc/lispintro'"
 468 (cd doc/lispintro
 469  ln *.texi *.in makefile.w32-in *.eps *.pdf ../../${tempdir}/doc/lispintro
 470  ln README ChangeLog* ../../${tempdir}/doc/lispintro
 471  cd ../../${tempdir}/doc/lispintro)
 472
 473 echo "Making links to \`doc/man'"
 474 (cd doc/man
 475  ln ChangeLog* *.1 ../../${tempdir}/doc/man
 476  cd ../../${tempdir}/doc/man)
 477
 478 ### It would be nice if they could all be symlinks to top-level copy, but
 479 ### you're not supposed to have any symlinks in distribution tar files.
 480 echo "Making sure copying notices are all copies of \`COPYING'"
 481 for subdir in . etc info leim lib-src lisp lwlib msdos nt src; do
 482   rm -f ${tempdir}/${subdir}/COPYING
 483   cp COPYING ${tempdir}/${subdir}
 484 done
 485
 486 if [ "${newer}" ]; then
 487   echo "Removing files older than $newer"
 488   ## We remove .elc files unconditionally, on the theory that anyone picking
 489   ## up an incremental distribution already has a running Emacs to byte-compile
 490   ## them with.
 491   find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
 492 fi
 493
 494 ## Don't distribute backups, autosaves, etc.
 495 echo "Removing unwanted files"
 496 find ${tempparent} \( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \) -exec rm -f {} \;
 497
 498 if [ "${make_tar}" = yes ]; then
 499   echo "Looking for $default_gzip"
 500   found=0
 501   temppath=`echo $PATH | sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' \
 502      -e 's/:/ /g'`
 503   for dir in ${temppath}; do
 504     [ -x ${dir}/$default_gzip ] || continue
 505     found=1; break
 506   done
 507   if [ "$found" = "0" ]; then
 508     echo "WARNING: \`$default_gzip' not found, will not compress" >&2
 509     default_gzip=cat
 510   fi
 511   case "${default_gzip}" in
 512     bzip2) gzip_extension=.bz2 ;;
 513     lzma)  gzip_extension=.lzma ;;
 514     gzip)  gzip_extension=.gz ; default_gzip="gzip --best";;
 515        *)  gzip_extension= ;;
 516   esac
 517   echo "Creating tar file"
 518   (cd ${tempparent} ; tar cvf - ${emacsname} ) \
 519     | ${default_gzip} \
 520     > ${emacsname}.tar${gzip_extension}
 521 fi
 522
 523 if [ "${clean_up}" != yes ]; then
 524   (cd ${tempparent}; mv ${emacsname} ..)
 525   rm -rf ${tempparent}
 526 fi
 527
 528 ### make-dist ends here