(diary-remind): Rewritten to behave sensibly for
[emacs.git] / make-dist
bloba09d988a85f5defd0fea95e2a39b9e2b18c3708b
1 #!/bin/sh
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.
9 # Copyright (C) 1995, 1997, 1998 Free Software Foundation, Inc.
11 # This file is part of GNU Emacs.
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.
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.
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 the
25 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 # Boston, MA 02111-1307, USA.
28 progname="$0"
30 ### Exit if a command fails.
31 ### set -e
33 ### Print out each line we read, for debugging's sake.
34 ### set -v
36 ## Don't restrict access to any files.
37 umask 0
39 update=yes
40 check=yes
41 clean_up=no
42 make_tar=no
43 newer=""
45 while [ $# -gt 0 ]; do
46 case "$1" in
47 ## This option tells make-dist to delete the staging directory
48 ## when done. It is useless to use this unless you make a tar file.
49 "--clean-up" )
50 clean_up=yes
52 ## This option tells make-dist to make a tar file.
53 "--tar" )
54 make_tar=yes
56 ## This option tells make-dist not to recompile or do analogous things.
57 "--no-update" )
58 update=no
60 ## This option says don't check for bad file names, etc.
61 "--no-check" )
62 check=no
64 ## This option tells make-dist to make the distribution normally, then
65 ## remove all files older than the given timestamp file. This is useful
66 ## for creating incremental or patch distributions.
67 "--newer")
68 newer="$2"
69 new_extension=".new"
70 shift
72 ## This option tells make-dist to use `compress' instead of gzip.
73 ## Normally, make-dist uses gzip whenever it is present.
74 "--compress")
75 default_gzip="compress"
77 * )
78 echo "${progname}: Unrecognized argument: $1" >&2
79 exit 1
81 esac
82 shift
83 done
85 ### Make sure we're running in the right place.
86 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/version.el ]; then
87 echo "${progname}: Can't find \`src/lisp.h' and \`lisp/version.el'." >&2
88 echo "${progname} must be run in the top directory of the Emacs" >&2
89 echo "distribution tree. cd to that directory and try again." >&2
90 exit 1
93 ### Find where to run Emacs.
94 ### (We don't accept EMACS=t as an answer, since that probably only means
95 ### that the shell is running in an Emacs window.)
96 if [ $update = yes ];
97 then
98 if [ -f src/emacs ];
99 then
100 EMACS=`pwd`/src/emacs
101 else
102 if [ "x$EMACS" = "x" -o "x$EMACS" = "xt" ];
103 then
104 echo You must specify the EMACS environment variable 2>&1
105 exit 1
110 ### Find out which version of Emacs this is.
111 shortversion=`grep 'defconst[ ]*emacs-version' lisp/version.el \
112 | sed -e 's/^.*"\([0-9][0-9]*\.[0-9][0-9]*\).*$/\1/'`
113 version=`grep 'defconst[ ]*emacs-version' lisp/version.el \
114 | sed -e 's/^[^"]*"\([^"]*\)".*$/\1/'`
115 if [ ! "${version}" ]; then
116 echo "${progname}: can't find current Emacs version in \`./lisp/version.el'" >&2
117 exit 1
120 echo Version numbers are $version and $shortversion
122 if [ $update = yes ];
123 then
124 if grep -s "GNU Emacs version ${shortversion}" ./man/emacs.texi > /dev/null; then
125 true
126 else
127 echo "You must update the version number in \`./man/emacs.texi'"
128 sleep 5
132 ### Make sure we don't already have a directory emacs-${version}.
134 emacsname="emacs-${version}${new_extension}"
136 if [ -d ${emacsname} ]
137 then
138 echo Directory "${emacsname}" already exists >&2
139 exit 1
142 ### Make sure the subdirectory is available.
143 tempparent="make-dist.tmp.$$"
144 if [ -d ${tempparent} ]; then
145 echo "${progname}: staging directory \`${tempparent}' already exists.
146 Perhaps a previous invocation of \`${progname}' failed to clean up after
147 itself. Check that directories whose names are of the form
148 \`make-dist.tmp.NNNNN' don't contain any important information, remove
149 them, and try again." >&2
150 exit 1
153 ### Find where to run Emacs.
154 if [ $check = yes ];
155 then
156 ### Check for .elc files with no corresponding .el file.
157 ls -1 lisp/[a-z]*.el lisp/[a-z]*/[a-z]*.el \
158 leim/[a-z]*.el leim/[a-z]*/[a-z]*.el | sed 's/\.el$/.elc/' > /tmp/el
159 ls -1 lisp/[a-z]*.elc lisp/[a-z]*/[a-z]*.elc \
160 leim/[a-z]*.elc leim/[a-z]*/[a-z]*.elc > /tmp/elc
161 bogosities="`comm -13 /tmp/el /tmp/elc`"
162 if [ "${bogosities}" != "" ]; then
163 echo "The following .elc files have no corresponding .el files:"
164 echo "${bogosities}"
166 rm -f /tmp/el /tmp/elc
168 ### Check for .el files with no corresponding .elc file.
169 (cd lisp; ls -1 [a-z]*.el [a-z]*/[a-z]*.el ; \
170 cd ../leim; ls -1 [a-z]*.el [a-z]*/[a-z]*.el) > /tmp/el
171 (cd lisp; ls -1 [a-z]*.elc [a-z]*/[a-z]*.elc; \
172 cd ../leim; ls -1 [a-z]*.elc [a-z]*/[a-z]*.elc) | sed 's/\.elc$/.el/' > /tmp/elc
173 losers="`comm -23 /tmp/el /tmp/elc`"
174 bogosities=
175 for file in $losers; do
176 file1=`echo $file | sed -e "s|.*/||"`
177 if ! grep -q "dontcompilefiles:.* $file1\($\| \)" lisp/Makefile; then
178 case $file in
179 site-init.el | site-load.el | site-start.el | default.el)
181 term/*)
184 bogosities="$file $bogosities"
186 esac
188 done
189 if [ x"${bogosities}" != x"" ]; then
190 echo "The following .el files have no corresponding .elc files:"
191 echo "${bogosities}"
193 rm -f /tmp/el /tmp/elc
195 ### Check for .el files that would overflow the 14-char limit if compiled.
196 long=`find lisp leim -name '[a-zA-Z0-9]??????????*.el' -print`
197 if [ "$long" != "" ]; then
198 echo "The following .el file names are too long:"
199 echo "$long"
203 ### Make sure configure is newer than configure.in.
204 if [ "x`ls -t configure configure.in | head -1`" != "xconfigure" ]; then
205 echo "\`./configure.in' is newer than \`./configure'" >&2
206 echo "Running autoconf" >&2
207 autoconf || { x=$?; echo Autoconf FAILED! >&2; exit $x; }
210 if [ $update = yes ];
211 then
212 echo "Updating Info files"
214 (cd man; make -f Makefile.in srcdir=. info)
216 echo "Updating finder, custom and autoload data"
218 (cd lisp; make updates EMACS=$EMACS)
220 echo "Updating leim-list.el"
222 (cd leim; make leim-list.el EMACS=$EMACS)
224 echo "Recompiling Lisp files"
226 $EMACS -batch -f batch-byte-recompile-directory lisp leim
229 echo "Making lisp/MANIFEST"
231 (cd lisp;
232 files=`echo [!=]*.el | sed -e 's/ subdirs.el / /' -e 's/ default.el / /'`
233 for dir in [!=]*; do
234 if [ -d $dir ] && [ $dir != term ] && [ $dir != RCS ]; then
235 echo $dir
236 thisdir=`echo $dir/[!=]*.el | sed -e 's/ subdirs.el / /'`
237 files="$files $thisdir"
239 done
240 head -1 $files | grep '^;' | sed -e 's/;;; //' | sort > MANIFEST)
242 echo "Creating staging directory: \`${tempparent}'"
244 mkdir ${tempparent}
245 tempdir="${tempparent}/${emacsname}"
247 ### This trap ensures that the staging directory will be cleaned up even
248 ### when the script is interrupted in mid-career.
249 if [ "${clean_up}" = yes ]; then
250 trap "echo 'Interrupted...cleaning up the staging directory'; rm -rf ${tempparent}; exit 1" 1 2 15
253 echo "Creating top directory: \`${tempdir}'"
254 mkdir ${tempdir}
256 ### We copy in the top-level files before creating the subdirectories in
257 ### hopes that this will make the top-level files appear first in the
258 ### tar file; this means that people can start reading the INSTALL and
259 ### README while the rest of the tar file is still unpacking. Whoopee.
260 echo "Making links to top-level files"
261 ln GETTING.GNU.SOFTWARE INSTALL README BUGS move-if-change ${tempdir}
262 ln ChangeLog Makefile.in configure configure.in ${tempdir}
263 ln config.bat make-dist update-subdirs vpath.sed ${tempdir}
264 ### Copy these files; they're cross-filesystem symlinks.
265 cp mkinstalldirs ${tempdir}
266 cp config.sub ${tempdir}
267 cp config.guess ${tempdir}
268 cp install.sh ${tempdir}
270 echo "Updating version number in README"
271 (cd ${tempdir}
272 awk \
273 '$1 " " $2 " " $3 " " $4 " " $5 == "This directory tree holds version" { $6 = version; print $0 }
274 $1 " " $2 " " $3 " " $4 " " $5 != "This directory tree holds version"' \
275 version=${version} README > tmp.README
276 mv -f tmp.README README)
279 echo "Creating subdirectories"
280 for subdir in lisp site-lisp leim real-leim real-leim/CXTERM-DIC \
281 real-leim/SKK-DIC real-leim/skk real-leim/quail \
282 src src/m src/s src/bitmaps lib-src oldXMenu lwlib \
283 nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
284 etc etc/e lock info man msdos vms; do
285 mkdir ${tempdir}/${subdir}
286 done
288 echo "Initializing \`leim' subdirectory"
289 cp leim-Makefile.in ${tempdir}/leim/Makefile.in
291 echo "Making links to \`lisp' and its subdirectories"
292 ### Don't distribute TAGS, =*.el files, site-init.el, site-load.el, or default.el.
293 (cd lisp
294 ln [a-zA-Z]*.el ../${tempdir}/lisp
295 ln [a-zA-Z]*.elc ../${tempdir}/lisp
296 ln [a-zA-Z]*.dat ../${tempdir}/lisp
297 ## simula.el doesn't keep abbreviations in simula.defns any more.
298 ## ln [a-zA-Z]*.defns ../${tempdir}/lisp
299 ln ChangeLog Makefile makefile.nt ChangeLog.? README ../${tempdir}/lisp
300 (cd ../${tempdir}/lisp
301 rm -f TAGS =*
302 rm -f site-init site-init.el site-init.elc
303 rm -f site-load site-load.el site-load.elc
304 rm -f site-start site-start.el site-start.elc
305 rm -f default default.el default.elc
308 ## Find all subdirs of lisp dir
309 for file in `find . -type d -print`; do
310 case $file in
311 . | .. | */Old | */RCS | */=*)
314 if [ -d $file ]; then
315 subdirs="$file $subdirs"
318 esac
319 done
321 for file in $subdirs; do
322 echo " lisp/$file"
323 mkdir ../${tempdir}/lisp/$file
324 ln $file/[a-zA-Z]*.el ../${tempdir}/lisp/$file
325 ln $file/[a-zA-Z]*.elc ../${tempdir}/lisp/$file
326 if [ -f $file/README ]; then
327 ln $file/README ../${tempdir}/lisp/$file
329 done )
331 echo "Making links to \`leim' and its subdirectories for the LEIM distribution"
332 ### Don't distribute TAGS, or =*.el files.
333 (cd leim
334 ln Makefile.in makefile.nt ../${tempdir}/real-leim
335 ln ChangeLog README ../${tempdir}/real-leim
337 ln CXTERM-DIC/*.tit ../${tempdir}/real-leim/CXTERM-DIC
338 ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/real-leim/SKK-DIC
339 ln skk/*.el skk/*.elc ../${tempdir}/real-leim/skk
340 ln quail/*.el quail/*.elc ../${tempdir}/real-leim/quail
342 cd ../${tempdir}/real-leim
343 rm -f TAGS =* */=*)
345 ### Move the real-leim directory outside of Emacs proper.
346 (cd ${tempparent}
347 mkdir ${emacsname}-leim
348 mkdir ${emacsname}-leim/${emacsname}
349 mv ${emacsname}/real-leim ${emacsname}-leim/${emacsname}/leim)
351 echo "Making links to \`src'"
352 ### Don't distribute =*.[ch] files, or the configured versions of
353 ### config.in, paths.in, or Makefile.in, or TAGS.
354 (cd src
355 echo " (It is ok if ln fails in some cases.)"
356 ln [a-zA-Z]*.c ../${tempdir}/src
357 ln [a-zA-Z]*.h ../${tempdir}/src
358 ln [a-zA-Z]*.s ../${tempdir}/src
359 ln [a-zA-Z]*.in ../${tempdir}/src
360 ln [a-zA-Z]*.opt ../${tempdir}/src
361 ## If we ended up with a symlink, or if we did not get anything
362 ## due to a cross-device symlink, copy the file.
363 for file in [a-zA-Z]*.[hcs] [a-zA-Z]*.in [a-zA-Z]*.opt; do
364 if test -f ../${tempdir}/src/$file; then
365 # test -f appears to succeed for a symlink
366 if test -L ../${tempdir}/src/$file; then
367 rm ../${tempdir}/src/$file
368 cp -p $file ../${tempdir}/src
369 chmod a-w ../${tempdir}/src/$file
371 else
372 rm ../${tempdir}/src/$file
373 cp -p $file ../${tempdir}/src
374 chmod a-w ../${tempdir}/src/$file
376 done
377 ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
378 ln makefile.nt vms-pp.trans ../${tempdir}/src
379 ln .gdbinit .dbxinit ../${tempdir}/src
380 cd ../${tempdir}/src
381 rm -f config.h paths.h Makefile Makefile.c
382 rm -f =* TAGS)
384 echo "Making links to \`src/bitmaps'"
385 (cd src/bitmaps
386 ln README *.xbm ../../${tempdir}/src/bitmaps)
388 echo "Making links to \`src/m'"
389 (cd src/m
390 # We call files for miscellaneous input (to linker etc) .inp.
391 ln README [a-zA-Z0-9]*.h *.inp ../../${tempdir}/src/m)
393 echo "Making links to \`src/s'"
394 (cd src/s
395 ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/s)
397 echo "Making links to \`lib-src'"
398 (cd lib-src
399 ln [a-zA-Z]*.[chy] ../${tempdir}/lib-src
400 ln ChangeLog Makefile.in README testfile vcdiff ../${tempdir}/lib-src
401 ln emacs.csh rcs2log rcs-checkin makefile.nt ../${tempdir}/lib-src
402 ## If we ended up with a symlink, or if we did not get anything
403 ## due to a cross-device symlink, copy the file.
404 for file in [a-zA-Z]*.[chy]; do
405 if test -f ../${tempdir}/lib-src/$file; then
406 # test -f appears to succeed for a symlink
407 if test -L ../${tempdir}/lib-src/$file; then
408 rm ../${tempdir}/lib-src/$file
409 cp $file ../${tempdir}/lib-src
410 chmod a-w ../${tempdir}/lib-src/$file
412 else
413 rm ../${tempdir}/lib-src/$file
414 cp $file ../${tempdir}/lib-src
415 chmod a-w ../${tempdir}/lib-src/$file
417 done
418 cd ../${tempdir}/lib-src
419 rm -f Makefile.c
420 rm -f =* TAGS)
422 echo "Making links to \`nt'"
423 (cd nt
424 ln emacs.ico emacs.rc config.nt [a-z]*.in [a-z]*.c ../${tempdir}/nt
425 ln [a-z]*.bat [a-z]*.h makefile.def makefile.nt ../${tempdir}/nt
426 ln TODO ChangeLog INSTALL README ../${tempdir}/nt)
428 echo "Making links to \`nt/inc'"
429 (cd nt/inc
430 ln [a-z]*.h ../../${tempdir}/nt/inc)
432 echo "Making links to \`nt/inc/sys'"
433 (cd nt/inc/sys
434 ln [a-z]*.h ../../../${tempdir}/nt/inc/sys)
436 echo "Making links to \`nt/inc/arpa'"
437 (cd nt/inc/arpa
438 ln [a-z]*.h ../../../${tempdir}/nt/inc/arpa)
440 echo "Making links to \`nt/inc/netinet'"
441 (cd nt/inc/netinet
442 ln [a-z]*.h ../../../${tempdir}/nt/inc/netinet)
444 echo "Making links to \`nt/icons'"
445 (cd nt/icons
446 ln [a-z]*.ico ../../${tempdir}/nt/icons)
448 echo "Making links to \`msdos'"
449 (cd msdos
450 ln ChangeLog emacs.ico emacs.pif ../${tempdir}/msdos
451 ln is_exec.c sigaction.c mainmake mainmake.v2 sed*.inp ../${tempdir}/msdos
452 cd ../${tempdir}/msdos
453 rm -f =*)
455 echo "Making links to \`oldXMenu'"
456 (cd oldXMenu
457 ln *.c *.h *.in ../${tempdir}/oldXMenu
458 ln README Imakefile ChangeLog ../${tempdir}/oldXMenu
459 ln compile.com descrip.mms ../${tempdir}/oldXMenu)
461 echo "Making links to \`lwlib'"
462 (cd lwlib
463 ln *.c *.h *.in ../${tempdir}/lwlib
464 ln README Imakefile ChangeLog ../${tempdir}/lwlib
465 cd ../${tempdir}/lwlib
466 rm -f lwlib-Xol*)
468 echo "Making links to \`etc'"
469 ### Don't distribute = files, TAGS, DOC files, backups, autosaves, or
470 ### tex litter.
471 (cd etc
472 files=`ls -d * | grep -v 'RCS' | grep -v 'Old' | grep -v '^e$'`
473 ln $files ../${tempdir}/etc
474 ## If we ended up with a symlink, or if we did not get anything
475 ## due to a cross-device symlink, copy the file.
476 for file in $files; do
477 if test -f ../${tempdir}/etc/$file; then
478 # test -f appears to succeed for a symlink
479 if test -L ../${tempdir}/etc/$file; then
480 rm ../${tempdir}/etc/$file
481 cp $file ../${tempdir}/etc
482 chmod a-w ../${tempdir}/etc/$file
484 else
485 rm ../${tempdir}/etc/$file
486 cp $file ../${tempdir}/etc
487 chmod a-w ../${tempdir}/etc/$file
489 done
490 cd ../${tempdir}/etc
491 rm -f fns*.el
492 rm -f DOC* *~ \#*\# *.dvi *.log *.orig *.rej *,v =* core
493 rm -f TAGS)
495 echo "Making links to \`etc/e'"
496 (cd etc/e
497 ln `ls -d * | grep -v 'RCS'` ../../${tempdir}/etc/e
498 cd ../../${tempdir}/etc/e
499 rm -f *~ \#*\# *,v =* core)
501 echo "Making links to \`info'"
502 # Don't distribute backups or autosaves.
503 (cd info
504 ln [a-zA-Z]* ../${tempdir}/info
505 cd ../${tempdir}/info
506 # Avoid an error when expanding the wildcards later.
507 ln emacs dummy~ ; ln emacs \#dummy\#
508 rm -f *~ \#*\# core)
510 echo "Making links to \`man'"
511 (cd man
512 ln *.texi *.aux *.cps *.fns *.kys *.vrs ../${tempdir}/man
513 test -f README && ln README ../${tempdir}/man
514 test -f Makefile.in && ln Makefile.in ../${tempdir}/man
515 ln ChangeLog split-man ../${tempdir}/man
516 cp texinfo.tex ../${tempdir}/man
517 cd ../${tempdir}/man
518 rm -f \#*\# =* *~ core emacs-index* *.Z *.z xmail
519 rm -f emacs.?? termcap.?? gdb.?? *.log *.toc *.dvi *.oaux)
521 echo "Making links to \`vms'"
522 (cd vms
523 ln [0-9a-zA-Z]* ../${tempdir}/vms
524 cd ../${tempdir}/vms
525 rm -f *~)
527 ### It would be nice if they could all be symlinks to etc's copy, but
528 ### you're not supposed to have any symlinks in distribution tar files.
529 echo "Making sure copying notices are all copies of \`etc/COPYING'"
530 rm -f ${tempdir}/etc/COPYING
531 cp etc/COPYING ${tempdir}/etc/COPYING
532 for subdir in lisp src lib-src info msdos; do
533 if [ -f ${tempdir}/${subdir}/COPYING ]; then
534 rm ${tempdir}/${subdir}/COPYING
536 cp etc/COPYING ${tempdir}/${subdir}
537 done
539 #### Make sure that there aren't any hard links between files in the
540 #### distribution; people with afs can't deal with that. Okay,
541 #### actually we just re-copy anything with a link count greater
542 #### than two. (Yes, strictly greater than 2 is correct; since we
543 #### created these files by linking them in from the original tree,
544 #### they'll have exactly two links normally.)
545 ####
546 #### Commented out since it's not strictly necessary; it should suffice
547 #### to just break the link on alloca.c.
548 #echo "Breaking intra-tree links."
549 #find ${tempdir} ! -type d -links +2 \
550 # -exec cp -p {} $$ \; -exec rm -f {} \; -exec mv $$ {} \;
551 rm -f $tempdir/lib-src/alloca.c
552 cp $tempdir/src/alloca.c $tempdir/lib-src/alloca.c
554 if [ "${newer}" ]; then
555 echo "Removing files older than $newer"
556 ## We remove .elc files unconditionally, on the theory that anyone picking
557 ## up an incremental distribution already has a running Emacs to byte-compile
558 ## them with.
559 find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
562 if [ "${make_tar}" = yes ]; then
563 if [ "${default_gzip}" = "" ]; then
564 echo "Looking for gzip"
565 temppath=`echo $PATH | sed 's/^:/.:/
566 s/::/:.:/g
567 s/:$/:./
568 s/:/ /g'`
569 default_gzip=`(
570 for dir in ${temppath}; do
571 if [ -f ${dir}/gzip ]; then echo 'gzip --best'; exit 0; fi
572 done
573 echo compress
576 case "${default_gzip}" in
577 compress* ) gzip_extension=.Z ;;
578 * ) gzip_extension=.gz ;;
579 esac
580 echo "Creating tar files"
581 (cd ${tempparent} ; tar cvf - ${emacsname} ) \
582 | ${default_gzip} \
583 > ${emacsname}.tar${gzip_extension}
584 (cd ${tempparent}/${emacsname}-leim ; tar cvf - ${emacsname} ) \
585 | ${default_gzip} \
586 > ${emacsname}-leim.tar${gzip_extension}
589 if [ "${clean_up}" = yes ]; then
590 echo "Cleaning up the staging directory"
591 rm -rf ${tempparent}
592 else
593 (cd ${tempparent}; mv ${emacsname} ${emacsname}-leim ..)
594 rm -rf ${tempparent}
597 ### make-dist ends here