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-2014 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 "@set EMACSVER  *${version}" doc/emacs/emacsver.texi || \
 174      ! grep -q "tree holds version  *${version}" README; then
 175     echo "WARNING: README and/or emacsver.texi have the wrong version number"
 176     echo "Consider running M-x set-version from admin/admin.el"
 177     sleep 5
 178   fi
 179 fi
 180
 181 ### Make sure we don't already have a directory  emacs-${version}.
 182
 183 emacsname="emacs-${version}${new_extension}"
 184
 185 if [ -d ${emacsname} ]
 186 then
 187   echo Directory "${emacsname}" already exists >&2
 188   exit 1
 189 fi
 190
 191 ### Make sure the subdirectory is available.
 192 tempparent="make-dist.tmp.$$"
 193 if [ -d ${tempparent} ]; then
 194   echo "${progname}: staging directory \`${tempparent}' already exists.
 195 Perhaps a previous invocation of \`${progname}' failed to clean up after
 196 itself.  Check that directories whose names are of the form
 197 \`make-dist.tmp.NNNNN' don't contain any important information, remove
 198 them, and try again." >&2
 199   exit 1
 200 fi
 201
 202 if [ $check = yes ]; then
 203   ls -1 lisp/[a-zA-Z]*.el lisp/[a-z]*/[a-zA-Z0-9]*.el \
 204         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
 205         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el > /tmp/el
 206
 207   ls -1 lisp/[a-zA-Z]*.elc lisp/[a-z]*/[a-zA-Z0-9]*.elc \
 208         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
 209         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc > /tmp/elc
 210
 211   ## Check for .elc files with no corresponding .el file.
 212   sed 's/\.el$/.elc/' /tmp/el > /tmp/elelc
 213
 214   bogosities="`comm -13 /tmp/elelc /tmp/elc`"
 215   if [ x"${bogosities}" != x"" ]; then
 216     echo "The following .elc files have no corresponding .el files:"
 217     echo "${bogosities}"
 218   fi
 219
 220   ### Check for .el files with no corresponding .elc file.
 221   sed 's/\.elc$/.el/' /tmp/elc > /tmp/elcel
 222   losers="`comm -23 /tmp/el /tmp/elcel`"
 223
 224   rm -f /tmp/el /tmp/elc /tmp/elcel /tmp/elelc
 225
 226   bogosities=
 227   for file in $losers; do
 228     grep -q "no-byte-compile: t" $file && continue
 229     case $file in
 230       site-init.el | site-load.el | site-start.el | default.el) continue ;;
 231     esac
 232
 233     bogosities="$file $bogosities"
 234
 235   done
 236   if [ x"${bogosities}" != x"" ]; then
 237     echo "The following .el files have no corresponding .elc files:"
 238     echo "${bogosities}"
 239   fi
 240 fi
 241
 242 if [ $update = yes ]; then
 243
 244   ## Make sure configure is newer than configure.ac, etc.
 245   ## It is better to let autoreconf do what is needed than
 246   ## for us to try and duplicate all its checks.
 247   echo "Running autoreconf"
 248   autoreconf -i -I m4 || { x=$?; echo Autoreconf FAILED! >&2; exit $x; }
 249
 250   ## Make sure src/stamp-h.in is newer than configure.ac.
 251   rm -f src/stamp-h.in
 252   echo timestamp > src/stamp-h.in
 253
 254   echo "Updating Info files"
 255   make info
 256
 257   echo "Updating finder, custom and autoload data"
 258   (cd lisp && make updates EMACS="$EMACS")
 259
 260   echo "Updating leim-list.el"
 261   (cd leim && make leim-list.el EMACS="$EMACS")
 262
 263   echo "Recompiling Lisp files"
 264   $EMACS -batch -f batch-byte-recompile-directory lisp
 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 ${tempdir}
 287 ln ChangeLog Makefile.in autogen.sh configure configure.ac ${tempdir}
 288 ln config.bat make-dist .dir-locals.el ${tempdir}
 289 ln aclocal.m4 ${tempdir}
 290
 291 echo "Creating subdirectories"
 292 for subdir in site-lisp \
 293               leim leim/CXTERM-DIC leim/MISC-DIC leim/SKK-DIC \
 294               build-aux build-aux/snippet \
 295               src src/bitmaps lib lib-src oldXMenu lwlib \
 296               nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
 297               `find etc lisp admin test -type d` \
 298               doc doc/emacs doc/misc doc/man doc/lispref doc/lispintro \
 299               info m4 msdos \
 300               nextstep nextstep/templates \
 301               nextstep/Cocoa nextstep/Cocoa/Emacs.base \
 302               nextstep/Cocoa/Emacs.base/Contents \
 303               nextstep/Cocoa/Emacs.base/Contents/Resources \
 304               nextstep/GNUstep \
 305               nextstep/GNUstep/Emacs.base \
 306               nextstep/GNUstep/Emacs.base/Resources
 307 do
 308
 309   if [ "$with_tests" != "yes" ]; then
 310     case $subdir in
 311         test*) continue ;;
 312     esac
 313   fi
 314
 315   ## site-lisp for in-place installs (?).
 316   [ "$subdir" = "site-lisp" ] || [ -d "$subdir" ] || \
 317       echo "WARNING: $subdir not found, making anyway"
 318   echo "  ${tempdir}/${subdir}"
 319   mkdir ${tempdir}/${subdir}
 320 done
 321
 322 echo "Making links to \`lisp' and its subdirectories"
 323 files=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
 324  -o -name 'README' \)`
 325
 326 ### Don't distribute site-init.el, site-load.el, or default.el.
 327 for file in lisp/Makefile.in lisp/makefile.w32-in $files; do
 328   case $file in
 329     */site-init*|*/site-load*|*/default*) continue ;;
 330   esac
 331   ln $file $tempdir/$file
 332 done
 333
 334 echo "Making links to \`leim' and its subdirectories"
 335 (cd leim
 336  ln makefile.w32-in ../${tempdir}/leim
 337  ln ChangeLog README ../${tempdir}/leim
 338  ln CXTERM-DIC/README CXTERM-DIC/*.tit ../${tempdir}/leim/CXTERM-DIC
 339  ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/leim/SKK-DIC
 340  ln MISC-DIC/README MISC-DIC/*.* ../${tempdir}/leim/MISC-DIC
 341  ln Makefile.in ../${tempdir}/leim/Makefile.in
 342  ln leim-ext.el ../${tempdir}/leim/leim-ext.el)
 343
 344 ## FIXME Can we not just use the "find -type f" method for this one?
 345 echo "Making links to \`build-aux'"
 346 (cd build-aux
 347  ln compile config.guess config.sub depcomp msys-to-w32 ../${tempdir}/build-aux
 348  ln install-sh missing move-if-change ../${tempdir}/build-aux
 349  ln update-copyright update-subdirs ../${tempdir}/build-aux
 350  ln dir_top make-info-dir ../${tempdir}/build-aux)
 351
 352 echo "Making links to \`build-aux/snippet'"
 353 (cd build-aux/snippet
 354  ln *.h ../../${tempdir}/build-aux/snippet)
 355
 356 echo "Making links to \`src'"
 357 ### Don't distribute the configured versions of
 358 ### config.in, paths.in, buildobj.h, or Makefile.in.
 359 (cd src
 360  echo "  (It is ok if ln fails in some cases.)"
 361  ln [a-zA-Z]*.[chm] ../${tempdir}/src
 362  ln [a-zA-Z]*.in ../${tempdir}/src
 363  ln [a-zA-Z]*.mk ../${tempdir}/src
 364  ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
 365  ln makefile.w32-in ../${tempdir}/src
 366  ln .gdbinit .dbxinit ../${tempdir}/src
 367  cd ../${tempdir}/src
 368  rm -f globals.h config.h epaths.h Makefile buildobj.h)
 369
 370 echo "Making links to \`src/bitmaps'"
 371 (cd src/bitmaps
 372  ln README *.xbm ../../${tempdir}/src/bitmaps)
 373
 374 echo "Making links to \`lib'"
 375 (snippet_h=`(cd build-aux/snippet && ls *.h)`
 376  cd lib
 377  ln [a-zA-Z]*.[ch] ../${tempdir}/lib
 378  ln gnulib.mk Makefile.am Makefile.in makefile.w32-in ../${tempdir}/lib
 379  cd ../${tempdir}/lib
 380  script='/[*]/d; s/\.in\.h$/.h/'
 381  rm -f `(echo "$snippet_h"; ls *.in.h) | sed "$script"`)
 382
 383 echo "Making links to \`lib-src'"
 384 (cd lib-src
 385  ln [a-zA-Z]*.[ch] ../${tempdir}/lib-src
 386  ln ChangeLog Makefile.in README ../${tempdir}/lib-src
 387  ln grep-changelog rcs2log ../${tempdir}/lib-src
 388  ln makefile.w32-in ../${tempdir}/lib-src
 389  ln update-game-score.exe.manifest ../${tempdir}/lib-src)
 390
 391 echo "Making links to \`m4'"
 392 (cd m4
 393  ln *.m4 ../${tempdir}/m4)
 394
 395 echo "Making links to \`nt'"
 396 (cd nt
 397  ln emacs-x86.manifest emacs-x64.manifest emacs.rc ../${tempdir}/nt
 398  ln config.nt emacsclient.rc emacs-src.tags ../${tempdir}/nt
 399  ln nmake.defs gmake.defs subdirs.el [a-z]*.bat [a-z]*.[ch] ../${tempdir}/nt
 400  ln Makefile.in gnulib.mk ../${tempdir}/nt
 401  ln mingw-cfg.site epaths.nt INSTALL.OLD ../${tempdir}/nt
 402  ln ChangeLog INSTALL README README.W32 makefile.w32-in ../${tempdir}/nt)
 403
 404 echo "Making links to \`nt/inc' and its subdirectories"
 405 for f in `find nt/inc -type f -name '[a-z]*.h'`; do
 406   ln $f $tempdir/$f
 407 done
 408
 409 echo "Making links to \`nt/icons'"
 410 (cd nt/icons
 411  ln README [a-z]*.ico ../../${tempdir}/nt/icons
 412  ln [a-z]*.cur ../../${tempdir}/nt/icons)
 413
 414 echo "Making links to \`msdos'"
 415 (cd msdos
 416  ln ChangeLog INSTALL README emacs.ico emacs.pif ../${tempdir}/msdos
 417  ln depfiles.bat inttypes.h ../${tempdir}/msdos
 418  ln is_exec.c sigaction.c mainmake.v2 sed*.inp ../${tempdir}/msdos)
 419
 420 echo "Making links to \`nextstep'"
 421 (cd nextstep
 422  ln ChangeLog README INSTALL Makefile.in ../${tempdir}/nextstep)
 423
 424 echo "Making links to \`nextstep/templates'"
 425 (cd nextstep/templates
 426  ln Emacs.desktop.in Info-gnustep.plist.in Info.plist.in InfoPlist.strings.in ../../${tempdir}/nextstep/templates)
 427
 428 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents'"
 429 (cd nextstep/Cocoa/Emacs.base/Contents
 430  ln PkgInfo ../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents)
 431
 432 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents/Resources'"
 433 (cd nextstep/Cocoa/Emacs.base/Contents/Resources
 434  ln Credits.html *.icns ../../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents/Resources)
 435
 436 echo "Making links to \`nextstep/GNUstep/Emacs.base/Resources'"
 437 (cd nextstep/GNUstep/Emacs.base/Resources
 438  ln README emacs.tiff ../../../../${tempdir}/nextstep/GNUstep/Emacs.base/Resources )
 439
 440 echo "Making links to \`oldXMenu'"
 441 (cd oldXMenu
 442  ln *.[ch] *.in ../${tempdir}/oldXMenu
 443  ln README ChangeLog ../${tempdir}/oldXMenu)
 444
 445 echo "Making links to \`lwlib'"
 446 (cd lwlib
 447  ln *.[ch] *.in ../${tempdir}/lwlib
 448  ln README ChangeLog ../${tempdir}/lwlib)
 449
 450 ## It is important to distribute admin/ because it contains sources
 451 ## for generated lisp/international/uni-*.el files.
 452 echo "Making links to \`admin' and its subdirectories"
 453 for f in `find admin -type f`; do
 454   case $f in
 455     */Makefile) [ -f $f.in ] && continue ;;
 456   esac
 457   ln $f $tempdir/$f
 458 done
 459
 460 if [ "$with_tests" = "yes" ]; then
 461   echo "Making links to \`test' and its subdirectories"
 462   for f in `find test -type f`; do
 463     case $f in
 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 ../../${tempdir}/doc/man
 508  cd ../../${tempdir}/doc/man)
 509
 510 ### It would be nice if they could all be symlinks to top-level copy, but
 511 ### you're not supposed to have any symlinks in distribution tar files.
 512 echo "Making sure copying notices are all copies of \`COPYING'"
 513 for subdir in . etc leim lib lib-src lisp lwlib msdos nt src; do
 514   rm -f ${tempdir}/${subdir}/COPYING
 515   cp COPYING ${tempdir}/${subdir}
 516 done
 517
 518 if [ "${newer}" ]; then
 519   echo "Removing files older than $newer"
 520   ## We remove .elc files unconditionally, on the theory that anyone picking
 521   ## up an incremental distribution already has a running Emacs to byte-compile
 522   ## them with.
 523   find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
 524 fi
 525
 526 ## Don't distribute backups, autosaves, etc.
 527 echo "Removing unwanted files"
 528 find ${tempparent} \( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \) -exec rm -f {} \;
 529
 530 if [ "${make_tar}" = yes ]; then
 531   echo "Looking for $default_gzip"
 532   found=0
 533   temppath=`echo $PATH | sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' \
 534      -e 's/:/ /g'`
 535   for dir in ${temppath}; do
 536     [ -x ${dir}/$default_gzip ] || continue
 537     found=1; break
 538   done
 539   if [ "$found" = "0" ]; then
 540     echo "WARNING: \`$default_gzip' not found, will not compress" >&2
 541     default_gzip=cat
 542   fi
 543   case "${default_gzip}" in
 544     bzip2) gzip_extension=.bz2 ;;
 545     xz)  gzip_extension=.xz ;;
 546     gzip)  gzip_extension=.gz ; default_gzip="gzip --best";;
 547        *)  gzip_extension= ;;
 548   esac
 549   echo "Creating tar file"
 550   (cd ${tempparent} ; tar cvf - ${emacsname} ) \
 551     | ${default_gzip} \
 552     > ${emacsname}.tar${gzip_extension}
 553 fi
 554
 555 if [ "${clean_up}" != yes ]; then
 556   (cd ${tempparent}; mv ${emacsname} ..)
 557   rm -rf ${tempparent}
 558 fi
 559
 560 ### make-dist ends here