make-dist 17 KB
Newer Older
1 2 3
#!/bin/sh
### make-dist: create an Emacs distribution tar file from current srcdir

4
## Copyright (C) 1995, 1997-1998, 2000-2014 Free Software Foundation, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

## This file is part of GNU Emacs.

## GNU Emacs is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.

## GNU Emacs is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.

## You should have received a copy of the GNU General Public License
## along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

### Commentary:

## This basically creates a duplicate directory structure, and then
## hard links into it only those files that should be distributed.
## This means that if you add a file with an odd name, you should make
## sure that this script will include it.

### Code:

progname="$0"

### Exit if a command fails.
#set -e

### Print out each line we read, for debugging's sake.
#set -v

LANGUAGE=C
LC_ALL=C
LC_MESSAGES=
LANG=
export LANGUAGE LC_ALL LC_MESSAGES LANG

44 45
## Remove unnecessary restrictions on file access.
umask 022
46 47 48 49 50 51 52

update=yes
check=yes
clean_up=no
make_tar=no
default_gzip=gzip
newer=""
53
with_tests=no
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

while [ $# -gt 0 ]; do
  case "$1" in
    ## This option tells make-dist to delete the staging directory
    ## when done.  It is useless to use this unless you make a tar file.
    "--clean-up" )
      clean_up=yes
    ;;
    ## This option tells make-dist to make a tar file.
    "--tar" )
      make_tar=yes
    ;;
    ## This option tells make-dist not to recompile or do analogous things.
    "--no-update" )
      update=no
    ;;
    ## This option says don't check for bad file names, etc.
    "--no-check" )
      check=no
    ;;
    ## This option tells make-dist to make the distribution normally, then
    ## remove all files older than the given timestamp file.  This is useful
    ## for creating incremental or patch distributions.
    "--newer")
      newer="$2"
      new_extension=".new"
      shift
    ;;
    ## This option tells make-dist to use `bzip2' instead of gzip.
    "--bzip2")
      default_gzip="bzip2"
    ;;
86 87 88 89 90 91 92
    ## Same with xz.
    "--xz")
      default_gzip="xz"
    ;;
    "--no-compress")
      default_gzip="cat"
    ;;
93 94 95 96 97 98 99 100

    "--snapshot")
      clean_up=yes
      make_tar=yes
      update=no
      check=no
     ;;

101 102 103 104 105 106
    ## Include the test/ directory.
    ## This option is mainly for the hydra build server.
    "--tests")
      with_tests=yes
     ;;

107 108 109 110 111
    "--help")
      echo "Usage: ${progname} [options]"
      echo ""
      echo "  --bzip2	use bzip2 instead of gzip"
      echo "  --clean-up	delete staging directories when done"
112 113
      echo "  --xz		use xz instead of gzip"
      echo "  --no-compress	don't compress"
114 115 116 117 118
      echo "  --newer=TIME	don't include files older than TIME"
      echo "  --no-check	don't check for bad file names etc."
      echo "  --no-update	don't recompile or do analogous things"
      echo "  --snapshot	same as --clean-up --no-update --tar --no-check"
      echo "  --tar		make a tar file"
119
      echo "  --tests	include the test/ directory"
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
      echo ""
      exit 0
    ;;

    * )
      echo "${progname}: Unrecognized argument: $1" >&2
      exit 1
    ;;
  esac
  shift
done

### Make sure we're running in the right place.
if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/subr.el ]; then
  echo "${progname}: Can't find \`src/lisp.h' and \`lisp/subr.el'." >&2
  echo "${progname} must be run in the top directory of the Emacs" >&2
  echo "distribution tree.  cd to that directory and try again." >&2
  exit 1
fi

### Find where to run Emacs.
### (Accept only absolute file names.)
if [ $update = yes ];
then
  if [ -f src/emacs ];
  then
    EMACS=`pwd`/src/emacs
  else
    case $EMACS in
      /*) ;;
      *)
	if [ ! -f "$EMACS" ]; then
	  echo "$0: You must set the EMACS environment variable " \
	       "to an absolute file name." 2>&1
	  exit 1
	fi;;
    esac
  fi
fi

### Find out which version of Emacs this is.
161
version=`
162
  sed -n 's/^AC_INIT(GNU Emacs,[	 ]*\([^	 ,)]*\).*/\1/p' <configure.ac
