Update remaining copyright years with admin.el M-x set-copyright
[emacs.git] / make-dist
blob4d17aaa8c77bd6c4aa873a1df8c3a5989cf12280
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
57 while [ $# -gt 0 ]; do
58 case "$1" in
59 ## This option tells make-dist to delete the staging directory
60 ## when done. It is useless to use this unless you make a tar file.
61 "--clean-up" )
62 clean_up=yes
64 ## This option tells make-dist to make a tar file.
65 "--tar" )
66 make_tar=yes
68 ## This option tells make-dist not to recompile or do analogous things.
69 "--no-update" )
70 update=no
72 ## This option says don't check for bad file names, etc.
73 "--no-check" )
74 check=no
76 "--no-changelog" )
77 changelog=no
79 ## This option tells make-dist to make the distribution normally, then
80 ## remove all files older than the given timestamp file. This is useful
81 ## for creating incremental or patch distributions.
82 "--newer")
83 newer="$2"
84 new_extension=".new"
85 shift
87 ## This option tells make-dist to use 'bzip2' instead of gzip.
88 "--bzip2")
89 default_gzip="bzip2"
91 ## Same with xz.
92 "--xz")
93 default_gzip="xz"
95 "--no-compress")
96 default_gzip="cat"
99 "--snapshot")
100 clean_up=yes
101 make_tar=yes
102 update=no
105 ## Include the test/ directory.
106 ## This option is mainly for the hydra build server.
107 "--tests")
108 with_tests=yes
111 "--help")
112 printf '%s\n' "Usage: ${progname} [options]"
113 echo ""
114 echo " --bzip2 use bzip2 instead of gzip"
115 echo " --clean-up delete staging directories when done"
116 echo " --xz use xz instead of gzip"
117 echo " --no-compress don't compress"
118 echo " --newer=TIME don't include files older than TIME"
119 echo " --no-check don't check for bad file names etc."
120 echo " --no-update don't recompile or do analogous things"
121 echo " --no-changelog don't generate the top-level ChangeLog"
122 echo " --snapshot same as --clean-up --no-update --tar --no-check"
123 echo " --tar make a tar file"
124 echo " --tests include the test/ directory"
125 echo ""
126 exit 0
130 printf '%s\n' "${progname}: Unrecognized argument: $1" >&2
131 exit 1
133 esac
134 shift
135 done
137 ### Make sure we're running in the right place.
138 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/subr.el ]; then
139 printf '%s\n' "${progname}: Can't find 'src/lisp.h' and 'lisp/subr.el'." >&2
140 printf '%s\n' "${progname} must be run in the top directory of the Emacs" >&2
141 printf '%s\n' "distribution tree. cd to that directory and try again." >&2
142 exit 1
145 ### Find where to run Emacs.
146 ### (Accept only absolute file names.)
147 if [ $update = yes ];
148 then
149 if [ -f src/emacs ];
150 then
151 EMACS=`pwd`/src/emacs
152 else
153 case $EMACS in
154 /*) ;;
156 if [ ! -f "$EMACS" ]; then
157 printf '%s\n' "$0: You must set the EMACS environment variable " \
158 "to an absolute file name." 2>&1
159 exit 1
160 fi;;
161 esac
165 ### Find out which version of Emacs this is.
166 version=`
167 sed -n 's/^AC_INIT(GNU Emacs,[ ]*\([^ ,)]*\).*/\1/p' <configure.ac
168 ` || version=
169 if [ ! "${version}" ]; then
170 printf '%s\n' \
171 "${progname}: can't find current Emacs version in './src/emacs.c'" >&2
172 exit 1
175 echo Version number is $version
177 if [ $update = yes ]; then
178 if ! grep -q "tree holds version *${version}" README; then
179 echo "WARNING: README has the wrong version number"
180 echo "Consider running M-x set-version from admin/admin.el"
181 sleep 5
185 ### Make sure we don't already have a directory emacs-${version}.
187 emacsname="emacs-${version}${new_extension}"
189 if [ -d ${emacsname} ]
190 then
191 echo Directory "${emacsname}" already exists >&2
192 exit 1
195 ### Make sure the subdirectory is available.
196 tempparent="make-dist.tmp.$$"
197 if [ -d ${tempparent} ]; then
198 printf '%s\n' "${progname}: staging directory '${tempparent}' already exists.
199 Perhaps a previous invocation of '${progname}' failed to clean up after
200 itself. Check that directories whose names are of the form
201 'make-dist.tmp.NNNNN' don't contain any important information, remove
202 them, and try again." >&2
203 exit 1
206 if [ $check = yes ]; then
208 echo "Sanity checking (use --no-check to disable this)..."
210 error=no
212 ls -1 lisp/[a-zA-Z]*.el lisp/[a-z]*/[a-zA-Z0-9]*.el \
213 lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
214 lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el > /tmp/el
216 ls -1 lisp/[a-zA-Z]*.elc lisp/[a-z]*/[a-zA-Z0-9]*.elc \
217 lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
218 lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc > /tmp/elc
220 ## Check for .elc files with no corresponding .el file.
221 sed 's/\.el$/.elc/' /tmp/el > /tmp/elelc
223 bogosities=`comm -13 /tmp/elelc /tmp/elc`
224 if [ x"${bogosities}" != x"" ]; then
225 error=yes
226 echo "The following .elc files have no corresponding .el files:"
227 echo "${bogosities}"
230 ### Check for .el files with no corresponding .elc file.
231 sed 's/\.elc$/.el/' /tmp/elc > /tmp/elcel
232 losers=`comm -23 /tmp/el /tmp/elcel`
234 bogosities=
235 while read elc; do
236 el=`echo $elc | sed 's/c$//'`
237 [ -e $el ] || continue
238 [ $elc -nt $el ] || bogosities="$bogosities $elc"
239 done < /tmp/elc
241 if [ x"${bogosities}" != x"" ]; then
242 error=yes
243 echo "The following .elc files are older than their .el files:"
244 echo "${bogosities}"
247 rm -f /tmp/el /tmp/elc /tmp/elcel /tmp/elelc
249 bogosities=
250 for file in $losers; do
251 grep -q "no-byte-compile: t" $file && continue
252 case $file in
253 site-init.el | site-load.el | site-start.el | default.el) continue ;;
254 esac
256 bogosities="$file $bogosities"
258 done
259 if [ x"${bogosities}" != x"" ]; then
260 error=yes
261 echo "The following .el files have no corresponding .elc files:"
262 echo "${bogosities}"
266 ## This is only a crude check, eg it does not handle .info
267 ## files with multiple .texi source files.
268 find doc -name '*.texi' > /tmp/el
270 bogosities=
271 while read texi; do
272 info=`sed -n 's/^@setfilename //p' $texi | sed 's|.*info/||'`
273 [ x"${info}" != x"" ] || continue
274 info=info/$info
275 [ -e $info ] || continue
276 [ $info -nt $texi ] || bogosities="$bogosities $info"
277 done < /tmp/el
279 rm -f /tmp/el
281 if [ x"${bogosities}" != x"" ]; then
282 error=yes
283 echo "The following .info files are older than their .texi files:"
284 echo "${bogosities}"
287 ## This exits with non-zero status if any .info files need
288 ## rebuilding.
289 if [ -e Makefile ]; then
290 echo "Checking to see if info files are up-to-date..."
291 make --question info || error=yes
294 if [ $error = yes ]; then
295 echo "Failed checks" >&2
296 exit 1
301 if [ $update = yes ]; then
303 ## Make sure configure is newer than configure.ac, etc.
304 ## It is better to let autoreconf do what is needed than
305 ## for us to try and duplicate all its checks.
306 echo "Running autoreconf"
307 autoreconf -i -I m4 || { x=$?; echo Autoreconf FAILED! >&2; exit $x; }
309 ## Make sure src/stamp-h.in is newer than configure.ac.
310 rm -f src/stamp-h.in
311 echo timestamp > src/stamp-h.in
313 echo "Updating Info files"
314 make info
316 echo "Updating finder, custom and autoload data"
317 (cd lisp && make updates EMACS="$EMACS")
319 echo "Updating leim-list.el"
320 (cd leim && make leim-list.el EMACS="$EMACS")
322 echo "Recompiling Lisp files"
323 $EMACS -batch -f batch-byte-recompile-directory lisp
324 fi # $update = yes
326 echo "Creating staging directory: '${tempparent}'"
328 mkdir ${tempparent}
329 tempdir="${tempparent}/${emacsname}"
331 ### This trap ensures that the staging directory will be cleaned up even
332 ### when the script is interrupted in mid-career.
333 if [ "${clean_up}" = yes ]; then
334 trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
337 echo "Creating top directory: '${tempdir}'"
338 mkdir ${tempdir}
340 if [ "$changelog" = yes ]; then
341 if test -d .git; then
342 echo "Making top-level ChangeLog"
343 make ChangeLog CHANGELOG=${tempdir}/ChangeLog || \
344 { x=$?; echo "make ChangeLog FAILED (try --no-changelog?)" >&2; exit $x; }
345 else
346 echo "No repository, so omitting top-level ChangeLog"
350 ### We copy in the top-level files before creating the subdirectories in
351 ### hopes that this will make the top-level files appear first in the
352 ### tar file; this means that people can start reading the INSTALL and
353 ### README while the rest of the tar file is still unpacking. Whoopee.
354 echo "Making links to top-level files"
355 ln INSTALL README BUGS ${tempdir}
356 ln ChangeLog.*[0-9] Makefile.in autogen.sh configure configure.ac ${tempdir}
357 ln config.bat make-dist .dir-locals.el ${tempdir}
358 ln aclocal.m4 CONTRIBUTE ${tempdir}
360 echo "Creating subdirectories"
361 for subdir in site-lisp \
362 leim leim/CXTERM-DIC leim/MISC-DIC leim/SKK-DIC \
363 build-aux build-aux/snippet \
364 src src/bitmaps lib lib-src oldXMenu lwlib \
365 nt nt/inc nt/inc/sys nt/inc/arpa nt/inc/netinet nt/icons \
366 `find etc lisp admin test -type d` \
367 doc doc/emacs doc/misc doc/man doc/lispref doc/lispintro \
368 info m4 modules modules/mod-test msdos \
369 nextstep nextstep/templates \
370 nextstep/Cocoa nextstep/Cocoa/Emacs.base \
371 nextstep/Cocoa/Emacs.base/Contents \
372 nextstep/Cocoa/Emacs.base/Contents/Resources \
373 nextstep/GNUstep \
374 nextstep/GNUstep/Emacs.base \
375 nextstep/GNUstep/Emacs.base/Resources
378 if [ "$with_tests" != "yes" ]; then
379 case $subdir in
380 test*|*/mod-test*) continue ;;
381 esac
384 ## site-lisp for in-place installs (?).
385 [ "$subdir" = "site-lisp" ] || [ -d "$subdir" ] || \
386 echo "WARNING: $subdir not found, making anyway"
387 echo " ${tempdir}/${subdir}"
388 mkdir ${tempdir}/${subdir}
389 done
391 echo "Making links to 'lisp' and its subdirectories"
392 files=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
393 -o -name 'README' \)`
395 ### Don't distribute site-init.el, site-load.el, or default.el.
396 for file in lisp/Makefile.in $files; do
397 case $file in
398 */site-init*|*/site-load*|*/default*) continue ;;
399 esac
400 ln $file $tempdir/$file
401 done
403 echo "Making links to 'leim' and its subdirectories"
404 (cd leim
405 ln ChangeLog.*[0-9] README ../${tempdir}/leim
406 ln CXTERM-DIC/README CXTERM-DIC/*.tit ../${tempdir}/leim/CXTERM-DIC
407 ln SKK-DIC/README SKK-DIC/SKK-JISYO.L ../${tempdir}/leim/SKK-DIC
408 ln MISC-DIC/README MISC-DIC/*.* ../${tempdir}/leim/MISC-DIC
409 ln Makefile.in ../${tempdir}/leim/Makefile.in
410 ln leim-ext.el ../${tempdir}/leim/leim-ext.el)
412 ## FIXME Can we not just use the "find -type f" method for this one?
413 echo "Making links to 'build-aux'"
414 (cd build-aux
415 ln compile config.guess config.sub depcomp msys-to-w32 ../${tempdir}/build-aux
416 ln gitlog-to-changelog gitlog-to-emacslog ../${tempdir}/build-aux
417 ln install-sh missing move-if-change ../${tempdir}/build-aux
418 ln update-copyright update-subdirs ../${tempdir}/build-aux
419 ln dir_top make-info-dir ar-lib ../${tempdir}/build-aux)
421 echo "Making links to 'build-aux/snippet'"
422 (cd build-aux/snippet
423 ln *.h ../../${tempdir}/build-aux/snippet)
425 echo "Making links to 'src'"
426 ### Don't distribute the configured versions of
427 ### config.in, paths.in, buildobj.h, or Makefile.in.
428 (cd src
429 echo " (It is ok if ln fails in some cases.)"
430 ln [a-zA-Z]*.[chm] ../${tempdir}/src
431 ln [a-zA-Z]*.in ../${tempdir}/src
432 ln deps.mk ../${tempdir}/src
433 ln README ChangeLog.*[0-9] ../${tempdir}/src
434 ln .gdbinit .dbxinit ../${tempdir}/src
435 cd ../${tempdir}/src
436 rm -f globals.h config.h epaths.h Makefile buildobj.h)
438 echo "Making links to 'src/bitmaps'"
439 (cd src/bitmaps
440 ln README *.xbm ../../${tempdir}/src/bitmaps)
442 echo "Making links to 'lib'"
443 (snippet_h=`(cd build-aux/snippet && ls *.h)`
444 cd lib
445 ln [a-zA-Z]*.[ch] ../${tempdir}/lib
446 ln gnulib.mk Makefile.am Makefile.in ../${tempdir}/lib
447 cd ../${tempdir}/lib
448 script='/[*]/d; s/\.in\.h$/.h/'
449 rm -f `(echo "$snippet_h"; ls *.in.h) | sed "$script"`)
451 echo "Making links to 'lib-src'"
452 (cd lib-src
453 ln [a-zA-Z]*.[ch] ../${tempdir}/lib-src
454 ln ChangeLog.*[0-9] Makefile.in README ../${tempdir}/lib-src
455 ln rcs2log ../${tempdir}/lib-src
456 ln update-game-score.exe.manifest ../${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.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`; do
542 case $f in
543 test/automated/*.log) continue ;;
544 test/automated/flymake/warnpred/a.out) continue ;;
545 test/automated/Makefile) continue ;;
546 esac
547 ln $f $tempdir/$f
548 done
551 echo "Making links to 'etc' and its subdirectories"
552 for f in `find etc -type f`; do
553 case $f in
554 etc/DOC*|etc/*.pyc) continue ;;
555 ## Arguably we should not exclude *.ps.
556 etc/refcards/*.aux|etc/refcards/*.dvi|etc/refcards/*.log|etc/refcards/*.ps)
557 continue ;;
558 esac
559 ln $f $tempdir/$f
560 done
562 echo "Making links to 'info'"
563 ln `find info -type f -print` ${tempdir}/info
565 echo "Making links to 'doc/emacs'"
566 (cd doc/emacs
567 ln *.texi *.in ChangeLog.*[0-9] ../../${tempdir}/doc/emacs)
569 echo "Making links to 'doc/misc'"
570 (cd doc/misc
571 ln *.texi *.tex *.in gnus-news.el ChangeLog.*[0-9] \
572 ../../${tempdir}/doc/misc)
574 echo "Making links to 'doc/lispref'"
575 (cd doc/lispref
576 ln *.texi *.in README ChangeLog.*[0-9] ../../${tempdir}/doc/lispref
577 ln spellfile ../../${tempdir}/doc/lispref
578 ln two-volume.make two-volume-cross-refs.txt ../../${tempdir}/doc/lispref)
580 echo "Making links to 'doc/lispintro'"
581 (cd doc/lispintro
582 ln *.texi *.in *.eps *.pdf ../../${tempdir}/doc/lispintro
583 ln README ChangeLog.*[0-9] ../../${tempdir}/doc/lispintro
584 cd ../../${tempdir}/doc/lispintro)
586 echo "Making links to 'doc/man'"
587 (cd doc/man
588 ln *.*[0-9] *.in ../../${tempdir}/doc/man
589 cd ../../${tempdir}/doc/man
590 rm -f emacs.1)
592 ### It would be nice if they could all be symlinks to top-level copy, but
593 ### you're not supposed to have any symlinks in distribution tar files.
594 echo "Making sure copying notices are all copies of 'COPYING'"
595 for subdir in . etc leim lib lib-src lisp lwlib msdos nt src; do
596 rm -f ${tempdir}/${subdir}/COPYING
597 cp COPYING ${tempdir}/${subdir}
598 done
600 if [ "${newer}" ]; then
601 printf '%s\n' "Removing files older than $newer"
602 ## We remove .elc files unconditionally, on the theory that anyone picking
603 ## up an incremental distribution already has a running Emacs to byte-compile
604 ## them with.
605 find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \;
608 ## Don't distribute backups, autosaves, etc.
609 echo "Removing unwanted files"
610 find ${tempparent} \( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \) -exec rm -f {} \;
612 if [ "${make_tar}" = yes ]; then
613 echo "Looking for $default_gzip"
614 found=0
615 temppath=`printf '%s\n' "$PATH" |
616 sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' -e 's/:/ /g'
618 for dir in ${temppath}; do
619 [ -x ${dir}/$default_gzip ] || continue
620 found=1; break
621 done
622 if [ "$found" = "0" ]; then
623 echo "WARNING: '$default_gzip' not found, will not compress" >&2
624 default_gzip=cat
626 case "${default_gzip}" in
627 bzip2) gzip_extension=.bz2 ;;
628 xz) gzip_extension=.xz ;;
629 gzip) gzip_extension=.gz ; default_gzip="gzip --best";;
630 *) gzip_extension= ;;
631 esac
632 echo "Creating tar file"
633 (cd ${tempparent} ; tar cvf - ${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