Comment change.
[emacs.git] / make-dist
blobe4df2f06e48ae04a399a701bd36a86044caba83e
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 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 protect any files.
37 umask 0
39 update=yes
40 clean_up=no
41 make_tar=no
42 newer=""
44 while [ $# -gt 0 ]; do
45 case "$1" in
46 ## This option tells make-dist to delete the staging directory
47 ## when done. It is useless to use this unless you make a tar file.
48 "--clean-up" )
49 clean_up=yes
51 ## This option tells make-dist to make a tar file.
52 "--tar" )
53 make_tar=yes
55 ## This option tells make-dist not to recompile or do analogous things.
56 "--no-update" )
57 update=no
59 ## This option tells make-dist to make the distribution normally, then
60 ## remove all files older than the given timestamp file. This is useful
61 ## for creating incremental or patch distributions.
62 "--newer")
63 newer="$2"
64 new_extension=".new"
65 shift
67 ## This option tells make-dist to use `compress' instead of gzip.
68 ## Normally, make-dist uses gzip whenever it is present.
69 "--compress")
70 default_gzip="compress"
72 * )
73 echo "${progname}: Unrecognized argument: $1" >&2
74 exit 1
76 esac
77 shift
78 done
80 ### Make sure we're running in the right place.
81 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/version.el ]; then
82 echo "${progname}: Can't find \`src/lisp.h' and \`lisp/version.el'." >&2
83 echo "${progname} must be run in the top directory of the Emacs" >&2
84 echo "distribution tree. cd to that directory and try again." >&2
85 exit 1
88 ### Find where to run Emacs.
89 if [ $update = yes ];
90 then
91 if [ -f src/emacs ];
92 then
93 EMACS=`pwd`/src/emacs
94 else
95 if [ x$EMACS = x ];
96 then
97 echo You must specify the EMACS environment variable 2>&1
98 exit 1
103 ### Find out which version of Emacs this is.
104 shortversion=`grep 'defconst[ ]*emacs-version' lisp/version.el \
105 | sed -e 's/^.*"\([0-9][0-9]*\.[0-9][0-9]*\).*$/\1/'`
106 version=`grep 'defconst[ ]*emacs-version' lisp/version.el \
107 | sed -e 's/^[^"]*"\([^"]*\)".*$/\1/'`
108 if [ ! "${version}" ]; then
109 echo "${progname}: can't find current Emacs version in \`./lisp/version.el'" >&2
110 exit 1
113 echo Version numbers are $version and $shortversion
115 if [ $update = yes ];
116 then
117 if grep -s "GNU Emacs version ${shortversion}" ./man/emacs.texi > /dev/null; then
118 true
119 else
120 echo "You must update the version number in \`./man/emacs.texi'"
121 sleep 5
125 ### Make sure we don't already have a directory emacs-${version}.
127 emacsname="emacs-${version}${new_extension}"
129 if [ -d ${emacsname} ]
130 then
131 echo Directory "${emacsname}" already exists >&2
132 exit 1
135 ### Make sure the subdirectory is available.
136 tempparent="make-dist.tmp.$$"
137 if [ -d ${tempparent} ]; then
138 echo "${progname}: staging directory \`${tempparent}' already exists.
139 Perhaps a previous invocation of \`${progname}' failed to clean up after
140 itself. Check that directories whose names are of the form
141 \`make-dist.tmp.NNNNN' don't contain any important information, remove
142 them, and try again." >&2
143 exit 1
146 ### Check for .elc files with no corresponding .el file.
147 ls -1 lisp/[a-z]*.el lisp/[a-z]*/[a-z]*.el | sed 's/\.el$/.elc/' > /tmp/el
148 ls -1 lisp/[a-z]*.elc lisp/[a-z]*/[a-z]*.elc > /tmp/elc
149 bogosities="`comm -13 /tmp/el /tmp/elc`"
150 if [ "${bogosities}" != "" ]; then
151 echo "The following .elc files have no corresponding .el files:"
152 echo "${bogosities}"
154 rm -f /tmp/el /tmp/elc
156 ### Check for .el files with no corresponding .elc file.
157 (cd lisp; ls -1 [a-z]*.el [a-z]*/[a-z]*.el) > /tmp/el
158 (cd lisp; ls -1 [a-z]*.elc [a-z]*/[a-z]*.elc) | sed 's/\.elc$/.el/' > /tmp/elc
159 losers="`comm -23 /tmp/el /tmp/elc`"
160 bogosities=
161 for file in $losers; do
162 file1=`echo $file | sed -e "s|.*/||"`
163 if ! grep -q "dontcompilefiles:.* $file1\($\| \)" lisp/Makefile; then
164 case $file in
165 site-init.el | site-load.el | site-start.el | default.el)
167 term/*)
170 bogosities="$file $bogosities"
172 esac
174 done
175 if [ x"${bogosities}" != x"" ]; then
176 echo "The following .el files have no corresponding .elc files:"
177 echo "${bogosities}"
179 rm -f /tmp/el /tmp/elc
181 ### Check for .el files that would overflow the 14-char limit if compiled.
182 long=`find lisp -name '[a-zA-Z0-9]??????????*.el' -print`
183 if [ "$long" != "" ]; then
184 echo "The following .el file names are too long:"
185 echo "$long"
188 ### Make sure configure is newer than configure.in.
189 if [ "x`ls -t configure configure.in | head -1`" != "xconfigure" ]; then
190 echo "\`./configure.in' is newer than \`./configure'" >&2
191 echo "Running autoconf" >&2
192 autoconf || { x=$?; echo Autoconf FAILED! >&2; exit $x; }
195 if [ $update = yes ];
196 then
197 echo "Updating Info files"
199 (cd man; make info)
201 echo "Recompiling Lisp files"
203 $EMACS -batch -f batch-byte-recompile-directory lisp
205 echo "Updating finder, custom and autoload data"
207 (cd lisp; make updates)
210 echo "Making lisp/MANIFEST"
212 (cd lisp; head -1 [!=]*.el | grep '^;' | sed -e 's/;;; //' > MANIFEST)
214 echo "Creating staging directory: \`${tempparent}'"
216 mkdir ${tempparent}
217 tempdir="${tempparent}/${emacsname}"
219 ### This trap ensures that the staging directory will be cleaned up even
220 ### when the script is interrupted in mid-career.
221 if [ "${clean_up}" = yes ]; then
222 trap "echo 'Interrupted...cleaning up the staging directory'; rm -rf ${tempparent}; exit 1" 1 2 15
225 echo "Creating top directory: \`${tempdir}'"
226 mkdir ${tempdir}
228 ### We copy in the top-level files before creating the subdirectories in
229 ### hopes that this will make the top-level files appear first in the
230 ### tar file; this means that people can start reading the INSTALL and
231 ### README while the rest of the tar file is still unpacking. Whoopee.
232 echo "Making links to top-level files"
233 ln GETTING.GNU.SOFTWARE INSTALL PROBLEMS README BUGS move-if-change ${tempdir}
234 ln ChangeLog Makefile.in configure configure.in ${tempdir}
235 ln config.bat make-dist update-subdirs vpath.sed ${tempdir}
236 ### Copy these files; they're cross-filesystem symlinks.
237 cp mkinstalldirs ${tempdir}
238 cp config.sub ${tempdir}
239 cp config.guess ${tempdir}
240 cp install.sh ${tempdir}
242 echo "Updating version number in README"
243 (cd ${tempdir}
244 awk \
245 '$1 " " $2 " " $3 " " $4 " " $5 == "This directory tree holds version" { $6 = version; print $0 }
246 $1 " " $2 " " $3 " " $4 " " $5 != "This directory tree holds version"' \
247 version=${version} README > tmp.README
248 mv tmp.README README)
251 echo "Creating subdirectories"
252 for subdir in lisp site-lisp leim real-leim real-leim/CXTERM-DIC \
253 real-leim/SKK real-leim/skk real-leim/quail \
254 src src/m src/s src/bitmaps lib-src oldXMenu lwlib \
255 nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet \
256 etc etc/e lock cpp info man msdos vms; do
257 mkdir ${tempdir}/${subdir}
258 done
260 echo "Initializing \`leim' subdirectory"
261 cp leim-Makefile.in ${tempdir}/leim/Makefile.in
263 echo "Making links to \`lisp' and its subdirectories"
264 ### Don't distribute TAGS, =*.el files, site-init.el, site-load.el, or default.el.
265 (cd lisp
266 ln [a-zA-Z]*.el ../${tempdir}/lisp
267 ln [a-zA-Z]*.elc ../${tempdir}/lisp
268 ln [a-zA-Z]*.dat ../${tempdir}/lisp
269 ## simula.el doesn't keep abbreviations in simula.defns any more.
270 ## ln [a-zA-Z]*.defns ../${tempdir}/lisp
271 ln ChangeLog Makefile makefile.nt ChangeLog.? README ../${tempdir}/lisp
272 (cd ../${tempdir}/lisp
273 rm -f TAGS =*
274 rm -f site-init site-init.el site-init.elc
275 rm -f site-load site-load.el site-load.elc
276 rm -f site-start site-start.el site-start.elc
277 rm -f default default.el default.elc
280 ## Find all subdirs of lisp dir
281 for file in `find . -type d -print`; do
282 case $file in
283 . | .. | */Old | */RCS | */=*)
286 if [ -d $file ]; then
287 subdirs="$file $subdirs"
290 esac
291 done
293 for file in $subdirs; do
294 echo " lisp/$file"
295 mkdir ../${tempdir}/lisp/$file
296 ln $file/[a-zA-Z]*.el ../${tempdir}/lisp/$file
297 ln $file/[a-zA-Z]*.elc ../${tempdir}/lisp/$file
298 if [ -f $file/README ]; then
299 ln $file/README ../${tempdir}/lisp/$file
301 done )
303 echo "Making links to \`leim' and its subdirectories for the LEIM distribution"
304 ### Don't distribute TAGS, or =*.el files.
305 (cd leim
306 ln Makefile.in makefile.nt ../${tempdir}/real-leim
307 ln ChangeLog.? README ../${tempdir}/real-leim
309 ln CXTERM-DIC/*.tit ../${tempdir}/real-leim/CXTERM-DIC
310 ln SKK/README SKK/SKK-JISYO.L ../${tempdir}/real-leim/SKK
311 ln skk/*.el skk/*.elc ../${tempdir}/real-leim/skk
312 ln quail/*.el quail/*.elc ../${tempdir}/real-leim/quail
314 cd ../${tempdir}/real-leim
315 rm -f TAGS =* */=*)
317 ### Move the real-leim directory outside of Emacs proper.
318 (cd ${tempparent}
319 mkdir ${emacsname}-leim
320 mkdir ${emacsname}-leim/${emacsname}
321 mv ${emacsname}/real-leim ${emacsname}-leim/${emacsname}/leim)
323 echo "Making links to \`src'"
324 ### Don't distribute =*.[ch] files, or the configured versions of
325 ### config.in, paths.in, or Makefile.in, or TAGS.
326 (cd src
327 echo " (It is ok if ln fails in some cases.)"
328 ln [a-zA-Z]*.c ../${tempdir}/src
329 ln [a-zA-Z]*.h ../${tempdir}/src
330 ln [a-zA-Z]*.s ../${tempdir}/src
331 ln [a-zA-Z]*.in ../${tempdir}/src
332 ln [a-zA-Z]*.opt ../${tempdir}/src
333 ## If we ended up with a symlink, or if we did not get anything
334 ## due to a cross-device symlink, copy the file.
335 for file in [a-zA-Z]*.[hcs] [a-zA-Z]*.in [a-zA-Z]*.opt; do
336 if test -f ../${tempdir}/src/$file; then
337 # test -f appears to succeed for a symlink
338 if test -L ../${tempdir}/src/$file; then
339 rm ../${tempdir}/src/$file
340 cp $file ../${tempdir}/src
341 chmod a-w ../${tempdir}/src/$file
343 else
344 rm ../${tempdir}/src/$file
345 cp $file ../${tempdir}/src
346 chmod a-w ../${tempdir}/src/$file
348 done
349 ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
350 ln makefile.nt vms-pp.trans ../${tempdir}/src
351 ln .gdbinit .dbxinit ../${tempdir}/src
352 cd ../${tempdir}/src
353 rm -f config.h paths.h Makefile Makefile.c
354 rm -f =* TAGS)
356 echo "Making links to \`src/bitmaps'"
357 (cd src/bitmaps
358 ln README *.xbm ../../${tempdir}/src/bitmaps)
360 echo "Making links to \`src/m'"
361 (cd src/m
362 # We call files for miscellaneous input (to linker etc) .inp.
363 ln README [a-zA-Z0-9]*.h *.inp ../../${tempdir}/src/m)
365 echo "Making links to \`src/s'"
366 (cd src/s
367 ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/s)
369 echo "Making links to \`lib-src'"
370 (cd lib-src
371 ln [a-zA-Z]*.[chy] ../${tempdir}/lib-src
372 ln ChangeLog Makefile.in README testfile vcdiff ../${tempdir}/lib-src
373 ln emacs.csh rcs2log rcs-checkin makefile.nt ../${tempdir}/lib-src
374 ## If we ended up with a symlink, or if we did not get anything
375 ## due to a cross-device symlink, copy the file.
376 for file in [a-zA-Z]*.[chy]; do
377 if test -f ../${tempdir}/lib-src/$file; then
378 # test -f appears to succeed for a symlink
379 if test -L ../${tempdir}/lib-src/$file; then
380 rm ../${tempdir}/lib-src/$file
381 cp $file ../${tempdir}/lib-src
382 chmod a-w ../${tempdir}/lib-src/$file
384 else
385 rm ../${tempdir}/lib-src/$file
386 cp $file ../${tempdir}/lib-src
387 chmod a-w ../${tempdir}/lib-src/$file
389 done
390 cd ../${tempdir}/lib-src
391 rm -f Makefile.c
392 rm -f =* TAGS)
394 echo "Making links to \`nt'"
395 (cd nt
396 ln emacs.ico emacs.rc config.nt [a-z]*.in [a-z]*.c ../${tempdir}/nt
397 ln [a-z]*.bat [a-z]*.h makefile.def makefile.nt ../${tempdir}/nt
398 ln TODO ChangeLog INSTALL README ../${tempdir}/nt)
400 echo "Making links to \`nt/inc'"
401 (cd nt/inc
402 ln [a-z]*.h ../../${tempdir}/nt/inc)
404 echo "Making links to \`nt/inc/sys'"
405 (cd nt/inc/sys
406 ln [a-z]*.h ../../../${tempdir}/nt/inc/sys)
408 echo "Making links to \`nt/inc/arpa'"
409 (cd nt/inc/arpa
410 ln [a-z]*.h ../../../${tempdir}/nt/inc/arpa)
412 echo "Making links to \`nt/inc/netinet'"
413 (cd nt/inc/netinet
414 ln [a-z]*.h ../../../${tempdir}/nt/inc/netinet)
416 echo "Making links to \`msdos'"
417 (cd msdos
418 ln ChangeLog emacs.ico emacs.pif ../${tempdir}/msdos
419 ln is_exec.c sigaction.c mainmake mainmake.v2 sed*.inp ../${tempdir}/msdos
420 cd ../${tempdir}/msdos
421 rm -f =*)
423 echo "Making links to \`oldXMenu'"
424 (cd oldXMenu
425 ln *.c *.h *.in ../${tempdir}/oldXMenu
426 ln README Imakefile ChangeLog ../${tempdir}/oldXMenu
427 ln compile.com descrip.mms ../${tempdir}/oldXMenu)
429 echo "Making links to \`lwlib'"
430 (cd lwlib
431 ln *.c *.h *.in ../${tempdir}/lwlib
432 ln README Imakefile ChangeLog ../${tempdir}/lwlib
433 cd ../${tempdir}/lwlib
434 rm -f lwlib-Xol*)
436 echo "Making links to \`etc'"
437 ### Don't distribute = files, TAGS, DOC files, backups, autosaves, or
438 ### tex litter.
439 (cd etc
440 files=`ls -d * | grep -v 'RCS' | grep -v 'Old' | grep -v '^e$'`
441 ln $files ../${tempdir}/etc
442 ## If we ended up with a symlink, or if we did not get anything
443 ## due to a cross-device symlink, copy the file.
444 for file in $files; do
445 if test -f ../${tempdir}/etc/$file; then
446 # test -f appears to succeed for a symlink
447 if test -L ../${tempdir}/etc/$file; then
448 rm ../${tempdir}/etc/$file
449 cp $file ../${tempdir}/etc
450 chmod a-w ../${tempdir}/etc/$file
452 else
453 rm ../${tempdir}/etc/$file
454 cp $file ../${tempdir}/etc
455 chmod a-w ../${tempdir}/etc/$file
457 done
458 cd ../${tempdir}/etc
459 rm -f DOC* *~ \#*\# *.dvi *.log *.orig *.rej *,v =* core
460 rm -f TAGS)
462 echo "Making links to \`etc/e'"
463 (cd etc/e
464 ln `ls -d * | grep -v 'RCS'` ../../${tempdir}/etc/e
465 cd ../../${tempdir}/etc/e
466 rm -f *~ \#*\# *,v =* core)
468 echo "Making links to \`cpp'"
469 (cd cpp
470 ln cccp.c cexp.y Makefile README ../${tempdir}/cpp)
472 echo "Making links to \`info'"
473 # Don't distribute backups or autosaves.
474 (cd info
475 ln [a-zA-Z]* ../${tempdir}/info
476 cd ../${tempdir}/info
477 # Avoid an error when expanding the wildcards later.
478 ln emacs dummy~ ; ln emacs \#dummy\#
479 rm -f *~ \#*\# core)
481 echo "Making links to \`man'"
482 (cd man
483 ln *.texi *.aux *.cps *.fns *.kys *.vrs ../${tempdir}/man
484 test -f README && ln README ../${tempdir}/man
485 test -f Makefile.in && ln Makefile.in ../${tempdir}/man
486 ln ChangeLog split-man ../${tempdir}/man
487 cp texinfo.tex ../${tempdir}/man
488 cd ../${tempdir}/man
489 rm -f \#*\# =* *~ core emacs-index* *.Z *.z xmail
490 rm -f emacs.?? termcap.?? gdb.?? *.log *.toc *.dvi *.oaux)
492 echo "Making links to \`vms'"
493 (cd vms
494 ln [0-9a-zA-Z]* ../${tempdir}/vms
495 cd ../${tempdir}/vms
496 rm -f *~)
498 ### It would be nice if they could all be symlinks to etc's copy, but
499 ### you're not supposed to have any symlinks in distribution tar files.
500 echo "Making sure copying notices are all copies of \`etc/COPYING'"
501 rm -f ${tempdir}/etc/COPYING
502 cp etc/COPYING ${tempdir}/etc/COPYING
503 for subdir in lisp src lib-src info msdos; do
504 if [ -f ${tempdir}/${subdir}/COPYING ]; then
505 rm ${tempdir}/${subdir}/COPYING
507 cp etc/COPYING ${tempdir}/${subdir}
508 done
510 #### Make sure that there aren't any hard links between files in the
511 #### distribution; people with afs can't deal with that. Okay,
512 #### actually we just re-copy anything with a link count greater
513 #### than two. (Yes, strictly greater than 2 is correct; since we
514 #### created these files by linking them in from the original tree,
515 #### they'll have exactly two links normally.)
516 ####
517 #### Commented out since it's not strictly necessary; it should suffice
518 #### to just break the link on alloca.c.
519 #echo "Breaking intra-tree links."
520 #find ${tempdir} ! -type d -links +2 \
521 # -exec cp -p {} $$ \; -exec rm -f {} \; -exec mv $$ {} \;
522 rm -f $tempdir/lib-src/alloca.c
523 cp $tempdir/src/alloca.c $tempdir/lib-src/alloca.c
525 if [ "${newer}" ]; then
526 echo "Removing files older than $newer"
527 ## We remove .elc files unconditionally, on the theory that anyone picking
528 ## up an incremental distribution already has a running Emacs to byte-compile
529 ## them with.
530 find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
533 if [ "${make_tar}" = yes ]; then
534 if [ "${default_gzip}" = "" ]; then
535 echo "Looking for gzip"
536 temppath=`echo $PATH | sed 's/^:/.:/
537 s/::/:.:/g
538 s/:$/:./
539 s/:/ /g'`
540 default_gzip=`(
541 for dir in ${temppath}; do
542 if [ -f ${dir}/gzip ]; then echo 'gzip --best'; exit 0; fi
543 done
544 echo compress
547 case "${default_gzip}" in
548 compress* ) gzip_extension=.Z ;;
549 * ) gzip_extension=.gz ;;
550 esac
551 echo "Creating tar files"
552 (cd ${tempparent} ; tar cvf - ${emacsname} ) \
553 | ${default_gzip} \
554 > ${emacsname}.tar${gzip_extension}
555 (cd ${tempparent}/${emacsname}-leim ; tar cvf - ${emacsname} ) \
556 | ${default_gzip} \
557 > ${emacsname}-leim.tar${gzip_extension}
560 if [ "${clean_up}" = yes ]; then
561 echo "Cleaning up the staging directory"
562 rm -rf ${tempparent}
563 else
564 (cd ${tempparent}; mv ${emacsname} ${emacsname}-leim ..)
565 rm -rf ${tempparent}
568 ### make-dist ends here