Make 'byte-compile-error-on-warn' a safe file variable
[emacs.git] / make-dist
blob26247b37bcabda0a2a9241500c51800be2ef5ab0
1 #!/bin/sh
2 ### make-dist: create an Emacs distribution tar file from current srcdir
4 ## Copyright (C) 1995, 1997-1998, 2000-2018 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 <https://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 [ -r $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 [ -r $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 [ -r Makefile ]; then
296 echo "Checking to see if info files are up-to-date..."
297 make --question info || error=yes
300 ## Is this a release?
301 case $version in
302 [1-9][0-9].[0-9])
303 if [ -r ChangeLog ]; then
304 if ! grep -q "Version $version released" ChangeLog; then
305 echo "No release notice in ChangeLog"
306 error=yes
308 else
309 echo "A release must have a ChangeLog"
310 error=yes
313 esac
315 if [ $error = yes ]; then
316 echo "Failed checks" >&2
317 exit 1
322 if [ $update = yes ]; then
324 ## Make sure configure is newer than configure.ac, etc.
325 ## It is better to let autoreconf do what is needed than
326 ## for us to try and duplicate all its checks.
327 echo "Running autoreconf"
328 autoreconf -i -I m4 || { x=$?; echo Autoreconf FAILED! >&2; exit $x; }
330 ## Make sure src/stamp-h.in is newer than configure.ac.
331 rm -f src/stamp-h.in
332 echo timestamp > src/stamp-h.in
334 echo "Updating Info files"
335 make info
337 echo "Updating finder, custom and autoload data"
338 (cd lisp && make updates EMACS="$EMACS")
340 echo "Updating leim-list.el"
341 (cd leim && make leim-list.el EMACS="$EMACS")
343 echo "Recompiling Lisp files"
344 $EMACS -batch -f batch-byte-recompile-directory lisp
345 fi # $update = yes
347 echo "Creating staging directory: '${tempparent}'"
349 mkdir ${tempparent}
350 tempdir="${tempparent}/${emacsname}"
352 ### This trap ensures that the staging directory will be cleaned up even
353 ### when the script is interrupted in mid-career.
354 if [ "${clean_up}" = yes ]; then
355 trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
358 echo "Creating top directory: '${tempdir}'"
359 mkdir ${tempdir}
361 if [ "$changelog" = yes ]; then
362 if test -r .git; then
363 ## When making a release or pretest the ChangeLog should already
364 ## have been created and edited as needed. Don't ignore it.
365 if test -r ChangeLog; then
366 echo "Using existing top-level ChangeLog"
367 else
368 echo "Making top-level ChangeLog"
369 make ChangeLog CHANGELOG=${tempdir}/ChangeLog || \
370 { x=$?; echo "make ChangeLog FAILED (try --no-changelog?)" >&2; exit $x; }
372 else
373 echo "No repository, so omitting top-level ChangeLog"
377 ### We copy in the top-level files before creating the subdirectories in
378 ### hopes that this will make the top-level files appear first in the
379 ### tar file; this means that people can start reading the INSTALL and
380 ### README while the rest of the tar file is still unpacking. Whoopee.
381 echo "Making links to top-level files"
382 ln INSTALL README BUGS ${tempdir}
383 ln ChangeLog.*[0-9] Makefile.in autogen.sh configure configure.ac ${tempdir}
384 ln config.bat make-dist .dir-locals.el ${tempdir}
385 ln aclocal.m4 CONTRIBUTE ChangeLog ${tempdir}
387 echo "Creating subdirectories"
388 for subdir in site-lisp \
389 leim leim/CXTERM-DIC leim/MISC-DIC leim/SKK-DIC \
390 build-aux \
391 src src/bitmaps lib lib-src oldXMenu lwlib \
392 nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
393 `find etc lisp admin test -type d` \
394 doc doc/emacs doc/misc doc/man doc/lispref doc/lispintro \
395 info m4 modules msdos \
396 nextstep nextstep/templates \
397 nextstep/Cocoa nextstep/Cocoa/Emacs.base \
398 nextstep/Cocoa/Emacs.base/Contents \
399 nextstep/Cocoa/Emacs.base/Contents/Resources \
400 nextstep/GNUstep \
401 nextstep/GNUstep/Emacs.base \
402 nextstep/GNUstep/Emacs.base/Resources
405 if [ "$with_tests" != "yes" ]; then
406 case $subdir in
407 test*) continue ;;
408 esac
411 ## site-lisp for in-place installs (?).
412 [ "$subdir" = "site-lisp" ] || [ -d "$subdir" ] || \
413 echo "WARNING: $subdir not found, making anyway"
414 [ "$verbose" = "yes" ] && echo " ${tempdir}/${subdir}"
415 mkdir ${tempdir}/${subdir}
416 done
418 echo "Making links to 'lisp' and its subdirectories"
419 files=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
420 -o -name 'README' \)`
422 ### Don't distribute site-init.el, site-load.el, or default.el.
423 for file in lisp/Makefile.in $files; do
424 case $file in
425 */site-init*|*/site-load*|*/default*) continue ;;
426 esac
427 ln $file $tempdir/$file
428 done
430 echo "Making links to 'leim' and its subdirectories"
431 (cd leim
432 ln ChangeLog.*[0-9] README ../${tempdir}/leim
433 ln CXTERM-DIC/README CXTERM-DIC/*.tit ../${tempdir}/leim/CXTERM-DIC
434 ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/leim/SKK-DIC
435 ln MISC-DIC/README MISC-DIC/*.* ../${tempdir}/leim/MISC-DIC
436 ln Makefile.in ../${tempdir}/leim/Makefile.in
437 ln leim-ext.el ../${tempdir}/leim/leim-ext.el)
439 ## FIXME Can we not just use the "find -type f" method for this one?
440 echo "Making links to 'build-aux'"
441 (cd build-aux
442 ln config.guess config.sub msys-to-w32 ../${tempdir}/build-aux
443 ln gitlog-to-changelog gitlog-to-emacslog ../${tempdir}/build-aux
444 ln install-sh move-if-change ../${tempdir}/build-aux
445 ln update-copyright update-subdirs ../${tempdir}/build-aux
446 ln dir_top make-info-dir ../${tempdir}/build-aux)
448 echo "Making links to 'src'"
449 ### Don't distribute the configured versions of
450 ### config.in, paths.in, buildobj.h, or Makefile.in.
451 (cd src
452 echo " (It is ok if ln fails in some cases.)"
453 ln [a-zA-Z]*.[chm] ../${tempdir}/src
454 ln [a-zA-Z]*.in ../${tempdir}/src
455 ln deps.mk ../${tempdir}/src
456 ln README ChangeLog.*[0-9] ../${tempdir}/src
457 ln .gdbinit .dbxinit ../${tempdir}/src
458 cd ../${tempdir}/src
459 rm -f globals.h config.h epaths.h Makefile buildobj.h)
461 echo "Making links to 'src/bitmaps'"
462 (cd src/bitmaps
463 ln README *.xbm ../../${tempdir}/src/bitmaps)
465 echo "Making links to 'lib'"
466 (cd lib
467 ln [a-zA-Z_]*.[ch] ../${tempdir}/lib
468 ln gnulib.mk.in Makefile.in ../${tempdir}/lib
469 cd ../${tempdir}/lib
470 script='/[*]/d; s/\.in\.h$/.h/'
471 rm -f `ls *.in.h | sed "$script"`)
473 echo "Making links to 'lib-src'"
474 (cd lib-src
475 ln [a-zA-Z]*.[ch] ../${tempdir}/lib-src
476 ln ChangeLog.*[0-9] Makefile.in README ../${tempdir}/lib-src
477 ln rcs2log ../${tempdir}/lib-src)
479 echo "Making links to 'm4'"
480 (cd m4
481 ln *.m4 ../${tempdir}/m4)
483 echo "Making links to 'modules'"
484 (cd modules
485 ln *.py ../${tempdir}/modules
488 echo "Making links to 'nt'"
489 (cd nt
490 ln emacs-x86.manifest emacs-x64.manifest ../${tempdir}/nt
491 ln [a-z]*.bat [a-z]*.[ch] ../${tempdir}/nt
492 ln *.in gnulib-cfg.mk ../${tempdir}/nt
493 ln mingw-cfg.site epaths.nt INSTALL.W64 ../${tempdir}/nt
494 ln ChangeLog.*[0-9] INSTALL README README.W32 ../${tempdir}/nt)
496 echo "Making links to 'nt/inc' and its subdirectories"
497 for f in `find nt/inc -type f -name '[a-z]*.h'`; do
498 ln $f $tempdir/$f
499 done
501 echo "Making links to 'nt/icons'"
502 (cd nt/icons
503 ln README [a-z]*.ico ../../${tempdir}/nt/icons
504 ln [a-z]*.cur ../../${tempdir}/nt/icons)
506 echo "Making links to 'msdos'"
507 (cd msdos
508 ln ChangeLog.*[0-9] INSTALL README emacs.ico emacs.pif ../${tempdir}/msdos
509 ln depfiles.bat inttypes.h ../${tempdir}/msdos
510 ln mainmake.v2 sed*.inp ../${tempdir}/msdos)
512 echo "Making links to 'nextstep'"
513 (cd nextstep
514 ln ChangeLog.*[0-9] README INSTALL Makefile.in ../${tempdir}/nextstep)
516 echo "Making links to 'nextstep/templates'"
517 (cd nextstep/templates
518 ln Emacs.desktop.in Info-gnustep.plist.in Info.plist.in InfoPlist.strings.in ../../${tempdir}/nextstep/templates)
520 echo "Making links to 'nextstep/Cocoa/Emacs.base/Contents'"
521 (cd nextstep/Cocoa/Emacs.base/Contents
522 ln PkgInfo ../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents)
524 echo "Making links to 'nextstep/Cocoa/Emacs.base/Contents/Resources'"
525 (cd nextstep/Cocoa/Emacs.base/Contents/Resources
526 ln Credits.html *.icns ../../../../../${tempdir}/nextstep/Cocoa/Emacs.base/Contents/Resources)
528 echo "Making links to 'nextstep/GNUstep/Emacs.base/Resources'"
529 (cd nextstep/GNUstep/Emacs.base/Resources
530 ln README emacs.tiff ../../../../${tempdir}/nextstep/GNUstep/Emacs.base/Resources )
532 echo "Making links to 'oldXMenu'"
533 (cd oldXMenu
534 ln *.[ch] *.in *.mk ../${tempdir}/oldXMenu
535 ln README ChangeLog.*[0-9] ../${tempdir}/oldXMenu)
537 echo "Making links to 'lwlib'"
538 (cd lwlib
539 ln *.[ch] *.in *.mk ../${tempdir}/lwlib
540 ln README ChangeLog.*[0-9] ../${tempdir}/lwlib)
542 ## It is important to distribute admin/ because it contains sources
543 ## for generated lisp/international/uni-*.el files.
544 echo "Making links to 'admin' and its subdirectories"
545 for f in `find admin -type f`; do
546 case $f in
547 */Makefile) [ -f $f.in ] && continue ;;
548 esac
549 ln $f $tempdir/$f
550 done
552 if [ "$with_tests" = "yes" ]; then
553 echo "Making links to 'test' and its subdirectories"
554 for f in `find test -type f ! -name '*.log' ! -name a.out \
555 ! -name '*.so' ! -name '*.dll' ! -name '*.o'
556 `; do
557 case $f in
558 */Makefile) [ -f $f.in ] && continue ;;
559 esac
560 ln $f $tempdir/$f
561 done
564 echo "Making links to 'etc' and its subdirectories"
565 for f in `find etc -type f`; do
566 case $f in
567 etc/DOC*|etc/*.pyc) continue ;;
568 ## Arguably we should not exclude *.ps.
569 etc/refcards/*.aux|etc/refcards/*.dvi|etc/refcards/*.log|etc/refcards/*.ps)
570 continue ;;
571 esac
572 ln $f $tempdir/$f
573 done
575 echo "Making links to 'info'"
576 ln `find info -type f -print` ${tempdir}/info
578 echo "Making links to 'doc/emacs'"
579 (cd doc/emacs
580 ln *.texi *.in ChangeLog.*[0-9] ../../${tempdir}/doc/emacs)
582 echo "Making links to 'doc/misc'"
583 (cd doc/misc
584 ln *.texi *.tex *.in gnus-news.el ChangeLog.*[0-9] \
585 ../../${tempdir}/doc/misc)
587 echo "Making links to 'doc/lispref'"
588 (cd doc/lispref
589 ln *.texi *.in README ChangeLog.*[0-9] ../../${tempdir}/doc/lispref
590 ln spellfile ../../${tempdir}/doc/lispref
591 ln two-volume.make two-volume-cross-refs.txt ../../${tempdir}/doc/lispref)
593 echo "Making links to 'doc/lispintro'"
594 (cd doc/lispintro
595 ln *.texi *.in *.eps *.pdf ../../${tempdir}/doc/lispintro
596 ln README ChangeLog.*[0-9] ../../${tempdir}/doc/lispintro
597 cd ../../${tempdir}/doc/lispintro)
599 echo "Making links to 'doc/man'"
600 (cd doc/man
601 ln *.*[0-9] *.in ../../${tempdir}/doc/man
602 cd ../../${tempdir}/doc/man
603 rm -f emacs.1)
605 ### It would be nice if they could all be symlinks to top-level copy, but
606 ### you're not supposed to have any symlinks in distribution tar files.
607 echo "Making sure copying notices are all copies of 'COPYING'"
608 for subdir in . etc leim lib lib-src lisp lwlib msdos nt src; do
609 rm -f ${tempdir}/${subdir}/COPYING
610 cp COPYING ${tempdir}/${subdir}
611 done
613 if [ "${newer}" ]; then
614 printf '%s\n' "Removing files older than $newer"
615 ## We remove .elc files unconditionally, on the theory that anyone picking
616 ## up an incremental distribution already has a running Emacs to byte-compile
617 ## them with.
618 find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
621 ## Don't distribute backups, autosaves, etc.
622 echo "Removing unwanted files"
623 find ${tempparent} \( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \) -exec rm -f {} \;
625 if [ "${make_tar}" = yes ]; then
626 echo "Looking for $default_gzip"
627 found=0
628 temppath=`printf '%s\n' "$PATH" |
629 sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' -e 's/:/ /g'
631 for dir in ${temppath}; do
632 [ -x ${dir}/$default_gzip ] || continue
633 found=1; break
634 done
635 if [ "$found" = "0" ]; then
636 echo "WARNING: '$default_gzip' not found, will not compress" >&2
637 default_gzip=cat
639 case "${default_gzip}" in
640 bzip2) gzip_extension=.bz2 ;;
641 xz) gzip_extension=.xz ;;
642 gzip) gzip_extension=.gz ; default_gzip="gzip --best";;
643 *) gzip_extension= ;;
644 esac
645 echo "Creating tar file"
646 taropt=
647 [ "$verbose" = "yes" ] && taropt=v
649 (cd ${tempparent} ; tar c${taropt}f - ${emacsname} ) \
650 | ${default_gzip} \
651 > ${emacsname}.tar${gzip_extension}
654 if [ "${clean_up}" != yes ]; then
655 (cd ${tempparent}; mv ${emacsname} ..)
656 rm -rf ${tempparent}
659 ### make-dist ends here