163
` || version=
164 165 166 167 168 169 170 171
if [ ! "${version}" ]; then
  echo "${progname}: can't find current Emacs version in \`./src/emacs.c'" >&2
  exit 1
fi

echo Version number is $version

if [ $update = yes ]; then
172 173
  if ! grep -q "tree holds version  *${version}" README; then
    echo "WARNING: README has the wrong version number"
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    echo "Consider running M-x set-version from admin/admin.el"
    sleep 5
  fi
fi

### Make sure we don't already have a directory  emacs-${version}.

emacsname="emacs-${version}${new_extension}"

if [ -d ${emacsname} ]
then
  echo Directory "${emacsname}" already exists >&2
  exit 1
fi

### Make sure the subdirectory is available.
tempparent="make-dist.tmp.$$"
if [ -d ${tempparent} ]; then
  echo "${progname}: staging directory \`${tempparent}' already exists.
Perhaps a previous invocation of \`${progname}' failed to clean up after
itself.  Check that directories whose names are of the form
\`make-dist.tmp.NNNNN' don't contain any important information, remove
them, and try again." >&2
  exit 1
fi

if [ $check = yes ]; then
  ls -1 lisp/[a-zA-Z]*.el lisp/[a-z]*/[a-zA-Z0-9]*.el \
	lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
203
	lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el > /tmp/el
204 205 206

  ls -1 lisp/[a-zA-Z]*.elc lisp/[a-z]*/[a-zA-Z0-9]*.elc \
	lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
207
	lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc > /tmp/elc
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

  ## Check for .elc files with no corresponding .el file.
  sed 's/\.el$/.elc/' /tmp/el > /tmp/elelc

  bogosities="`comm -13 /tmp/elelc /tmp/elc`"
  if [ x"${bogosities}" != x"" ]; then
    echo "The following .elc files have no corresponding .el files:"
    echo "${bogosities}"
  fi

  ### Check for .el files with no corresponding .elc file.
  sed 's/\.elc$/.el/' /tmp/elc > /tmp/elcel
  losers="`comm -23 /tmp/el /tmp/elcel`"

  rm -f /tmp/el /tmp/elc /tmp/elcel /tmp/elelc

  bogosities=
  for file in $losers; do
    grep -q "no-byte-compile: t" $file && continue
    case $file in
      site-init.el | site-load.el | site-start.el | default.el) continue ;;
    esac

    bogosities="$file $bogosities"

  done
  if [ x"${bogosities}" != x"" ]; then
    echo "The following .el files have no corresponding .elc files:"
    echo "${bogosities}"
  fi
fi

if [ $update = yes ]; then

242
  ## Make sure configure is newer than configure.ac, etc.
Glenn Morris's avatar
Glenn Morris committed
243 244 245 246
  ## It is better to let autoreconf do what is needed than
  ## for us to try and duplicate all its checks.
  echo "Running autoreconf"
  autoreconf -i -I m4 || { x=$?; echo Autoreconf FAILED! >&2; exit $x; }
247

248
  ## Make sure src/stamp-h.in is newer than configure.ac.
Glenn Morris's avatar
Glenn Morris committed
249 250
  rm -f src/stamp-h.in
  echo timestamp > src/stamp-h.in
251 252

  echo "Updating Info files"
253
  make info
254 255

  echo "Updating finder, custom and autoload data"
Glenn Morris's avatar
Glenn Morris committed
256
  (cd lisp && make updates EMACS="$EMACS")
257

Glenn Morris's avatar
Glenn Morris committed
258 259
  echo "Updating leim-list.el"
  (cd leim && make leim-list.el EMACS="$EMACS")
260 261

  echo "Recompiling Lisp files"
262
  $EMACS -batch -f batch-byte-recompile-directory lisp
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
fi                              # $update = yes

echo "Creating staging directory: \`${tempparent}'"

mkdir ${tempparent}
tempdir="${tempparent}/${emacsname}"

### This trap ensures that the staging directory will be cleaned up even
### when the script is interrupted in mid-career.
if [ "${clean_up}" = yes ]; then
  trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
fi

echo "Creating top directory: \`${tempdir}'"
mkdir ${tempdir}

### We copy in the top-level files before creating the subdirectories in
### hopes that this will make the top-level files appear first in the
### tar file; this means that people can start reading the INSTALL and
### README while the rest of the tar file is still unpacking.  Whoopee.
echo "Making links to top-level files"
284
ln INSTALL README BUGS ${tempdir}
285
ln ChangeLog Makefile.in autogen.sh configure configure.ac ${tempdir}
286
ln config.bat make-dist .dir-locals.el ${tempdir}
Paul Eggert's avatar
Paul Eggert committed
287
ln aclocal.m4 ${tempdir}
288 289 290

echo "Creating subdirectories"
for subdir in site-lisp \
291
	      leim leim/CXTERM-DIC leim/MISC-DIC leim/SKK-DIC \
292
	      build-aux build-aux/snippet \
293
	      src src/bitmaps lib lib-src oldXMenu lwlib \
294
	      nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
295
	      `find etc lisp admin test -type d` \
296
	      doc doc/emacs doc/misc doc/man doc/lispref doc/lispintro \
Eli Zaretskii's avatar
Eli Zaretskii committed
297
	      info m4 msdos \
298 299
	      nextstep nextstep/templates \
	      nextstep/Cocoa nextstep/Cocoa/Emacs.base \
300 301 302 303 304 305
	      nextstep/Cocoa/Emacs.base/Contents \
	      nextstep/Cocoa/Emacs.base/Contents/Resources \
	      nextstep/GNUstep \
	      nextstep/GNUstep/Emacs.base \
	      nextstep/GNUstep/Emacs.base/Resources
do
306 307 308 309 310 311 312

  if [ "$with_tests" != "yes" ]; then
    case $subdir in
        test*) continue ;;
    esac
  fi

313 314 315 316 317 318 319 320 321
  ## site-lisp for in-place installs (?).
  [ "$subdir" = "site-lisp" ] || [ -d "$subdir" ] || \
      echo "WARNING: $subdir not found, making anyway"
  echo "  ${tempdir}/${subdir}"
  mkdir ${tempdir}/${subdir}
done

echo "Making links to \`lisp' and its subdirectories"
files=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
322
 -o -name 'README' \)`
