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-2015 Free Software Foundation,
   5 ## 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 ## Remove unnecessary restrictions on file access.
  46 umask 022
  47
  48 update=yes
  49 check=yes
  50 clean_up=no
  51 make_tar=no
  52 default_gzip=gzip
  53 newer=""
  54 with_tests=no
  55
  56 while [ $# -gt 0 ]; do
  57   case "$1" in
  58     ## This option tells make-dist to delete the staging directory
  59     ## when done.  It is useless to use this unless you make a tar file.
  60     "--clean-up" )
  61       clean_up=yes
  62     ;;
  63     ## This option tells make-dist to make a tar file.
  64     "--tar" )
  65       make_tar=yes
  66     ;;
  67     ## This option tells make-dist not to recompile or do analogous things.
  68     "--no-update" )
  69       update=no
  70     ;;
  71     ## This option says don't check for bad file names, etc.
  72     "--no-check" )
  73       check=no
  74     ;;
  75     ## This option tells make-dist to make the distribution normally, then
  76     ## remove all files older than the given timestamp file.  This is useful
  77     ## for creating incremental or patch distributions.
  78     "--newer")
  79       newer="$2"
  80       new_extension=".new"
  81       shift
  82     ;;
  83     ## This option tells make-dist to use `bzip2' instead of gzip.
  84     "--bzip2")
  85       default_gzip="bzip2"
  86     ;;
  87     ## Same with xz.
  88     "--xz")
  89       default_gzip="xz"
  90     ;;
  91     "--no-compress")
  92       default_gzip="cat"
  93     ;;
  94
  95     "--snapshot")
  96       clean_up=yes
  97       make_tar=yes
  98       update=no
  99       check=no
 100      ;;
 101
 102     ## Include the test/ directory.
 103     ## This option is mainly for the hydra build server.
 104     "--tests")
 105       with_tests=yes
 106      ;;
 107
 108     "--help")
 109       echo "Usage: ${progname} [options]"
 110       echo ""
 111       echo "  --bzip2   use bzip2 instead of gzip"
 112       echo "  --clean-up        delete staging directories when done"
 113       echo "  --xz              use xz instead of gzip"
 114       echo "  --no-compress     don't compress"
 115       echo "  --newer=TIME      don't include files older than TIME"
 116       echo "  --no-check        don't check for bad file names etc."
 117       echo "  --no-update       don't recompile or do analogous things"
 118       echo "  --snapshot        same as --clean-up --no-update --tar --no-check"
 119       echo "  --tar             make a tar file"
 120       echo "  --tests   include the test/ directory"
 121       echo ""
 122       exit 0
 123     ;;
 124
 125     * )
 126       echo "${progname}: Unrecognized argument: $1" >&2
 127       exit 1
 128     ;;
 129   esac
 130   shift
 131 done
 132
 133 ### Make sure we're running in the right place.
 134 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/subr.el ]; then
 135   echo "${progname}: Can't find \`src/lisp.h' and \`lisp/subr.el'." >&2
 136   echo "${progname} must be run in the top directory of the Emacs" >&2
 137   echo "distribution tree.  cd to that directory and try again." >&2
 138   exit 1
 139 fi
 140
 141 ### Find where to run Emacs.
 142 ### (Accept only absolute file names.)
 143 if [ $update = yes ];
 144 then
 145   if [ -f src/emacs ];
 146   then
 147     EMACS=`pwd`/src/emacs
 148   else
 149     case $EMACS in
 150       /*) ;;
 151       *)
 152         if [ ! -f "$EMACS" ]; then
 153           echo "$0: You must set the EMACS environment variable " \
 154                "to an absolute file name." 2>&1
 155           exit 1
 156         fi;;
 157     esac
 158   fi
 159 fi
 160
 161 ### Find out which version of Emacs this is.
 162 version=`
 163   sed -n 's/^AC_INIT(GNU Emacs,[         ]*\([^  ,)]*\).*/\1/p' <configure.ac
 164 ` || version=
 165 if [ ! "${version}" ]; then
 166   echo "${progname}: can't find current Emacs version in \`./src/emacs.c'" >&2
 167   exit 1
 168 fi
 169
 170 echo Version number is $version
 171
 172 if [ $update = yes ]; then
 173   if ! grep -q "tree holds version  *${version}" README; then
 174     echo "WARNING: README has the wrong version number"
 175     echo "Consider running M-x set-version from admin/admin.el"
 176     sleep 5
 177   fi
 178 fi
 179
 180 ### Make sure we don't already have a directory  emacs-${version}.
 181
 182 emacsname="emacs-${version}${new_extension}"
 183
 184 if [ -d ${emacsname} ]
 185 then
 186   echo Directory "${emacsname}" already exists >&2
 187   exit 1
 188 fi
 189
 190 ### Make sure the subdirectory is available.
 191 tempparent="make-dist.tmp.$$"
 192 if [ -d ${tempparent} ]; then
 193   echo "${progname}: staging directory \`${tempparent}' already exists.
 194 Perhaps a previous invocation of \`${progname}' failed to clean up after
 195 itself.  Check that directories whose names are of the form
 196 \`make-dist.tmp.NNNNN' don't contain any important information, remove
 197 them, and try again." >&2
 198   exit 1
 199 fi
 200
 201 if [ $check = yes ]; then
 202   ls -1 lisp/[a-zA-Z]*.el lisp/[a-z]*/[a-zA-Z0-9]*.el \
 203         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
 204         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el > /tmp/el
 205
 206   ls -1 lisp/[a-zA-Z]*.elc lisp/[a-z]*/[a-zA-Z0-9]*.elc \
 207         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
 208         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc > /tmp/elc
 209
 210   ## Check for .elc files with no corresponding .el file.
 211   sed 's/\.el$/.elc/' /tmp/el > /tmp/elelc
 212
 213   bogosities="`comm -13 /tmp/elelc /tmp/elc`"
 214   if [ x"${bogosities}" != x"" ]; then
 215     echo "The following .elc files have no corresponding .el files:"
 216     echo "${bogosities}"
 217   fi
 218
 219   ### Check for .el files with no corresponding .elc file.
 220   sed 's/\.elc$/.el/' /tmp/elc > /tmp/elcel
 221   losers="`comm -23 /tmp/el /tmp/elcel`"
 222
 223   rm -f /tmp/el /tmp/elc /tmp/elcel /tmp/elelc
 224
 225   bogosities=
 226   for file in $losers; do
 227     grep -q "no-byte-compile: t" $file && continue
 228     case $file in
 229       site-init.el | site-load.el | site-start.el | default.el) continue ;;
 230     esac
 231
 232     bogosities="$file $bogosities"
 233
 234   done
 235   if [ x"${bogosities}" != x"" ]; then
 236     echo "The following .el files have no corresponding .elc files:"
 237     echo "${bogosities}"
 238   fi
 239 fi
 240
 241 if [ $update = yes ]; then
 242
 243   ## Make sure configure is newer than configure.ac, etc.
 244   ## It is better to let autoreconf do what is needed than
 245   ## for us to try and duplicate all its checks.
 246   echo "Running autoreconf"
 247   autoreconf -i -I m4 || { x=$?; echo Autoreconf FAILED! >&2; exit $x; }
 248
 249   ## Make sure src/stamp-h.in is newer than configure.ac.
 250   rm -f src/stamp-h.in
 251   echo timestamp > src/stamp-h.in
 252
 253   echo "Updating Info files"
 254   make info
 255
 256   echo "Updating finder, custom and autoload data"
 257   (cd lisp && make updates EMACS="$EMACS")
 258
 259   echo "Updating leim-list.el"
 260   (cd leim && make leim-list.el EMACS="$EMACS")
 261
 262   echo "Recompiling Lisp files"
 263   $EMACS -batch -f batch-byte-recompile-directory lisp
 264 fi                              # $update = yes
 265
 266 echo "Creating staging directory: \`${tempparent}'"
 267
 268 mkdir ${tempparent}
 269 tempdir="${tempparent}/${emacsname}"
 270
 271 ### This trap ensures that the staging directory will be cleaned up even
 272 ### when the script is interrupted in mid-career.
 273 if [ "${clean_up}" = yes ]; then
 274   trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
 275 fi
 276
 277 echo "Creating top directory: \`${tempdir}'"
 278 mkdir ${tempdir}
 279
 280 ### We copy in the top-level files before creating the subdirectories in
 281 ### hopes that this will make the top-level files appear first in the
 282 ### tar file; this means that people can start reading the INSTALL and
 283 ### README while the rest of the tar file is still unpacking.  Whoopee.
 284 echo "Making links to top-level files"
 285 ln INSTALL README BUGS ${tempdir}
 286 ln ChangeLog Makefile.in autogen.sh configure configure.ac ${tempdir}
 287 ln config.bat make-dist .dir-locals.el ${tempdir}
 288 ln aclocal.m4 ${tempdir}
 289
 290 echo "Creating subdirectories"
 291 for subdir in site-lisp \
 292               leim leim/CXTERM-DIC leim/MISC-DIC leim/SKK-DIC \
 293               build-aux build-aux/snippet \
 294               src src/bitmaps lib lib-src oldXMenu lwlib \
 295               nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
 296               `find etc lisp admin test -type d` \
 297               doc doc/emacs doc/misc doc/man doc/lispref doc/lispintro \
 298               info m4 msdos \
 299               nextstep nextstep/templates \
 300               nextstep/Cocoa nextstep/Cocoa/Emacs.base \
 301               nextstep/Cocoa/Emacs.base/Contents \
 302               nextstep/Cocoa/Emacs.base/Contents/Resources \
 303               nextstep/GNUstep \
 304               nextstep/GNUstep/Emacs.base \
 305               nextstep/GNUstep/Emacs.base/Resources
 306 do
 307
 308   if [ "$with_tests" != "yes" ]; then
 309     case $subdir in
 310         test*) continue ;;
 311     esac
 312   fi
 313
 314   ## site-lisp for in-place installs (?).
 315   [ "$subdir" = "site-lisp" ] || [ -d "$subdir" ] || \
 316       echo "WARNING: $subdir not found, making anyway"
 317   echo "  ${tempdir}/${subdir}"
 318   mkdir ${tempdir}/${subdir}
 319 done
 320
 321 echo "Making links to \`lisp' and its subdirectories"
 322 files=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
 323  -o -name 'README' \)`
 324
 325 ### Don't distribute site-init.el, site-load.el, or default.el.
 326 for file in lisp/Makefile.in lisp/makefile.w32-in $files; do
 327   case $file in
 328     */site-init*|*/site-load*|*/default*) continue ;;
 329   esac
 330   ln $file $tempdir/$file
 331 done
 332
 333 echo "Making links to \`leim' and its subdirectories"
 334 (cd leim
 335  ln makefile.w32-in ../${tempdir}/leim
 336  ln ChangeLog README ../${tempdir}/leim
 337  ln CXTERM-DIC/README CXTERM-DIC/*.tit ../${tempdir}/leim/CXTERM-DIC
 338  ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/leim/SKK-DIC
 339  ln MISC-DIC/README MISC-DIC/*.* ../${tempdir}/leim/MISC-DIC
 340  ln Makefile.in ../${tempdir}/leim/Makefile.in
 341  ln leim-ext.el ../${tempdir}/leim/leim-ext.el)
 342
 343 ## FIXME Can we not just use the "find -type f" method for this one?
 344 echo "Making links to \`build-aux'"
 345 (cd build-aux
 346  ln compile config.guess config.sub depcomp msys-to-w32 ../${tempdir}/build-aux
 347  ln install-sh missing move-if-change ../${tempdir}/build-aux
 348  ln update-copyright update-subdirs ../${tempdir}/build-aux
 349  ln dir_top make-info-dir ../${tempdir}/build-aux)
 350
 351 echo "Making links to \`build-aux/snippet'"
 352 (cd build-aux/snippet
 353  ln *.h ../../${tempdir}/build-aux/snippet)
 354
 355 echo "Making links to \`src'"
 356 ### Don't distribute the configured versions of
 357 ### config.in, paths.in, buildobj.h, or Makefile.in.
 358 (cd src
 359  echo "  (It is ok if ln fails in some cases.)"
 360  ln [a-zA-Z]*.[chm] ../${tempdir}/src
 361  ln [a-zA-Z]*.in ../${tempdir}/src
 362  ln [a-zA-Z]*.mk ../${tempdir}/src
 363  ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
 364  ln makefile.w32-in ../${tempdir}/src
 365  ln .gdbinit .dbxinit ../${tempdir}/src
 366  cd ../${tempdir}/src
 367  rm -f globals.h config.h epaths.h Makefile buildobj.h)
 368
 369 echo "Making links to \`src/bitmaps'"
 370 (cd src/bitmaps
 371  ln README *.xbm ../../${tempdir}/src/bitmaps)
 372
 373 echo "Making links to \`lib'"
 374 (snippet_h=`(cd build-aux/snippet && ls *.h)`
 375  cd lib
 376  ln [a-zA-Z]*.[ch] ../${tempdir}/lib
 377  ln gnulib.mk Makefile.am Makefile.in makefile.w32-in ../${tempdir}/lib
 378  cd ../${tempdir}/lib
 379  script='/[*]/d; s/\.in\.h$/.h/'
 380  rm -f `(echo "$snippet_h"; ls *.in.h) | sed "$script"`)
 381
 382 echo "Making links to \`lib-src'"
 383 (cd lib-src
 384  ln [a-zA-Z]*.[ch] ../${tempdir}/lib-src
 385  ln ChangeLog Makefile.in README ../${tempdir}/lib-src
 386  ln rcs2log ../${tempdir}/lib-src
 387  ln makefile.w32-in ../${tempdir}/lib-src
 388  ln update-game-score.exe.manifest ../${tempdir}/lib-src)
 389
 390 echo "Making links to \`m4'"
 391 (cd m4
 392  ln *.m4 ../${tempdir}/m4)
 393
 394 echo "Making links to \`nt'"
 395 (cd nt
 396  ln emacs-x86.manifest emacs-x64.manifest ../${tempdir}/nt
 397  ln config.nt emacs-src.tags ../${tempdir}/nt
 398  ln nmake.defs gmake.defs subdirs.el [a-z]*.bat [a-z]*.[ch] ../${tempdir}/nt
 399  ln *.in gnulib.mk ../${tempdir}/nt
 400  ln mingw-cfg.site epaths.nt INSTALL.OLD ../${tempdir}/nt
 401  ln ChangeLog INSTALL README README.W32 makefile.w32-in ../${tempdir}/nt)
 402
 403 echo "Making links to \`nt/inc' and its subdirectories"
 404 for f in `find nt/inc -type f -name '[a-z]*.h'`; do
 405   ln $f $tempdir/$f
 406 done
 407
 408 echo "Making links to \`nt/icons'"
 409 (cd nt/icons
 410  ln README [a-z]*.ico ../../${tempdir}/nt/icons
 411  ln [a-z]*.cur ../../${tempdir}/nt/icons)
 412
 413 echo "Making links to \`msdos'"
 414 (cd msdos
 415  ln ChangeLog INSTALL README emacs.ico emacs.pif ../${tempdir}/msdos
 416  ln depfiles.bat inttypes.h ../${tempdir}/msdos
 417  ln mainmake.v2 sed*.inp ../${tempdir}/msdos)
 418
 419 echo "Making links to \`nextstep'"
 420 (cd nextstep
 421  ln ChangeLog README INSTALL Makefile.in ../${tempdir}/nextstep)
 422
 423 echo "Making links to \`nextstep/templates'"
 424 (cd nextstep/templates
 425  ln Emacs.desktop.in Info-gnustep.plist.in Info.plist.in InfoPlist.strings.in ../../${tempdir}/nextstep/templates)
 426
 427 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents'"
 428 (cd nextstep/Cocoa/Emacs.base/Contents
 429  ln PkgInfo ../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents)
 430
 431 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents/Resources'"
 432 (cd nextstep/Cocoa/Emacs.base/Contents/Resources
 433  ln Credits.html *.icns ../../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents/Resources)
 434
 435 echo "Making links to \`nextstep/GNUstep/Emacs.base/Resources'"
 436 (cd nextstep/GNUstep/Emacs.base/Resources
 437  ln README emacs.tiff ../../../../${tempdir}/nextstep/GNUstep/Emacs.base/Resources )
 438
 439 echo "Making links to \`oldXMenu'"
 440 (cd oldXMenu
 441  ln *.[ch] *.in *.mk ../${tempdir}/oldXMenu
 442  ln README ChangeLog ../${tempdir}/oldXMenu)
 443
 444 echo "Making links to \`lwlib'"
 445 (cd lwlib
 446  ln *.[ch] *.in *.mk ../${tempdir}/lwlib
 447  ln README ChangeLog ../${tempdir}/lwlib)
 448
 449 ## It is important to distribute admin/ because it contains sources
 450 ## for generated lisp/international/uni-*.el files.
 451 echo "Making links to \`admin' and its subdirectories"
 452 for f in `find admin -type f`; do
 453   case $f in
 454     */Makefile) [ -f $f.in ] && continue ;;
 455   esac
 456   ln $f $tempdir/$f
 457 done
 458
 459 if [ "$with_tests" = "yes" ]; then
 460   echo "Making links to \`test' and its subdirectories"
 461   for f in `find test -type f`; do
 462     case $f in
 463       test/automated/*.log) continue ;;
 464       test/automated/flymake/warnpred/a.out) continue ;;
 465       test/automated/Makefile) continue ;;
 466     esac
 467     ln $f $tempdir/$f
 468   done
 469 fi
 470
 471 echo "Making links to \`etc' and its subdirectories"
 472 for f in `find etc -type f`; do
 473   case $f in
 474     etc/DOC*|etc/*.pyc) continue ;;
 475     ## Arguably we should not exclude *.ps.
 476     etc/refcards/*.aux|etc/refcards/*.dvi|etc/refcards/*.log|etc/refcards/*.ps)
 477       continue ;;
 478   esac
 479   ln $f $tempdir/$f
 480 done
 481
 482 echo "Making links to \`info'"
 483 ln `find info -type f -print` ${tempdir}/info
 484
 485 echo "Making links to \`doc/emacs'"
 486 (cd doc/emacs
 487  ln *.texi *.in makefile.w32-in ChangeLog* ../../${tempdir}/doc/emacs)
 488
 489 echo "Making links to \`doc/misc'"
 490 (cd doc/misc
 491  ln *.texi *.tex *.in makefile.w32-in gnus-news.el ChangeLog* ../../${tempdir}/doc/misc)
 492
 493 echo "Making links to \`doc/lispref'"
 494 (cd doc/lispref
 495  ln *.texi *.in makefile.w32-in README ChangeLog* ../../${tempdir}/doc/lispref
 496  ln spellfile ../../${tempdir}/doc/lispref
 497  ln two-volume.make two-volume-cross-refs.txt ../../${tempdir}/doc/lispref)
 498
 499 echo "Making links to \`doc/lispintro'"
 500 (cd doc/lispintro
 501  ln *.texi *.in makefile.w32-in *.eps *.pdf ../../${tempdir}/doc/lispintro
 502  ln README ChangeLog* ../../${tempdir}/doc/lispintro
 503  cd ../../${tempdir}/doc/lispintro)
 504
 505 echo "Making links to \`doc/man'"
 506 (cd doc/man
 507  ln ChangeLog* *.1 *.in ../../${tempdir}/doc/man
 508  cd ../../${tempdir}/doc/man
 509  rm -f emacs.1)
 510
 511 ### It would be nice if they could all be symlinks to top-level copy, but
 512 ### you're not supposed to have any symlinks in distribution tar files.
 513 echo "Making sure copying notices are all copies of \`COPYING'"
 514 for subdir in . etc leim lib lib-src lisp lwlib msdos nt src; do
 515   rm -f ${tempdir}/${subdir}/COPYING
 516   cp COPYING ${tempdir}/${subdir}
 517 done
 518
 519 if [ "${newer}" ]; then
 520   echo "Removing files older than $newer"
 521   ## We remove .elc files unconditionally, on the theory that anyone picking
 522   ## up an incremental distribution already has a running Emacs to byte-compile
 523   ## them with.
 524   find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
 525 fi
 526
 527 ## Don't distribute backups, autosaves, etc.
 528 echo "Removing unwanted files"
 529 find ${tempparent} \( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \) -exec rm -f {} \;
 530
 531 if [ "${make_tar}" = yes ]; then
 532   echo "Looking for $default_gzip"
 533   found=0
 534   temppath=`echo $PATH | sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' \
 535      -e 's/:/ /g'`
 536   for dir in ${temppath}; do
 537     [ -x ${dir}/$default_gzip ] || continue
 538     found=1; break
 539   done
 540   if [ "$found" = "0" ]; then
 541     echo "WARNING: \`$default_gzip' not found, will not compress" >&2
 542     default_gzip=cat
 543   fi
 544   case "${default_gzip}" in
 545     bzip2) gzip_extension=.bz2 ;;
 546     xz)  gzip_extension=.xz ;;
 547     gzip)  gzip_extension=.gz ; default_gzip="gzip --best";;
 548        *)  gzip_extension= ;;
 549   esac
 550   echo "Creating tar file"
 551   (cd ${tempparent} ; tar cvf - ${emacsname} ) \
 552     | ${default_gzip} \
 553     > ${emacsname}.tar${gzip_extension}
 554 fi
 555
 556 if [ "${clean_up}" != yes ]; then
 557   (cd ${tempparent}; mv ${emacsname} ..)
 558   rm -rf ${tempparent}
 559 fi
 560
 561 ### make-dist ends here