2 ### make-dist: create an Emacs distribution tar file from current srcdir
4 ## Copyright (C) 1995, 1997-1998, 2000-2018 Free Software Foundation,
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/>.
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.
33 ### Exit if a command fails.
36 ### Print out each line we read, for debugging's sake.
43 export LANGUAGE LC_ALL LC_MESSAGES LANG
45 ## Remove unnecessary restrictions on file access.
58 while [ $# -gt 0 ]; do
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.
65 ## This option tells make-dist to make a tar file.
69 ## This option tells make-dist not to recompile or do analogous things.
73 ## This option says don't check for bad file names, etc.
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.
88 ## This option tells make-dist to use 'bzip2' instead of gzip.
106 ## Include the test/ directory.
107 ## This option is mainly for the hydra build server.
117 printf '%s\n' "Usage: ${progname} [options]"
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"
136 printf '%s\n' "${progname}: Unrecognized argument: $1" >&2
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
151 ### Find where to run Emacs.
152 ### (Accept only absolute file names.)
153 if [ $update = yes ];
157 EMACS
=`pwd`/src
/emacs
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
171 ### Find out which version of Emacs this is.
173 sed -n 's/^AC_INIT(GNU Emacs,[ ]*\([^ ,)]*\).*/\1/p' <configure.ac
175 if [ ! "${version}" ]; then
177 "${progname}: can't find current Emacs version in './src/emacs.c'" >&2
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"
191 ### Make sure we don't already have a directory emacs-${version}.
193 emacsname
="emacs-${version}${new_extension}"
195 if [ -d ${emacsname} ]
197 echo Directory
"${emacsname}" already exists
>&2
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
212 if [ $check = yes ]; then
214 echo "Sanity checking (use --no-check to disable this)..."
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
232 echo "The following .elc files have no corresponding .el files:"
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`
242 el
=`echo $elc | sed 's/c$//'`
243 [ -r $el ] ||
continue
244 [ $elc -nt $el ] || bogosities
="$bogosities $elc"
247 if [ x
"${bogosities}" != x
"" ]; then
249 echo "The following .elc files are older than their .el files:"
253 rm -f /tmp
/el
/tmp
/elc
/tmp
/elcel
/tmp
/elelc
256 for file in $losers; do
257 grep -q "no-byte-compile: t" $file && continue
259 site-init.el | site-load.el | site-start.el | default.el
) continue ;;
262 bogosities
="$file $bogosities"
265 if [ x
"${bogosities}" != x
"" ]; then
267 echo "The following .el files have no corresponding .elc files:"
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
278 info
=`sed -n 's/^@setfilename //p' $texi | sed 's|.*info/||'`
279 [ x
"${info}" != x
"" ] ||
continue
281 [ -r $info ] ||
continue
282 [ $info -nt $texi ] || bogosities
="$bogosities $info"
287 if [ x
"${bogosities}" != x
"" ]; then
289 echo "The following .info files are older than their .texi files:"
293 ## This exits with non-zero status if any .info files need
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?
303 if [ -r ChangeLog
]; then
304 if ! grep -q "Version $version released" ChangeLog
; then
305 echo "No release notice in ChangeLog"
309 echo "A release must have a ChangeLog"
315 if [ $error = yes ]; then
316 echo "Failed checks" >&2
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.
332 echo timestamp
> src
/stamp-h.
in
334 echo "Updating Info files"
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
347 echo "Creating staging directory: '${tempparent}'"
349 mkdir
${tempparent} ||
exit
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} ||
exit
362 if [ "$changelog" = yes ]; then
363 if test -r .git
; then
364 ## When making a release or pretest the ChangeLog should already
365 ## have been created and edited as needed. Don't ignore it.
366 if test -r ChangeLog
; then
367 echo "Using existing top-level ChangeLog"
368 top_level_ChangeLog
=ChangeLog
370 echo "Making top-level ChangeLog"
371 make ChangeLog CHANGELOG
=${tempdir}/ChangeLog || \
372 { x
=$?
; echo "make ChangeLog FAILED (try --no-changelog?)" >&2; exit $x; }
375 echo "No repository, so omitting top-level ChangeLog"
379 ### We copy in the top-level files before creating the subdirectories in
380 ### hopes that this will make the top-level files appear first in the
381 ### tar file; this means that people can start reading the INSTALL and
382 ### README while the rest of the tar file is still unpacking. Whoopee.
383 echo "Making links to top-level files"
386 ChangeLog.*[0-9] Makefile.in autogen.sh configure configure.ac
387 config.bat make-dist .dir-locals.el
388 aclocal.m4 CONTRIBUTE
390 ln $top_level $top_level_ChangeLog $tempdir ||
exit
392 echo "Creating subdirectories"
393 for subdir
in site-lisp \
394 leim leim
/CXTERM-DIC leim
/MISC-DIC leim
/SKK-DIC \
396 src src
/bitmaps lib lib-src oldXMenu lwlib \
397 nt nt
/inc nt
/inc
/sys nt
/inc
/arpa nt
/inc
/netinet nt
/icons \
398 `find etc lisp admin test -type d` \
399 doc
doc
/emacs
doc
/misc
doc
/man
doc
/lispref
doc
/lispintro \
400 info
m4 modules msdos \
401 nextstep nextstep
/templates \
402 nextstep
/Cocoa nextstep
/Cocoa
/Emacs.base \
403 nextstep
/Cocoa
/Emacs.base
/Contents \
404 nextstep
/Cocoa
/Emacs.base
/Contents
/Resources \
406 nextstep
/GNUstep
/Emacs.base \
407 nextstep
/GNUstep
/Emacs.base
/Resources
410 if [ "$with_tests" != "yes" ]; then
416 ## site-lisp for in-place installs (?).
417 [ "$subdir" = "site-lisp" ] ||
[ -d "$subdir" ] || \
418 echo "WARNING: $subdir not found, making anyway"
419 [ "$verbose" = "yes" ] && echo " ${tempdir}/${subdir}"
420 mkdir
${tempdir}/${subdir} ||
exit
423 echo "Making links to 'lisp' and its subdirectories"
424 files
=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
425 -o -name 'README' \)` ||
exit
427 ### Don't distribute site-init.el, site-load.el, or default.el.
428 for file in lisp
/Makefile.
in $files; do
430 */site-init
*|
*/site-load
*|
*/default
*) continue ;;
432 ln $file $tempdir/$file ||
exit
435 echo "Making links to 'leim' and its subdirectories"
437 ln ChangeLog.
*[0-9] README ..
/${tempdir}/leim
&&
438 ln CXTERM-DIC
/README CXTERM-DIC
/*.tit ..
/${tempdir}/leim
/CXTERM-DIC
&&
439 ln SKK-DIC
/README SKK-DIC
/SKK-JISYO.L ..
/${tempdir}/leim
/SKK-DIC
&&
440 ln MISC-DIC
/README MISC-DIC
/*.
* ..
/${tempdir}/leim
/MISC-DIC
&&
441 ln Makefile.
in ..
/${tempdir}/leim
/Makefile.
in &&
442 ln leim-ext.el ..
/${tempdir}/leim
/leim-ext.el
&&
445 ## FIXME Can we not just use the "find -type f" method for this one?
446 echo "Making links to 'build-aux'"
448 ln config.guess config.sub msys-to-w32 ..
/${tempdir}/build-aux
&&
449 ln gitlog-to-changelog gitlog-to-emacslog ..
/${tempdir}/build-aux
&&
450 ln install-sh move-if-change ..
/${tempdir}/build-aux
&&
451 ln update-copyright update-subdirs ..
/${tempdir}/build-aux
&&
452 ln dir_top make-info-dir ..
/${tempdir}/build-aux
&&
455 echo "Making links to 'src'"
456 ### Don't distribute the configured versions of
457 ### config.in, paths.in, buildobj.h, or Makefile.in.
459 ln [a-zA-Z
]*.
[chm
] ..
/${tempdir}/src
&&
460 ln [a-zA-Z
]*.
in ..
/${tempdir}/src
&&
461 ln deps.mk ..
/${tempdir}/src
&&
462 ln README ChangeLog.
*[0-9] ..
/${tempdir}/src
&&
463 ln .gdbinit .dbxinit ..
/${tempdir}/src
&&
464 cd ..
/${tempdir}/src
&&
465 rm -f globals.h config.h epaths.h Makefile buildobj.h
&&
468 echo "Making links to 'src/bitmaps'"
470 ln README
*.xbm ..
/..
/${tempdir}/src
/bitmaps
&&
473 echo "Making links to 'lib'"
475 ln [a-zA-Z_
]*.
[ch
] ..
/${tempdir}/lib
&&
476 ln gnulib.mk.
in Makefile.
in ..
/${tempdir}/lib
&&
477 cd ..
/${tempdir}/lib
&&
478 script='/[*]/d; s/\.in\.h$/.h/' &&
479 rm -f `ls *.in.h | sed "$script"` &&
482 echo "Making links to 'lib-src'"
484 ln [a-zA-Z
]*.
[ch
] ..
/${tempdir}/lib-src
&&
485 ln ChangeLog.
*[0-9] Makefile.
in README ..
/${tempdir}/lib-src
&&
486 ln rcs2log ..
/${tempdir}/lib-src
&&
489 echo "Making links to 'm4'"
491 ln *.
m4 ..
/${tempdir}/m4 &&
494 echo "Making links to 'modules'"
496 ln *.py ..
/${tempdir}/modules
&&
499 echo "Making links to 'nt'"
501 ln emacs-x86.manifest emacs-x64.manifest ..
/${tempdir}/nt
&&
502 ln [a-z
]*.bat
[a-z
]*.
[ch
] ..
/${tempdir}/nt
&&
503 ln *.
in gnulib-cfg.mk ..
/${tempdir}/nt
&&
504 ln mingw-cfg.site epaths.nt INSTALL.W64 ..
/${tempdir}/nt
&&
505 ln ChangeLog.
*[0-9] INSTALL README README.W32 ..
/${tempdir}/nt
&&
508 echo "Making links to 'nt/inc' and its subdirectories"
509 for f
in `find nt/inc -type f -name '[a-z]*.h'`; do
510 ln $f $tempdir/$f ||
exit
513 echo "Making links to 'nt/icons'"
515 ln README
[a-z
]*.ico ..
/..
/${tempdir}/nt
/icons
&&
516 ln [a-z
]*.cur ..
/..
/${tempdir}/nt
/icons
&&
519 echo "Making links to 'msdos'"
521 ln ChangeLog.
*[0-9] INSTALL README emacs.ico emacs.pif ..
/${tempdir}/msdos
&&
522 ln depfiles.bat inttypes.h ..
/${tempdir}/msdos
&&
523 ln mainmake.v2
sed*.inp ..
/${tempdir}/msdos
&&
526 echo "Making links to 'nextstep'"
528 ln ChangeLog.
*[0-9] README INSTALL Makefile.
in ..
/${tempdir}/nextstep
&&
531 echo "Making links to 'nextstep/templates'"
532 (cd nextstep
/templates
&&
533 ln Emacs.desktop.
in Info-gnustep.plist.
in Info.plist.
in InfoPlist.
strings.
in \
534 ..
/..
/${tempdir}/nextstep
/templates
&&
537 echo "Making links to 'nextstep/Cocoa/Emacs.base/Contents'"
538 (cd nextstep
/Cocoa
/Emacs.base
/Contents
&&
539 ln PkgInfo ..
/..
/..
/..
/${tempdir}/nextstep
/Cocoa
/Emacs.base
/Contents
&&
542 echo "Making links to 'nextstep/Cocoa/Emacs.base/Contents/Resources'"
543 (cd nextstep
/Cocoa
/Emacs.base
/Contents
/Resources
&&
544 ln Credits.html
*.icns \
545 ..
/..
/..
/..
/..
/${tempdir}/nextstep
/Cocoa
/Emacs.base
/Contents
/Resources
&&
548 echo "Making links to 'nextstep/GNUstep/Emacs.base/Resources'"
549 (cd nextstep
/GNUstep
/Emacs.base
/Resources
&&
550 ln README emacs.tiff \
551 ..
/..
/..
/..
/${tempdir}/nextstep
/GNUstep
/Emacs.base
/Resources
&&
554 echo "Making links to 'oldXMenu'"
556 ln *.
[ch
] *.
in *.mk ..
/${tempdir}/oldXMenu
&&
557 ln README ChangeLog.
*[0-9] ..
/${tempdir}/oldXMenu
&&
560 echo "Making links to 'lwlib'"
562 ln *.
[ch
] *.
in *.mk ..
/${tempdir}/lwlib
&&
563 ln README ChangeLog.
*[0-9] ..
/${tempdir}/lwlib
&&
566 ## It is important to distribute admin/ because it contains sources
567 ## for generated lisp/international/uni-*.el files.
568 echo "Making links to 'admin' and its subdirectories"
569 for f
in `find admin -type f`; do
571 */Makefile
) [ -f $f.
in ] && continue ;;
573 ln $f $tempdir/$f ||
exit
576 if [ "$with_tests" = "yes" ]; then
577 echo "Making links to 'test' and its subdirectories"
578 for f
in `find test -type f ! -name '*.log' ! -name a.out \
579 ! -name '*.so' ! -name '*.dll' ! -name '*.o'
582 */Makefile
) [ -f $f.
in ] && continue ;;
584 ln $f $tempdir/$f ||
exit
588 echo "Making links to 'etc' and its subdirectories"
589 for f
in `find etc -type f`; do
591 etc
/DOC
*|etc
/*.pyc
) continue ;;
592 ## Arguably we should not exclude *.ps.
593 etc
/refcards
/*.aux|etc
/refcards
/*.dvi|etc
/refcards
/*.log|etc
/refcards
/*.ps
)
596 ln $f $tempdir/$f ||
exit
599 echo "Making links to 'info'"
600 ln `find info -type f -print` ${tempdir}/info ||
exit
602 echo "Making links to 'doc/emacs'"
604 ln *.texi
*.
in ChangeLog.
*[0-9] ..
/..
/${tempdir}/doc
/emacs
&&
607 echo "Making links to 'doc/misc'"
609 ln *.texi
*.tex
*.
in gnus-news.el ChangeLog.
*[0-9] \
610 ..
/..
/${tempdir}/doc
/misc
&&
613 echo "Making links to 'doc/lispref'"
615 ln *.texi
*.
in README ChangeLog.
*[0-9] ..
/..
/${tempdir}/doc
/lispref
&&
616 ln spellfile ..
/..
/${tempdir}/doc
/lispref
&&
617 ln two-volume.
make two-volume-cross-refs.txt ..
/..
/${tempdir}/doc
/lispref
&&
620 echo "Making links to 'doc/lispintro'"
622 ln *.texi
*.
in *.eps
*.pdf ..
/..
/${tempdir}/doc
/lispintro
&&
623 ln README ChangeLog.
*[0-9] ..
/..
/${tempdir}/doc
/lispintro
&&
624 cd ..
/..
/${tempdir}/doc
/lispintro
&&
627 echo "Making links to 'doc/man'"
629 ln *.
*[0-9] *.
in ..
/..
/${tempdir}/doc
/man
&&
630 cd ..
/..
/${tempdir}/doc
/man
&&
634 ### It would be nice if they could all be symlinks to top-level copy, but
635 ### you're not supposed to have any symlinks in distribution tar files.
636 echo "Making sure copying notices are all copies of 'COPYING'"
637 for subdir
in . etc leim lib lib-src lisp lwlib msdos nt src
; do
638 rm -f ${tempdir}/${subdir}/COPYING ||
exit
639 cp COPYING
${tempdir}/${subdir} ||
exit
642 if [ "${newer}" ]; then
643 printf '%s\n' "Removing files older than $newer"
644 ## We remove .elc files unconditionally, on the theory that anyone picking
645 ## up an incremental distribution already has a running Emacs to byte-compile
647 find ${tempparent} \
( -name '*.elc' -o ! -newer ${newer} \
) \
648 -exec rm -f {} \
; ||
exit
651 ## Don't distribute backups, autosaves, etc.
652 echo "Removing unwanted files"
653 find ${tempparent} \
( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \
) -exec rm -f {} \
; ||
exit
655 if [ "${make_tar}" = yes ]; then
656 echo "Looking for $default_gzip"
658 temppath
=`printf '%s\n' "$PATH" |
659 sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' -e 's/:/ /g'
661 for dir
in ${temppath}; do
662 [ -x ${dir}/$default_gzip ] ||
continue
665 if [ "$found" = "0" ]; then
666 echo "WARNING: '$default_gzip' not found, will not compress" >&2
669 case "${default_gzip}" in
670 bzip2) gzip_extension
=.bz2
;;
671 xz
) gzip_extension
=.xz
;;
672 gzip) gzip_extension
=.gz
; default_gzip
="gzip --best --no-name";;
673 *) gzip_extension
= ;;
675 echo "Creating tar file"
676 taropt
='--numeric-owner --owner=0 --group=0 --mode=go+u,go-w'
677 tar --sort=name
-cf /dev
/null
$tempparent/$emacsname/src
/lisp.h
2>/tmp
/out
&&
678 taropt
="$taropt --sort=name"
679 [ "$verbose" = "yes" ] && taropt
="$taropt --verbose"
682 case $default_gzip in
683 cat) tar $taropt -cf - $emacsname;;
684 *) if tar $taropt -cf /dev
/null
--use-compress-program="$default_gzip" \
685 $emacsname/src
/lisp.h
687 tar $taropt -cf - --use-compress-program="$default_gzip" $emacsname
689 tar $taropt -cf $emacsname.
tar $emacsname &&
690 $default_gzip <$emacsname.
tar
693 ) >$emacsname.
tar$gzip_extension ||
exit
696 if [ "${clean_up}" != yes ]; then
697 (cd ${tempparent} && mv ${emacsname} ..
) &&
701 ### make-dist ends here