323 324

### Don't distribute site-init.el, site-load.el, or default.el.
325
for file in lisp/Makefile.in lisp/makefile.w32-in $files; do
326 327 328 329 330 331 332 333
  case $file in
    */site-init*|*/site-load*|*/default*) continue ;;
  esac
  ln $file $tempdir/$file
done

echo "Making links to \`leim' and its subdirectories"
(cd leim
334
 ln makefile.w32-in ../${tempdir}/leim
335 336 337 338 339
 ln ChangeLog README ../${tempdir}/leim
 ln CXTERM-DIC/README CXTERM-DIC/*.tit ../${tempdir}/leim/CXTERM-DIC
 ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/leim/SKK-DIC
 ln MISC-DIC/README MISC-DIC/*.* ../${tempdir}/leim/MISC-DIC
 ln Makefile.in ../${tempdir}/leim/Makefile.in
340
 ln leim-ext.el ../${tempdir}/leim/leim-ext.el)
341

342
## FIXME Can we not just use the "find -type f" method for this one?
343 344
echo "Making links to \`build-aux'"
(cd build-aux
345
 ln compile config.guess config.sub depcomp msys-to-w32 ../${tempdir}/build-aux
346 347
 ln install-sh missing move-if-change ../${tempdir}/build-aux
 ln update-copyright update-subdirs ../${tempdir}/build-aux
348
 ln dir_top make-info-dir ../${tempdir}/build-aux)
349 350 351 352 353

echo "Making links to \`build-aux/snippet'"
(cd build-aux/snippet
 ln *.h ../../${tempdir}/build-aux/snippet)

354 355 356 357 358 359 360 361 362
echo "Making links to \`src'"
### Don't distribute the configured versions of
### config.in, paths.in, buildobj.h, or Makefile.in.
(cd src
 echo "  (It is ok if ln fails in some cases.)"
 ln [a-zA-Z]*.[chm] ../${tempdir}/src
 ln [a-zA-Z]*.in ../${tempdir}/src
 ln [a-zA-Z]*.mk ../${tempdir}/src
 ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
363
 ln makefile.w32-in ../${tempdir}/src
364 365
 ln .gdbinit .dbxinit ../${tempdir}/src
 cd ../${tempdir}/src
366
 rm -f globals.h config.h epaths.h Makefile buildobj.h)
367 368 369 370 371

echo "Making links to \`src/bitmaps'"
(cd src/bitmaps
 ln README *.xbm ../../${tempdir}/src/bitmaps)

Paul Eggert's avatar
Paul Eggert committed
372
echo "Making links to \`lib'"
373
(snippet_h=`(cd build-aux/snippet && ls *.h)`
Paul Eggert's avatar
Paul Eggert committed
374 375
 cd lib
 ln [a-zA-Z]*.[ch] ../${tempdir}/lib
376
 ln gnulib.mk Makefile.am Makefile.in makefile.w32-in ../${tempdir}/lib
Paul Eggert's avatar
Paul Eggert committed
377
 cd ../${tempdir}/lib
378 379
 script='/[*]/d; s/\.in\.h$/.h/'
 rm -f `(echo "$snippet_h"; ls *.in.h) | sed "$script"`)
Paul Eggert's avatar
Paul Eggert committed
380

381 382 383
echo "Making links to \`lib-src'"
(cd lib-src
 ln [a-zA-Z]*.[ch] ../${tempdir}/lib-src
384
 ln ChangeLog Makefile.in README ../${tempdir}/lib-src
Glenn Morris's avatar
Glenn Morris committed
385
 ln rcs2log ../${tempdir}/lib-src
386 387
 ln makefile.w32-in ../${tempdir}/lib-src
 ln update-game-score.exe.manifest ../${tempdir}/lib-src)
388 389 390 391 392 393 394

echo "Making links to \`m4'"
(cd m4
 ln *.m4 ../${tempdir}/m4)

echo "Making links to \`nt'"
(cd nt
395 396
 ln emacs-x86.manifest emacs-x64.manifest ../${tempdir}/nt
 ln config.nt emacs-src.tags ../${tempdir}/nt
397
 ln nmake.defs gmake.defs subdirs.el [a-z]*.bat [a-z]*.[ch] ../${tempdir}/nt
398
 ln *.in gnulib.mk ../${tempdir}/nt
Dani Moncayo's avatar
Dani Moncayo committed
399
 ln mingw-cfg.site epaths.nt INSTALL.OLD ../${tempdir}/nt
400
 ln ChangeLog INSTALL README README.W32 makefile.w32-in ../${tempdir}/nt)
401 402 403 404 405 406 407 408 409 410 411 412 413 414

echo "Making links to \`nt/inc' and its subdirectories"
for f in `find nt/inc -type f -name '[a-z]*.h'`; do
  ln $f $tempdir/$f
done

echo "Making links to \`nt/icons'"
(cd nt/icons
 ln README [a-z]*.ico ../../${tempdir}/nt/icons
 ln [a-z]*.cur ../../${tempdir}/nt/icons)

echo "Making links to \`msdos'"
(cd msdos
 ln ChangeLog INSTALL README emacs.ico emacs.pif ../${tempdir}/msdos
415
 ln depfiles.bat inttypes.h ../${tempdir}/msdos
416
 ln mainmake.v2 sed*.inp ../${tempdir}/msdos)
417 418 419

echo "Making links to \`nextstep'"
(cd nextstep
420
 ln ChangeLog README INSTALL Makefile.in ../${tempdir}/nextstep)
421

422 423
echo "Making links to \`nextstep/templates'"
(cd nextstep/templates
Glenn Morris's avatar
Glenn Morris committed
424
 ln Emacs.desktop.in Info-gnustep.plist.in Info.plist.in InfoPlist.strings.in ../../${tempdir}/nextstep/templates)
425

426 427
echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents'"
(cd nextstep/Cocoa/Emacs.base/Contents
428
 ln PkgInfo ../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents)
429 430 431 432 433 434 435

echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents/Resources'"
(cd nextstep/Cocoa/Emacs.base/Contents/Resources
 ln Credits.html *.icns ../../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents/Resources)

echo "Making links to \`nextstep/GNUstep/Emacs.base/Resources'"
(cd nextstep/GNUstep/Emacs.base/Resources
436
 ln README emacs.tiff ../../../../${tempdir}/nextstep/GNUstep/Emacs.base/Resources )
437 438 439

echo "Making links to \`oldXMenu'"
(cd oldXMenu
440
 ln *.[ch] *.in *.mk ../${tempdir}/oldXMenu
441 442 443 444
 ln README ChangeLog ../${tempdir}/oldXMenu)

echo "Making links to \`lwlib'"
(cd lwlib
445
 ln *.[ch] *.in *.mk ../${tempdir}/lwlib
446 447
 ln README ChangeLog ../${tempdir}/lwlib)

Glenn Morris's avatar
Glenn Morris committed
448 449
## It is important to distribute admin/ because it contains sources
## for generated lisp/international/uni-*.el files.
450 451
echo "Making links to \`admin' and its subdirectories"
for f in `find admin -type f`; do
452
  case $f in
453
    */Makefile) [ -f $f.in ] && continue ;;
