(bogosities): Check subdirs of `lisp' also.
[bpt/emacs.git] / make-dist
1 #!/bin/sh
2
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.
8
9 # Copyright (C) 1995, 1997 Free Software Foundation, Inc.
10 #
11 # This file is part of GNU Emacs.
12 #
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.
17 #
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.
22 #
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.
27
28 progname="$0"
29
30 ### Exit if a command fails.
31 ### set -e
32
33 ### Print out each line we read, for debugging's sake.
34 ### set -v
35
36 ## Don't protect any files.
37 umask 0
38
39 update=yes
40 clean_up=no
41 make_tar=no
42 newer=""
43
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
50 ;;
51 ## This option tells make-dist to make a tar file.
52 "--tar" )
53 make_tar=yes
54 ;;
55 ## This option tells make-dist not to recompile or do analogous things.
56 "--no-update" )
57 update=no
58 ;;
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
66 ;;
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"
71 ;;
72 * )
73 echo "${progname}: Unrecognized argument: $1" >&2
74 exit 1
75 ;;
76 esac
77 shift
78 done
79
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
86 fi
87
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
99 fi
100 fi
101 fi
102
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
111 fi
112
113 echo Version numbers are $version and $shortversion
114
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
122 fi
123 fi
124
125 ### Make sure we don't already have a directory emacs-${version}.
126
127 emacsname="emacs-${version}${new_extension}"
128
129 if [ -d ${emacsname} ]
130 then
131 echo Directory "${emacsname}" already exists >&2
132 exit 1
133 fi
134
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
144 fi
145
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}"
153 fi
154 rm -f /tmp/el /tmp/elc
155
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 if ! grep -q "dontcompilefiles:.* $file\($\| \)" lisp/Makefile; then
163 if [ "$file" != site-init.el ] && [ "$file" != site-load.el ] \
164 && [ "$file" != site-start.el ] && [ "$file" != default.el ]; then
165 bogosities="$file $bogosities"
166 fi
167 fi
168 done
169 if [ x"${bogosities}" != x"" ]; then
170 echo "The following .el files have no corresponding .elc files:"
171 echo "${bogosities}"
172 fi
173 rm -f /tmp/el /tmp/elc
174
175 ### Check for .el files that would overflow the 14-char limit if compiled.
176 long=`find lisp -name '[a-zA-Z0-9]??????????*.el' -print`
177 if [ "$long" != "" ]; then
178 echo "The following .el file names are too long:"
179 echo "$long"
180 fi
181
182 ### Make sure configure is newer than configure.in.
183 if [ "x`ls -t configure configure.in | head -1`" != "xconfigure" ]; then
184 echo "\`./configure.in' is newer than \`./configure'" >&2
185 echo "Running autoconf" >&2
186 autoconf || { x=$?; echo Autoconf FAILED! >&2; exit $x; }
187 fi
188
189 if [ $update = yes ];
190 then
191 echo "Updating Info files"
192
193 (cd man; make info)
194
195 echo "Recompiling Lisp files"
196
197 $EMACS -batch -f batch-byte-recompile-directory lisp
198
199 echo "Updating finder, custom and autoload data"
200
201 (cd lisp; make updates)
202 fi
203
204 echo "Making lisp/MANIFEST"
205
206 (cd lisp; head -1 [!=]*.el | grep '^;' | sed -e 's/;;; //' > MANIFEST)
207
208 echo "Creating staging directory: \`${tempparent}'"
209
210 mkdir ${tempparent}
211 tempdir="${tempparent}/${emacsname}"
212
213 ### This trap ensures that the staging directory will be cleaned up even
214 ### when the script is interrupted in mid-career.
215 if [ "${clean_up}" = yes ]; then
216 trap "echo 'Interrupted...cleaning up the staging directory'; rm -rf ${tempparent}; exit 1" 1 2 15
217 fi
218
219 echo "Creating top directory: \`${tempdir}'"
220 mkdir ${tempdir}
221
222 ### We copy in the top-level files before creating the subdirectories in
223 ### hopes that this will make the top-level files appear first in the
224 ### tar file; this means that people can start reading the INSTALL and
225 ### README while the rest of the tar file is still unpacking. Whoopee.
226 echo "Making links to top-level files"
227 ln GETTING.GNU.SOFTWARE INSTALL PROBLEMS README BUGS move-if-change ${tempdir}
228 ln ChangeLog Makefile.in configure configure.in ${tempdir}
229 ln config.bat make-dist update-subdirs vpath.sed ${tempdir}
230 ### Copy these files; they're cross-filesystem symlinks.
231 cp mkinstalldirs ${tempdir}
232 cp config.sub ${tempdir}
233 cp config.guess ${tempdir}
234 cp install.sh ${tempdir}
235
236 echo "Updating version number in README"
237 (cd ${tempdir}
238 awk \
239 '$1 " " $2 " " $3 " " $4 " " $5 == "This directory tree holds version" { $6 = version; print $0 }
240 $1 " " $2 " " $3 " " $4 " " $5 != "This directory tree holds version"' \
241 version=${version} README > tmp.README
242 mv tmp.README README)
243
244
245 echo "Creating subdirectories"
246 for subdir in lisp site-lisp leim real-leim real-leim/CXTERM-DIC \
247 real-leim/SKK real-leim/skk real-leim/quail \
248 src src/m src/s src/bitmaps lib-src oldXMenu lwlib \
249 nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet \
250 etc etc/e lock cpp info man msdos vms; do
251 mkdir ${tempdir}/${subdir}
252 done
253
254 echo "Initializing \`leim' subdirectory"
255 cp leim-Makefile.in ${tempdir}/leim/Makefile.in
256
257 echo "Making links to \`lisp' and its subdirectories"
258 ### Don't distribute TAGS, =*.el files, site-init.el, site-load.el, or default.el.
259 (cd lisp
260 ln [a-zA-Z]*.el ../${tempdir}/lisp
261 ln [a-zA-Z]*.elc ../${tempdir}/lisp
262 ln [a-zA-Z]*.dat ../${tempdir}/lisp
263 ## simula.el doesn't keep abbreviations in simula.defns any more.
264 ## ln [a-zA-Z]*.defns ../${tempdir}/lisp
265 ln ChangeLog Makefile makefile.nt ChangeLog.? README ../${tempdir}/lisp
266 (cd ../${tempdir}/lisp
267 rm -f TAGS =*
268 rm -f site-init site-init.el site-init.elc
269 rm -f site-load site-load.el site-load.elc
270 rm -f site-start site-start.el site-start.elc
271 rm -f default default.el default.elc
272 )
273
274 ## Find all subdirs of lisp dir
275 for file in `find . -type d -print`; do
276 case $file in
277 . | .. | */Old | */RCS | */=*)
278 ;;
279 *)
280 if [ -d $file ]; then
281 subdirs="$file $subdirs"
282 fi
283 ;;
284 esac
285 done
286
287 for file in $subdirs; do
288 echo " lisp/$file"
289 mkdir ../${tempdir}/lisp/$file
290 ln $file/[a-zA-Z]*.el ../${tempdir}/lisp/$file
291 ln $file/[a-zA-Z]*.elc ../${tempdir}/lisp/$file
292 if [ -f $file/README ]; then
293 ln $file/README ../${tempdir}/lisp/$file
294 fi
295 done )
296
297 echo "Making links to \`leim' and its subdirectories for the LEIM distribution"
298 ### Don't distribute TAGS, or =*.el files.
299 (cd leim
300 ln Makefile.in makefile.nt ../${tempdir}/real-leim
301 ln ChangeLog.? README ../${tempdir}/real-leim
302
303 ln CXTERM-DIC/*.tit ../${tempdir}/real-leim/CXTERM-DIC
304 ln SKK/README SKK/SKK-JISYO.L ../${tempdir}/real-leim/SKK
305 ln skk/*.el skk/*.elc ../${tempdir}/real-leim/skk
306 ln quail/*.el quail/*.elc ../${tempdir}/real-leim/quail
307
308 cd ../${tempdir}/real-leim
309 rm -f TAGS =* */=*)
310
311 ### Move the real-leim directory outside of Emacs proper.
312 (cd ${tempparent}; mv ${emacsname}/real-leim ${emacsname}-leim)
313
314 echo "Making links to \`src'"
315 ### Don't distribute =*.[ch] files, or the configured versions of
316 ### config.in, paths.in, or Makefile.in, or TAGS.
317 (cd src
318 echo " (It is ok if ln fails in some cases.)"
319 ln [a-zA-Z]*.c ../${tempdir}/src
320 ln [a-zA-Z]*.h ../${tempdir}/src
321 ln [a-zA-Z]*.s ../${tempdir}/src
322 ln [a-zA-Z]*.in ../${tempdir}/src
323 ln [a-zA-Z]*.opt ../${tempdir}/src
324 ## If we ended up with a symlink, or if we did not get anything
325 ## due to a cross-device symlink, copy the file.
326 for file in [a-zA-Z]*.[hcs] [a-zA-Z]*.in [a-zA-Z]*.opt; do
327 if test -f ../${tempdir}/src/$file; then
328 # test -f appears to succeed for a symlink
329 if test -L ../${tempdir}/src/$file; then
330 rm ../${tempdir}/src/$file
331 cp $file ../${tempdir}/src
332 chmod a-w ../${tempdir}/src/$file
333 fi
334 else
335 rm ../${tempdir}/src/$file
336 cp $file ../${tempdir}/src
337 chmod a-w ../${tempdir}/src/$file
338 fi
339 done
340 ln README ChangeLog ChangeLog.*[0-9] ../${tempdir}/src
341 ln makefile.nt vms-pp.trans ../${tempdir}/src
342 ln .gdbinit .dbxinit ../${tempdir}/src
343 cd ../${tempdir}/src
344 rm -f config.h paths.h Makefile Makefile.c
345 rm -f =* TAGS)
346
347 echo "Making links to \`src/bitmaps'"
348 (cd src/bitmaps
349 ln README *.xbm ../../${tempdir}/src/bitmaps)
350
351 echo "Making links to \`src/m'"
352 (cd src/m
353 # We call files for miscellaneous input (to linker etc) .inp.
354 ln README [a-zA-Z0-9]*.h *.inp ../../${tempdir}/src/m)
355
356 echo "Making links to \`src/s'"
357 (cd src/s
358 ln README [a-zA-Z0-9]*.h ../../${tempdir}/src/s)
359
360 echo "Making links to \`lib-src'"
361 (cd lib-src
362 ln [a-zA-Z]*.[chy] ../${tempdir}/lib-src
363 ln ChangeLog Makefile.in README testfile vcdiff ../${tempdir}/lib-src
364 ln emacs.csh rcs2log rcs-checkin makefile.nt ../${tempdir}/lib-src
365 ## If we ended up with a symlink, or if we did not get anything
366 ## due to a cross-device symlink, copy the file.
367 for file in [a-zA-Z]*.[chy]; do
368 if test -f ../${tempdir}/lib-src/$file; then
369 # test -f appears to succeed for a symlink
370 if test -L ../${tempdir}/lib-src/$file; then
371 rm ../${tempdir}/lib-src/$file
372 cp $file ../${tempdir}/lib-src
373 chmod a-w ../${tempdir}/lib-src/$file
374 fi
375 else
376 rm ../${tempdir}/lib-src/$file
377 cp $file ../${tempdir}/lib-src
378 chmod a-w ../${tempdir}/lib-src/$file
379 fi
380 done
381 cd ../${tempdir}/lib-src
382 rm -f Makefile.c
383 rm -f =* TAGS)
384
385 echo "Making links to \`nt'"
386 (cd nt
387 ln emacs.ico emacs.rc config.nt [a-z]*.in [a-z]*.c ../${tempdir}/nt
388 ln [a-z]*.bat [a-z]*.h makefile.def makefile.nt ../${tempdir}/nt
389 ln TODO ChangeLog INSTALL README ../${tempdir}/nt)
390
391 echo "Making links to \`nt/inc'"
392 (cd nt/inc
393 ln [a-z]*.h ../../${tempdir}/nt/inc)
394
395 echo "Making links to \`nt/inc/sys'"
396 (cd nt/inc/sys
397 ln [a-z]*.h ../../../${tempdir}/nt/inc/sys)
398
399 echo "Making links to \`nt/inc/arpa'"
400 (cd nt/inc/arpa
401 ln [a-z]*.h ../../../${tempdir}/nt/inc/arpa)
402
403 echo "Making links to \`nt/inc/netinet'"
404 (cd nt/inc/netinet
405 ln [a-z]*.h ../../../${tempdir}/nt/inc/netinet)
406
407 echo "Making links to \`msdos'"
408 (cd msdos
409 ln ChangeLog emacs.ico emacs.pif ../${tempdir}/msdos
410 ln is_exec.c sigaction.c mainmake mainmake.v2 sed*.inp ../${tempdir}/msdos
411 cd ../${tempdir}/msdos
412 rm -f =*)
413
414 echo "Making links to \`oldXMenu'"
415 (cd oldXMenu
416 ln *.c *.h *.in ../${tempdir}/oldXMenu
417 ln README Imakefile ChangeLog ../${tempdir}/oldXMenu
418 ln compile.com descrip.mms ../${tempdir}/oldXMenu)
419
420 echo "Making links to \`lwlib'"
421 (cd lwlib
422 ln *.c *.h *.in ../${tempdir}/lwlib
423 ln README Imakefile ChangeLog ../${tempdir}/lwlib
424 cd ../${tempdir}/lwlib
425 rm -f lwlib-Xol*)
426
427 echo "Making links to \`etc'"
428 ### Don't distribute = files, TAGS, DOC files, backups, autosaves, or
429 ### tex litter.
430 (cd etc
431 files=`ls -d * | grep -v 'RCS' | grep -v 'Old' | grep -v '^e$'`
432 ln $files ../${tempdir}/etc
433 ## If we ended up with a symlink, or if we did not get anything
434 ## due to a cross-device symlink, copy the file.
435 for file in $files; do
436 if test -f ../${tempdir}/etc/$file; then
437 # test -f appears to succeed for a symlink
438 if test -L ../${tempdir}/etc/$file; then
439 rm ../${tempdir}/etc/$file
440 cp $file ../${tempdir}/etc
441 chmod a-w ../${tempdir}/etc/$file
442 fi
443 else
444 rm ../${tempdir}/etc/$file
445 cp $file ../${tempdir}/etc
446 chmod a-w ../${tempdir}/etc/$file
447 fi
448 done
449 cd ../${tempdir}/etc
450 rm -f DOC* *~ \#*\# *.dvi *.log *.orig *.rej *,v =* core
451 rm -f TAGS)
452
453 echo "Making links to \`etc/e'"
454 (cd etc/e
455 ln `ls -d * | grep -v 'RCS'` ../../${tempdir}/etc/e
456 cd ../../${tempdir}/etc/e
457 rm -f *~ \#*\# *,v =* core)
458
459 echo "Making links to \`cpp'"
460 (cd cpp
461 ln cccp.c cexp.y Makefile README ../${tempdir}/cpp)
462
463 echo "Making links to \`info'"
464 # Don't distribute backups or autosaves.
465 (cd info
466 ln [a-zA-Z]* ../${tempdir}/info
467 cd ../${tempdir}/info
468 # Avoid an error when expanding the wildcards later.
469 ln emacs dummy~ ; ln emacs \#dummy\#
470 rm -f *~ \#*\# core)
471
472 echo "Making links to \`man'"
473 (cd man
474 ln *.texi *.aux *.cps *.fns *.kys *.vrs ../${tempdir}/man
475 test -f README && ln README ../${tempdir}/man
476 test -f Makefile.in && ln Makefile.in ../${tempdir}/man
477 ln ChangeLog split-man ../${tempdir}/man
478 cp texinfo.tex ../${tempdir}/man
479 cd ../${tempdir}/man
480 rm -f \#*\# =* *~ core emacs-index* *.Z *.z xmail
481 rm -f emacs.?? termcap.?? gdb.?? *.log *.toc *.dvi *.oaux)
482
483 echo "Making links to \`vms'"
484 (cd vms
485 ln [0-9a-zA-Z]* ../${tempdir}/vms
486 cd ../${tempdir}/vms
487 rm -f *~)
488
489 ### It would be nice if they could all be symlinks to etc's copy, but
490 ### you're not supposed to have any symlinks in distribution tar files.
491 echo "Making sure copying notices are all copies of \`etc/COPYING'"
492 rm -f ${tempdir}/etc/COPYING
493 cp etc/COPYING ${tempdir}/etc/COPYING
494 for subdir in lisp src lib-src info msdos; do
495 if [ -f ${tempdir}/${subdir}/COPYING ]; then
496 rm ${tempdir}/${subdir}/COPYING
497 fi
498 cp etc/COPYING ${tempdir}/${subdir}
499 done
500
501 #### Make sure that there aren't any hard links between files in the
502 #### distribution; people with afs can't deal with that. Okay,
503 #### actually we just re-copy anything with a link count greater
504 #### than two. (Yes, strictly greater than 2 is correct; since we
505 #### created these files by linking them in from the original tree,
506 #### they'll have exactly two links normally.)
507 ####
508 #### Commented out since it's not strictly necessary; it should suffice
509 #### to just break the link on alloca.c.
510 #echo "Breaking intra-tree links."
511 #find ${tempdir} ! -type d -links +2 \
512 # -exec cp -p {} $$ \; -exec rm -f {} \; -exec mv $$ {} \;
513 rm -f $tempdir/lib-src/alloca.c
514 cp $tempdir/src/alloca.c $tempdir/lib-src/alloca.c
515
516 if [ "${newer}" ]; then
517 echo "Removing files older than $newer"
518 ## We remove .elc files unconditionally, on the theory that anyone picking
519 ## up an incremental distribution already has a running Emacs to byte-compile
520 ## them with.
521 find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
522 fi
523
524 if [ "${make_tar}" = yes ]; then
525 if [ "${default_gzip}" = "" ]; then
526 echo "Looking for gzip"
527 temppath=`echo $PATH | sed 's/^:/.:/
528 s/::/:.:/g
529 s/:$/:./
530 s/:/ /g'`
531 default_gzip=`(
532 for dir in ${temppath}; do
533 if [ -f ${dir}/gzip ]; then echo 'gzip --best'; exit 0; fi
534 done
535 echo compress
536 )`
537 fi
538 case "${default_gzip}" in
539 compress* ) gzip_extension=.Z ;;
540 * ) gzip_extension=.gz ;;
541 esac
542 echo "Creating tar files"
543 (cd ${tempparent} ; tar cvf - ${emacsname} ) \
544 | ${default_gzip} \
545 > ${emacsname}.tar${gzip_extension}
546 (cd ${tempparent} ; tar cvf - ${emacsname}-leim ) \
547 | ${default_gzip} \
548 > ${emacsname}-leim.tar${gzip_extension}
549 fi
550
551 if [ "${clean_up}" = yes ]; then
552 echo "Cleaning up the staging directory"
553 rm -rf ${tempparent}
554 else
555 (cd ${tempparent}; mv ${emacsname} ${emacsname}-leim ..)
556 rm -rf ${tempparent}
557 fi
558
559 ### make-dist ends here