Add unit test for Bug#26378
[emacs.git] / make-dist
blob7e1f0dfb96c8a3544d7c24dce448f945d9d7c2d7
1 #!/bin/sh
2 ### make-dist: create an Emacs distribution tar file from current srcdir
4 ## Copyright (C) 1995, 1997-1998, 2000-2017 Free Software Foundation,
5 ## Inc.
7 ## This file is part of GNU Emacs.
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.
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.
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/>.
22 ### Commentary:
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.
29 ### Code:
31 progname="$0"
33 ### Exit if a command fails.
34 #set -e
36 ### Print out each line we read, for debugging's sake.
37 #set -v
39 LANGUAGE=C
40 LC_ALL=C
41 LC_MESSAGES=
42 LANG=
43 export LANGUAGE LC_ALL LC_MESSAGES LANG
45 ## Remove unnecessary restrictions on file access.
46 umask 022
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 changelog=yes
56 verbose=no
58 while [ $# -gt 0 ]; do
59 case "$1" in
60 ## This option tells make-dist to delete the staging directory
61 ## when done. It is useless to use this unless you make a tar file.
62 "--clean-up" )
63 clean_up=yes
65 ## This option tells make-dist to make a tar file.
66 "--tar" )
67 make_tar=yes
69 ## This option tells make-dist not to recompile or do analogous things.
70 "--no-update" )
71 update=no
73 ## This option says don't check for bad file names, etc.
74 "--no-check" )
75 check=no
77 "--no-changelog" )
78 changelog=no
80 ## This option tells make-dist to make the distribution normally, then
81 ## remove all files older than the given timestamp file. This is useful
82 ## for creating incremental or patch distributions.
83 "--newer")
84 newer="$2"
85 new_extension=".new"
86 shift
88 ## This option tells make-dist to use 'bzip2' instead of gzip.
89 "--bzip2")
90 default_gzip="bzip2"
92 ## Same with xz.
93 "--xz")
94 default_gzip="xz"
96 "--no-compress")
97 default_gzip="cat"
100 "--snapshot")
101 clean_up=yes
102 make_tar=yes
103 update=no
106 ## Include the test/ directory.
107 ## This option is mainly for the hydra build server.
108 "--tests")
109 with_tests=yes
112 "--verbose")
113 verbose=yes
116 "--help")
117 printf '%s\n' "Usage: ${progname} [options]"
118 echo ""
119 echo " --bzip2 use bzip2 instead of gzip"
120 echo " --clean-up delete staging directories when done"
121 echo " --xz use xz instead of gzip"
122 echo " --no-compress don't compress"
123 echo " --newer=TIME don't include files older than TIME"
124 echo " --no-check don't check for bad file names etc."
125 echo " --no-update don't recompile or do analogous things"
126 echo " --no-changelog don't generate the top-level ChangeLog"
127 echo " --snapshot same as --clean-up --no-update --tar --no-check"
128 echo " --tar make a tar file"
129 echo " --tests include the test/ directory"
130 echo " --verbose noisier output"
131 echo ""
132 exit 0
136 printf '%s\n' "${progname}: Unrecognized argument: $1" >&2
137 exit 1
139 esac
140 shift
141 done
143 ### Make sure we're running in the right place.
144 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/subr.el ]; then
145 printf '%s\n' "${progname}: Can't find 'src/lisp.h' and 'lisp/subr.el'." >&2
146 printf '%s\n' "${progname} must be run in the top directory of the Emacs" >&2
147 printf '%s\n' "distribution tree. cd to that directory and try again." >&2
148 exit 1
151 ### Find where to run Emacs.
152 ### (Accept only absolute file names.)
153 if [ $update = yes ];
154 then
155 if [ -f src/emacs ];
156 then
157 EMACS=`pwd`/src/emacs
158 else
159 case $EMACS in
160 /*) ;;
162 if [ ! -f "$EMACS" ]; then
163 printf '%s\n' "$0: You must set the EMACS environment variable " \
164 "to an absolute file name." 2>&1
165 exit 1
166 fi;;
167 esac
171 ### Find out which version of Emacs this is.
172 version=`
173 sed -n 's/^AC_INIT(GNU Emacs,[ ]*\([^ ,)]*\).*/\1/p' <configure.ac
174 ` || version=
175 if [ ! "${version}" ]; then
176 printf '%s\n' \
177 "${progname}: can't find current Emacs version in './src/emacs.c'" >&2
178 exit 1
181 echo Version number is $version
183 if [ $update = yes ]; then
184 if ! grep -q "tree holds version *${version}" README; then
185 echo "WARNING: README has the wrong version number"
186 echo "Consider running M-x set-version from admin/admin.el"
187 sleep 5
191 ### Make sure we don't already have a directory emacs-${version}.
193 emacsname="emacs-${version}${new_extension}"
195 if [ -d ${emacsname} ]
196 then
197 echo Directory "${emacsname}" already exists >&2
198 exit 1
201 ### Make sure the subdirectory is available.
202 tempparent="make-dist.tmp.$$"
203 if [ -d ${tempparent} ]; then
204 printf '%s\n' "${progname}: staging directory '${tempparent}' already exists.
205 Perhaps a previous invocation of '${progname}' failed to clean up after
206 itself. Check that directories whose names are of the form
207 'make-dist.tmp.NNNNN' don't contain any important information, remove
208 them, and try again." >&2
209 exit 1
212 if [ $check = yes ]; then
214 echo "Sanity checking (use --no-check to disable this)..."
216 error=no
218 ls -1 lisp/[a-zA-Z]*.el lisp/[a-z]*/[a-zA-Z0-9]*.el \
219 lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
220 lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el > /tmp/el
222 ls -1 lisp/[a-zA-Z]*.elc lisp/[a-z]*/[a-zA-Z0-9]*.elc \
223 lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
224 lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc > /tmp/elc
226 ## Check for .elc files with no corresponding .el file.
227 sed 's/\.el$/.elc/' /tmp/el > /tmp/elelc
229 bogosities=`comm -13 /tmp/elelc /tmp/elc`
230 if [ x"${bogosities}" != x"" ]; then
231 error=yes
232 echo "The following .elc files have no corresponding .el files:"
233 echo "${bogosities}"
236 ### Check for .el files with no corresponding .elc file.
237 sed 's/\.elc$/.el/' /tmp/elc > /tmp/elcel
238 losers=`comm -23 /tmp/el /tmp/elcel`
240 bogosities=
241 while read elc; do
242 el=`echo $elc | sed 's/c$//'`
243 [ -e $el ] || continue
244 [ $elc -nt $el ] || bogosities="$bogosities $elc"
245 done < /tmp/elc
247 if [ x"${bogosities}" != x"" ]; then
248 error=yes
249 echo "The following .elc files are older than their .el files:"
250 echo "${bogosities}"
253 rm -f /tmp/el /tmp/elc /tmp/elcel /tmp/elelc
255 bogosities=
256 for file in $losers; do
257 grep -q "no-byte-compile: t" $file && continue
258 case $file in
259 site-init.el | site-load.el | site-start.el | default.el) continue ;;
260 esac
262 bogosities="$file $bogosities"
264 done
265 if [ x"${bogosities}" != x"" ]; then
266 error=yes
267 echo "The following .el files have no corresponding .elc files:"
268 echo "${bogosities}"
272 ## This is only a crude check, eg it does not handle .info
273 ## files with multiple .texi source files.
274 find doc -name '*.texi' > /tmp/el
276 bogosities=
277 while read texi; do
278 info=`sed -n 's/^@setfilename //p' $texi | sed 's|.*info/||'`
279 [ x"${info}" != x"" ] || continue
280 info=info/$info
281 [ -e $info ] || continue
282 [ $info -nt $texi ] || bogosities="$bogosities $info"
283 done < /tmp/el
285 rm -f /tmp/el
287 if [ x"${bogosities}" != x"" ]; then
288 error=yes
289 echo "The following .info files are older than their .texi files:"
290 echo "${bogosities}"
293 ## This exits with non-zero status if any .info files need
294 ## rebuilding.
295 if [ -e Makefile ]; then
296 echo "Checking to see if info files are up-to-date..."
297 make --question info || error=yes
300 if [ $error = yes ]; then
301 echo "Failed checks" >&2
302 exit 1
307 if [ $update = yes ]; then
309 ## Make sure configure is newer than configure.ac, etc.
310 ## It is better to let autoreconf do what is needed than
311 ## for us to try and duplicate all its checks.
312 echo "Running autoreconf"
313 autoreconf -i -I m4 || { x=$?; echo Autoreconf FAILED! >&2; exit $x; }
315 ## Make sure src/stamp-h.in is newer than configure.ac.
316 rm -f src/stamp-h.in
317 echo timestamp > src/stamp-h.in
319 echo "Updating Info files"
320 make info
322 echo "Updating finder, custom and autoload data"
323 (cd lisp && make updates EMACS="$EMACS")
325 echo "Updating leim-list.el"
326 (cd leim && make leim-list.el EMACS="$EMACS")
328 echo "Recompiling Lisp files"
329 $EMACS -batch -f batch-byte-recompile-directory lisp
330 fi # $update = yes
332 echo "Creating staging directory: '${tempparent}'"
334 mkdir ${tempparent}
335 tempdir="${tempparent}/${emacsname}"
337 ### This trap ensures that the staging directory will be cleaned up even
338 ### when the script is interrupted in mid-career.
339 if [ "${clean_up}" = yes ]; then
340 trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
343 echo "Creating top directory: '${tempdir}'"
344 mkdir ${tempdir}
346 if [ "$changelog" = yes ]; then
347 if test -e .git; then
348 echo "Making top-level ChangeLog"
349 make ChangeLog CHANGELOG=${tempdir}/ChangeLog || \
350 { x=$?; echo "make ChangeLog FAILED (try --no-changelog?)" >&2; exit $x; }
351 else
352 echo "No repository, so omitting top-level ChangeLog"
356 ### We copy in the top-level files before creating the subdirectories in
357 ### hopes that this will make the top-level files appear first in the
358 ### tar file; this means that people can start reading the INSTALL and
359 ### README while the rest of the tar file is still unpacking. Whoopee.
360 echo "Making links to top-level files"
361 ln INSTALL README BUGS ${tempdir}
362 ln ChangeLog.*[0-9] Makefile.in autogen.sh configure configure.ac ${tempdir}
363 ln config.bat make-dist .dir-locals.el ${tempdir}
364 ln aclocal.m4 CONTRIBUTE ${tempdir}
366 echo "Creating subdirectories"
367 for subdir in site-lisp \
368 leim leim/CXTERM-DIC leim/MISC-DIC leim/SKK-DIC \
369 build-aux \
370 src src/bitmaps lib lib-src oldXMenu lwlib \
371 nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
372 `find etc lisp admin test -type d` \
373 doc doc/emacs doc/misc doc/man doc/lispref doc/lispintro \
374 info m4 modules modules/mod-test msdos \
375 nextstep nextstep/templates \
376 nextstep/Cocoa nextstep/Cocoa/Emacs.base \
377 nextstep/Cocoa/Emacs.base/Contents \
378 nextstep/Cocoa/Emacs.base/Contents/Resources \
379 nextstep/GNUstep \
380 nextstep/GNUstep/Emacs.base \
381 nextstep/GNUstep/Emacs.base/Resources
384 if [ "$with_tests" != "yes" ]; then
385 case $subdir in
386 test*|*/mod-test*) continue ;;
387 esac
390 ## site-lisp for in-place installs (?).
391 [ "$subdir" = "site-lisp" ] || [ -d "$subdir" ] || \
392 echo "WARNING: $subdir not found, making anyway"
393 [ "$verbose" = "yes" ] && echo " ${tempdir}/${subdir}"
394 mkdir ${tempdir}/${subdir}
395 done
397 echo "Making links to 'lisp' and its subdirectories"
398 files=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
399 -o -name 'README' \)`
401 ### Don't distribute site-init.el, site-load.el, or default.el.
402 for file in lisp/Makefile.in $files; do
403 case $file in
404 */site-init*|*/site-load*|*/default*) continue ;;
405 esac
406 ln $file $tempdir/$file
407 done
409 echo "Making links to 'leim' and its subdirectories"
410 (cd leim
411 ln ChangeLog.*[0-9] README ../${tempdir}/leim
412 ln CXTERM-DIC/README CXTERM-DIC/*.tit ../${tempdir}/leim/CXTERM-DIC
413 ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/leim/SKK-DIC
414 ln MISC-DIC/README MISC-DIC/*.* ../${tempdir}/leim/MISC-DIC
415 ln Makefile.in ../${tempdir}/leim/Makefile.in
416 ln leim-ext.el ../${tempdir}/leim/leim-ext.el)
418 ## FIXME Can we not just use the "find -type f" method for this one?
419 echo "Making links to 'build-aux'"
420 (cd build-aux
421 ln config.guess config.sub msys-to-w32 ../${tempdir}/build-aux
422 ln gitlog-to-changelog gitlog-to-emacslog ../${tempdir}/build-aux
423 ln install-sh move-if-change ../${tempdir}/build-aux
424 ln update-copyright update-subdirs ../${tempdir}/build-aux
425 ln dir_top make-info-dir ../${tempdir}/build-aux)
427 echo "Making links to 'src'"
428 ### Don't distribute the configured versions of
429 ### config.in, paths.in, buildobj.h, or Makefile.in.
430 (cd src
431 echo " (It is ok if ln fails in some cases.)"
432 ln [a-zA-Z]*.[chm] ../${tempdir}/src
433 ln [a-zA-Z]*.in ../${tempdir}/src
434 ln deps.mk ../${tempdir}/src
435 ln README ChangeLog.*[0-9] ../${tempdir}/src
436 ln .gdbinit .dbxinit ../${tempdir}/src
437 cd ../${tempdir}/src
438 rm -f globals.h config.h epaths.h Makefile buildobj.h)
440 echo "Making links to 'src/bitmaps'"
441 (cd src/bitmaps
442 ln README *.xbm ../../${tempdir}/src/bitmaps)
444 echo "Making links to 'lib'"
445 (cd lib
446 ln [a-zA-Z_]*.[ch] ../${tempdir}/lib
447 ln gnulib.mk.in Makefile.in ../${tempdir}/lib
448 cd ../${tempdir}/lib
449 script='/[*]/d; s/\.in\.h$/.h/'
450 rm -f `ls *.in.h | sed "$script"`)
452 echo "Making links to 'lib-src'"
453 (cd lib-src
454 ln [a-zA-Z]*.[ch] ../${tempdir}/lib-src
455 ln ChangeLog.*[0-9] Makefile.in README ../${tempdir}/lib-src
456 ln rcs2log ../${tempdir}/lib-src)
458 echo "Making links to 'm4'"
459 (cd m4
460 ln *.m4 ../${tempdir}/m4)
462 echo "Making links to 'modules'"
463 (cd modules
464 ln *.py ../${tempdir}/modules
465 if [ "$with_tests" = "yes" ]; then
466 for f in `find mod-test -type f`; do
467 case $f in
468 *.log|*.o|*.so) continue ;;
469 esac
470 ln $f ../$tempdir/modules/$f
471 done
475 echo "Making links to 'nt'"
476 (cd nt
477 ln emacs-x86.manifest emacs-x64.manifest ../${tempdir}/nt
478 ln [a-z]*.bat [a-z]*.[ch] ../${tempdir}/nt
479 ln *.in gnulib-cfg.mk ../${tempdir}/nt
480 ln mingw-cfg.site epaths.nt INSTALL.W64 ../${tempdir}/nt
481 ln ChangeLog.*[0-9] INSTALL README README.W32 ../${tempdir}/nt)
483 echo "Making links to 'nt/inc' and its subdirectories"
484 for f in `find nt/inc -type f -name '[a-z]*.h'`; do
485 ln $f $tempdir/$f
486 done
488 echo "Making links to 'nt/icons'"
489 (cd nt/icons
490 ln README [a-z]*.ico ../../${tempdir}/nt/icons
491 ln [a-z]*.cur ../../${tempdir}/nt/icons)
493 echo "Making links to 'msdos'"
494 (cd msdos
495 ln ChangeLog.*[0-9] INSTALL README emacs.ico emacs.pif ../${tempdir}/msdos
496 ln depfiles.bat inttypes.h ../${tempdir}/msdos
497 ln mainmake.v2 sed*.inp ../${tempdir}/msdos)
499 echo "Making links to 'nextstep'"
500 (cd nextstep
501 ln ChangeLog.*[0-9] README INSTALL Makefile.in ../${tempdir}/nextstep)
503 echo "Making links to 'nextstep/templates'"
504 (cd nextstep/templates
505 ln Emacs.desktop.in Info-gnustep.plist.in Info.plist.in InfoPlist.strings.in ../../${tempdir}/nextstep/templates)
507 echo "Making links to 'nextstep/Cocoa/Emacs.base/Contents'"
508 (cd nextstep/Cocoa/Emacs.base/Contents
509 ln PkgInfo ../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents)
511 echo "Making links to 'nextstep/Cocoa/Emacs.base/Contents/Resources'"
512 (cd nextstep/Cocoa/Emacs.base/Contents/Resources
513 ln Credits.html *.icns ../../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents/Resources)
515 echo "Making links to 'nextstep/GNUstep/Emacs.base/Resources'"
516 (cd nextstep/GNUstep/Emacs.base/Resources
517 ln README emacs.tiff ../../../../${tempdir}/nextstep/GNUstep/Emacs.base/Resources )
519 echo "Making links to 'oldXMenu'"
520 (cd oldXMenu
521 ln *.[ch] *.in *.mk ../${tempdir}/oldXMenu
522 ln README ChangeLog.*[0-9] ../${tempdir}/oldXMenu)
524 echo "Making links to 'lwlib'"
525 (cd lwlib
526 ln *.[ch] *.in *.mk ../${tempdir}/lwlib
527 ln README ChangeLog.*[0-9] ../${tempdir}/lwlib)
529 ## It is important to distribute admin/ because it contains sources
530 ## for generated lisp/international/uni-*.el files.
531 echo "Making links to 'admin' and its subdirectories"
532 for f in `find admin -type f`; do
533 case $f in
534 */Makefile) [ -f $f.in ] && continue ;;
535 esac
536 ln $f $tempdir/$f
537 done
539 if [ "$with_tests" = "yes" ]; then
540 echo "Making links to 'test' and its subdirectories"
541 for f in `find test -type f ! -name '*.log' ! -name a.out \
542 ! -path test/Makefile
543 `; do
544 ln $f $tempdir/$f
545 done
548 echo "Making links to 'etc' and its subdirectories"
549 for f in `find etc -type f`; do
550 case $f in
551 etc/DOC*|etc/*.pyc) continue ;;
552 ## Arguably we should not exclude *.ps.
553 etc/refcards/*.aux|etc/refcards/*.dvi|etc/refcards/*.log|etc/refcards/*.ps)
554 continue ;;
555 esac
556 ln $f $tempdir/$f
557 done
559 echo "Making links to 'info'"
560 ln `find info -type f -print` ${tempdir}/info
562 echo "Making links to 'doc/emacs'"
563 (cd doc/emacs
564 ln *.texi *.in ChangeLog.*[0-9] ../../${tempdir}/doc/emacs)
566 echo "Making links to 'doc/misc'"
567 (cd doc/misc
568 ln *.texi *.tex *.in gnus-news.el ChangeLog.*[0-9] \
569 ../../${tempdir}/doc/misc)
571 echo "Making links to 'doc/lispref'"
572 (cd doc/lispref
573 ln *.texi *.in README ChangeLog.*[0-9] ../../${tempdir}/doc/lispref
574 ln spellfile ../../${tempdir}/doc/lispref
575 ln two-volume.make two-volume-cross-refs.txt ../../${tempdir}/doc/lispref)
577 echo "Making links to 'doc/lispintro'"
578 (cd doc/lispintro
579 ln *.texi *.in *.eps *.pdf ../../${tempdir}/doc/lispintro
580 ln README ChangeLog.*[0-9] ../../${tempdir}/doc/lispintro
581 cd ../../${tempdir}/doc/lispintro)
583 echo "Making links to 'doc/man'"
584 (cd doc/man
585 ln *.*[0-9] *.in ../../${tempdir}/doc/man
586 cd ../../${tempdir}/doc/man
587 rm -f emacs.1)
589 ### It would be nice if they could all be symlinks to top-level copy, but
590 ### you're not supposed to have any symlinks in distribution tar files.
591 echo "Making sure copying notices are all copies of 'COPYING'"
592 for subdir in . etc leim lib lib-src lisp lwlib msdos nt src; do
593 rm -f ${tempdir}/${subdir}/COPYING
594 cp COPYING ${tempdir}/${subdir}
595 done
597 if [ "${newer}" ]; then
598 printf '%s\n' "Removing files older than $newer"
599 ## We remove .elc files unconditionally, on the theory that anyone picking
600 ## up an incremental distribution already has a running Emacs to byte-compile
601 ## them with.
602 find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
605 ## Don't distribute backups, autosaves, etc.
606 echo "Removing unwanted files"
607 find ${tempparent} \( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \) -exec rm -f {} \;
609 if [ "${make_tar}" = yes ]; then
610 echo "Looking for $default_gzip"
611 found=0
612 temppath=`printf '%s\n' "$PATH" |
613 sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' -e 's/:/ /g'
615 for dir in ${temppath}; do
616 [ -x ${dir}/$default_gzip ] || continue
617 found=1; break
618 done
619 if [ "$found" = "0" ]; then
620 echo "WARNING: '$default_gzip' not found, will not compress" >&2
621 default_gzip=cat
623 case "${default_gzip}" in
624 bzip2) gzip_extension=.bz2 ;;
625 xz) gzip_extension=.xz ;;
626 gzip) gzip_extension=.gz ; default_gzip="gzip --best";;
627 *) gzip_extension= ;;
628 esac
629 echo "Creating tar file"
630 taropt=
631 [ "$verbose" = "yes" ] && taropt=v
633 (cd ${tempparent} ; tar c${taropt}f - ${emacsname} ) \
634 | ${default_gzip} \
635 > ${emacsname}.tar${gzip_extension}
638 if [ "${clean_up}" != yes ]; then
639 (cd ${tempparent}; mv ${emacsname} ..)
640 rm -rf ${tempparent}
643 ### make-dist ends here