454
  esac
455 456 457
  ln $f $tempdir/$f
done

458 459 460 461
if [ "$with_tests" = "yes" ]; then
  echo "Making links to \`test' and its subdirectories"
  for f in `find test -type f`; do
    case $f in
462
      test/automated/*.log) continue ;;
463 464 465 466 467 468 469
      test/automated/flymake/warnpred/a.out) continue ;;
      test/automated/Makefile) continue ;;
    esac
    ln $f $tempdir/$f
  done
fi

470 471 472
echo "Making links to \`etc' and its subdirectories"
for f in `find etc -type f`; do
  case $f in
Glenn Morris's avatar
Glenn Morris committed
473
    etc/DOC*|etc/*.pyc) continue ;;
474 475 476
    ## Arguably we should not exclude *.ps.
    etc/refcards/*.aux|etc/refcards/*.dvi|etc/refcards/*.log|etc/refcards/*.ps)
      continue ;;
477 478 479 480 481 482 483 484 485
  esac
  ln $f $tempdir/$f
done

echo "Making links to \`info'"
ln `find info -type f -print` ${tempdir}/info

echo "Making links to \`doc/emacs'"
(cd doc/emacs
486
 ln *.texi *.in makefile.w32-in ChangeLog* ../../${tempdir}/doc/emacs)
487 488 489

echo "Making links to \`doc/misc'"
(cd doc/misc
490
 ln *.texi *.tex *.in makefile.w32-in gnus-news.el ChangeLog* ../../${tempdir}/doc/misc)
491 492 493

echo "Making links to \`doc/lispref'"
(cd doc/lispref
494
 ln *.texi *.in makefile.w32-in README ChangeLog* ../../${tempdir}/doc/lispref
Glenn Morris's avatar
Glenn Morris committed
495 496
 ln spellfile ../../${tempdir}/doc/lispref
 ln two-volume.make two-volume-cross-refs.txt ../../${tempdir}/doc/lispref)
497 498 499

echo "Making links to \`doc/lispintro'"
(cd doc/lispintro
500
 ln *.texi *.in makefile.w32-in *.eps *.pdf ../../${tempdir}/doc/lispintro
501 502 503 504 505
 ln README ChangeLog* ../../${tempdir}/doc/lispintro
 cd ../../${tempdir}/doc/lispintro)

echo "Making links to \`doc/man'"
(cd doc/man
506 507 508
 ln ChangeLog* *.1 *.in ../../${tempdir}/doc/man
 cd ../../${tempdir}/doc/man
 rm -f emacs.1)
509 510 511 512

### It would be nice if they could all be symlinks to top-level copy, but
### you're not supposed to have any symlinks in distribution tar files.
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 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
  rm -f ${tempdir}/${subdir}/COPYING
  cp COPYING ${tempdir}/${subdir}
done

if [ "${newer}" ]; then
  echo "Removing files older than $newer"
  ## We remove .elc files unconditionally, on the theory that anyone picking
  ## up an incremental distribution already has a running Emacs to byte-compile
  ## them with.
  find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
fi

## Don't distribute backups, autosaves, etc.
echo "Removing unwanted files"
find ${tempparent} \( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \) -exec rm -f {} \;

if [ "${make_tar}" = yes ]; then
  echo "Looking for $default_gzip"
  found=0
  temppath=`echo $PATH | sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' \
     -e 's/:/ /g'`
  for dir in ${temppath}; do
    [ -x ${dir}/$default_gzip ] || continue
    found=1; break
  done
  if [ "$found" = "0" ]; then
    echo "WARNING: \`$default_gzip' not found, will not compress" >&2
    default_gzip=cat
  fi
  case "${default_gzip}" in
    bzip2) gzip_extension=.bz2 ;;
545
    xz)  gzip_extension=.xz ;;
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
    gzip)  gzip_extension=.gz ; default_gzip="gzip --best";;
       *)  gzip_extension= ;;
  esac
  echo "Creating tar file"
  (cd ${tempparent} ; tar cvf - ${emacsname} ) \
    | ${default_gzip} \
    > ${emacsname}.tar${gzip_extension}
fi

if [ "${clean_up}" != yes ]; then
  (cd ${tempparent}; mv ${emacsname} ..)
  rm -rf ${tempparent}
fi

### make-dist ends here