2 ### make-dist: create an Emacs distribution tar file from current srcdir
4 ## Copyright (C) 1995, 1997-1998, 2000-2013 Free Software Foundation, Inc.
6 ## This file is part of GNU Emacs.
8 ## GNU Emacs is free software: you can redistribute it and/or modify
9 ## it under the terms of the GNU General Public License as published by
10 ## the Free Software Foundation, either version 3 of the License, or
11 ## (at your option) any later version.
13 ## GNU Emacs is distributed in the hope that it will be useful,
14 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ## GNU General Public License for more details.
18 ## You should have received a copy of the GNU General Public License
19 ## along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ## This basically creates a duplicate directory structure, and then
24 ## hard links into it only those files that should be distributed.
25 ## This means that if you add a file with an odd name, you should make
26 ## sure that this script will include it.
32 ### Exit if a command fails.
35 ### Print out each line we read, for debugging's sake.
42 export LANGUAGE LC_ALL LC_MESSAGES LANG
44 ## Remove unnecessary restrictions on file access.
55 while [ $# -gt 0 ]; do
57 ## This option tells make-dist to delete the staging directory
58 ## when done. It is useless to use this unless you make a tar file.
62 ## This option tells make-dist to make a tar file.
66 ## This option tells make-dist not to recompile or do analogous things.
70 ## This option says don't check for bad file names, etc.
74 ## This option tells make-dist to make the distribution normally, then
75 ## remove all files older than the given timestamp file. This is useful
76 ## for creating incremental or patch distributions.
82 ## This option tells make-dist to use `bzip2' instead of gzip.
101 ## Include the test/ directory.
102 ## This option is mainly for the hydra build server.
108 echo "Usage: ${progname} [options]"
110 echo " --bzip2 use bzip2 instead of gzip"
111 echo " --clean-up delete staging directories when done"
112 echo " --xz use xz instead of gzip"
113 echo " --no-compress don't compress"
114 echo " --newer=TIME don't include files older than TIME"
115 echo " --no-check don't check for bad file names etc."
116 echo " --no-update don't recompile or do analogous things"
117 echo " --snapshot same as --clean-up --no-update --tar --no-check"
118 echo " --tar make a tar file"
119 echo " --tests include the test/ directory"
125 echo "${progname}: Unrecognized argument: $1" >&2
132 ### Make sure we're running in the right place.
133 if [ ! -d src
-o ! -f src
/lisp.h
-o ! -d lisp
-o ! -f lisp
/subr.el
]; then
134 echo "${progname}: Can't find \`src/lisp.h' and \`lisp/subr.el'." >&2
135 echo "${progname} must be run in the top directory of the Emacs" >&2
136 echo "distribution tree. cd to that directory and try again." >&2
140 ### Find where to run Emacs.
141 ### (Accept only absolute file names.)
142 if [ $update = yes ];
146 EMACS
=`pwd`/src
/emacs
151 if [ ! -f "$EMACS" ]; then
152 echo "$0: You must set the EMACS environment variable " \
153 "to an absolute file name." 2>&1
160 ### Find out which version of Emacs this is.
162 sed -n 's/^AC_INIT(emacs,[ ]*\([^ )]*\).*/\1/p' <configure.ac
164 if [ ! "${version}" ]; then
165 echo "${progname}: can't find current Emacs version in \`./src/emacs.c'" >&2
169 echo Version number is
$version
171 if [ $update = yes ]; then
172 if ! grep -q "@set EMACSVER *${version}" doc
/emacs
/emacsver.texi || \
173 ! grep -q "tree holds version *${version}" README
; then
174 echo "WARNING: README and/or emacsver.texi have the wrong version number"
175 echo "Consider running M-x set-version from admin/admin.el"
180 ### Make sure we don't already have a directory emacs-${version}.
182 emacsname
="emacs-${version}${new_extension}"
184 if [ -d ${emacsname} ]
186 echo Directory
"${emacsname}" already exists
>&2
190 ### Make sure the subdirectory is available.
191 tempparent
="make-dist.tmp.$$"
192 if [ -d ${tempparent} ]; then
193 echo "${progname}: staging directory \`${tempparent}' already exists.
194 Perhaps a previous invocation of \`${progname}' failed to clean up after
195 itself. Check that directories whose names are of the form
196 \`make-dist.tmp.NNNNN' don't contain any important information, remove
197 them, and try again." >&2
201 if [ $check = yes ]; then
202 ls -1 lisp
/[a-zA-Z
]*.el lisp
/[a-z
]*/[a-zA-Z0-9
]*.el \
203 lisp
/[a-z
]*/[a-z
]*/[a-zA-Z0-9
]*.el \
204 lisp
/[a-z
]*/[a-z
]*/[a-z
]*/[a-zA-Z0-9
]*.el \
205 leim
/[a-z
]*/[a-z
]*.el
> /tmp
/el
207 ls -1 lisp
/[a-zA-Z
]*.elc lisp
/[a-z
]*/[a-zA-Z0-9
]*.elc \
208 lisp
/[a-z
]*/[a-z
]*/[a-zA-Z0-9
]*.elc \
209 lisp
/[a-z
]*/[a-z
]*/[a-z
]*/[a-zA-Z0-9
]*.elc \
210 leim
/[a-z
]*/[a-z
]*.elc
> /tmp
/elc
212 ## Check for .elc files with no corresponding .el file.
213 sed 's/\.el$/.elc/' /tmp
/el
> /tmp
/elelc
215 bogosities
="`comm -13 /tmp/elelc /tmp/elc`"
216 if [ x
"${bogosities}" != x
"" ]; then
217 echo "The following .elc files have no corresponding .el files:"
221 ### Check for .el files with no corresponding .elc file.
222 sed 's/\.elc$/.el/' /tmp
/elc
> /tmp
/elcel
223 losers
="`comm -23 /tmp/el /tmp/elcel`"
225 rm -f /tmp
/el
/tmp
/elc
/tmp
/elcel
/tmp
/elelc
228 for file in $losers; do
229 grep -q "no-byte-compile: t" $file && continue
231 site-init.el | site-load.el | site-start.el | default.el
) continue ;;
234 bogosities
="$file $bogosities"
237 if [ x
"${bogosities}" != x
"" ]; then
238 echo "The following .el files have no corresponding .elc files:"
243 if [ $update = yes ]; then
245 ## Make sure configure is newer than configure.ac, etc.
246 ## It is better to let autoreconf do what is needed than
247 ## for us to try and duplicate all its checks.
248 echo "Running autoreconf"
249 autoreconf
-i -I m4 ||
{ x
=$?
; echo Autoreconf FAILED
! >&2; exit $x; }
251 ## Make sure src/stamp-h.in is newer than configure.ac.
253 echo timestamp
> src
/stamp-h.
in
255 echo "Updating Info files"
258 echo "Updating finder, custom and autoload data"
259 (cd lisp
&& make updates EMACS
="$EMACS")
261 echo "Updating leim-list.el"
262 (cd leim
&& make leim-list.el EMACS
="$EMACS")
264 echo "Recompiling Lisp files"
265 $EMACS -batch -f batch-byte-recompile-directory lisp leim
268 echo "Creating staging directory: \`${tempparent}'"
271 tempdir
="${tempparent}/${emacsname}"
273 ### This trap ensures that the staging directory will be cleaned up even
274 ### when the script is interrupted in mid-career.
275 if [ "${clean_up}" = yes ]; then
276 trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
279 echo "Creating top directory: \`${tempdir}'"
282 ### We copy in the top-level files before creating the subdirectories in
283 ### hopes that this will make the top-level files appear first in the
284 ### tar file; this means that people can start reading the INSTALL and
285 ### README while the rest of the tar file is still unpacking. Whoopee.
286 echo "Making links to top-level files"
287 ln INSTALL README BUGS
${tempdir}
288 ln ChangeLog Makefile.
in autogen.sh configure configure.ac
${tempdir}
289 ln config.bat make-dist .dir-locals.el
${tempdir}
290 ln aclocal.
m4 ${tempdir}
292 echo "Creating subdirectories"
293 for subdir
in site-lisp \
294 leim leim
/CXTERM-DIC leim
/MISC-DIC \
295 leim
/SKK-DIC leim
/ja-dic leim
/quail \
296 build-aux build-aux
/snippet \
297 src src
/bitmaps lib lib-src oldXMenu lwlib \
298 nt nt
/inc nt
/inc
/sys nt
/inc
/arpa nt
/inc
/netinet nt
/icons \
299 `find etc lisp admin test -type d` \
300 doc
doc
/emacs
doc
/misc
doc
/man
doc
/lispref
doc
/lispintro \
302 nextstep nextstep
/templates \
303 nextstep
/Cocoa nextstep
/Cocoa
/Emacs.base \
304 nextstep
/Cocoa
/Emacs.base
/Contents \
305 nextstep
/Cocoa
/Emacs.base
/Contents
/Resources \
307 nextstep
/GNUstep
/Emacs.base \
308 nextstep
/GNUstep
/Emacs.base
/Resources
311 if [ "$with_tests" != "yes" ]; then
317 ## site-lisp for in-place installs (?).
318 [ "$subdir" = "site-lisp" ] ||
[ -d "$subdir" ] || \
319 echo "WARNING: $subdir not found, making anyway"
320 echo " ${tempdir}/${subdir}"
321 mkdir
${tempdir}/${subdir}
324 echo "Making links to \`lisp' and its subdirectories"
325 files
=`find lisp \( -name '*.el' -o -name '*.elc' -o -name 'ChangeLog*' \
326 -o -name 'README' \)`
328 ### Don't distribute site-init.el, site-load.el, or default.el.
329 for file in lisp
/Makefile.
in lisp
/makefile.w32-in
$files; do
331 */site-init
*|
*/site-load
*|
*/default
*) continue ;;
333 ln $file $tempdir/$file
336 echo "Making links to \`leim' and its subdirectories"
338 ln makefile.w32-in ..
/${tempdir}/leim
339 ln ChangeLog README ..
/${tempdir}/leim
340 ln CXTERM-DIC
/README CXTERM-DIC
/*.tit ..
/${tempdir}/leim
/CXTERM-DIC
341 ln SKK-DIC
/README SKK-DIC
/SKK-JISYO.L ..
/${tempdir}/leim
/SKK-DIC
342 ln MISC-DIC
/README MISC-DIC
/*.
* ..
/${tempdir}/leim
/MISC-DIC
343 ln ja-dic
/*.el ja-dic
/*.elc ..
/${tempdir}/leim
/ja-dic
344 ln Makefile.
in ..
/${tempdir}/leim
/Makefile.
in
345 ln leim-ext.el ..
/${tempdir}/leim
/leim-ext.el
346 ## Lisp files that start with a capital (also 4Corner.el) are
347 ## generated from TIT dictionaries so we don't distribute them.
348 ln quail
/[a-z
]*.el quail
/[a-z
]*.elc ..
/${tempdir}/leim
/quail
349 rm -f ..
/${tempdir}/leim
/quail
/quick-b5.
*
350 rm -f ..
/${tempdir}/leim
/quail
/quick-cns.
*
351 rm -f ..
/${tempdir}/leim
/quail
/tsang-b5.
*
352 rm -f ..
/${tempdir}/leim
/quail
/tsang-cns.
*)
354 echo "Making links to \`build-aux'"
356 ln compile config.guess config.sub depcomp ..
/${tempdir}/build-aux
357 ln install-sh missing move-if-change update-subdirs ..
/${tempdir}/build-aux
)
359 echo "Making links to \`build-aux/snippet'"
360 (cd build-aux
/snippet
361 ln *.h ..
/..
/${tempdir}/build-aux
/snippet
)
363 echo "Making links to \`src'"
364 ### Don't distribute the configured versions of
365 ### config.in, paths.in, buildobj.h, or Makefile.in.
367 echo " (It is ok if ln fails in some cases.)"
368 ln [a-zA-Z
]*.
[chm
] ..
/${tempdir}/src
369 ln [a-zA-Z
]*.
in ..
/${tempdir}/src
370 ln [a-zA-Z
]*.mk ..
/${tempdir}/src
371 ln README ChangeLog ChangeLog.
*[0-9] ..
/${tempdir}/src
372 ln makefile.w32-in ..
/${tempdir}/src
373 ln .gdbinit .dbxinit ..
/${tempdir}/src
375 rm -f globals.h config.h epaths.h Makefile buildobj.h
)
377 echo "Making links to \`src/bitmaps'"
379 ln README
*.xbm ..
/..
/${tempdir}/src
/bitmaps
)
381 echo "Making links to \`lib'"
382 (snippet_h
=`(cd build-aux/snippet && ls *.h)`
384 ln [a-zA-Z
]*.
[ch
] ..
/${tempdir}/lib
385 ln gnulib.mk Makefile.am Makefile.
in makefile.w32-in ..
/${tempdir}/lib
387 script='/[*]/d; s/\.in\.h$/.h/'
388 rm -f `(echo "$snippet_h"; ls *.in.h) | sed "$script"`)
390 echo "Making links to \`lib-src'"
392 ln [a-zA-Z
]*.
[ch
] ..
/${tempdir}/lib-src
393 ln ChangeLog Makefile.
in README testfile ..
/${tempdir}/lib-src
394 ln grep-changelog rcs2log ..
/${tempdir}/lib-src
395 ln makefile.w32-in ..
/${tempdir}/lib-src
)
397 echo "Making links to \`m4'"
399 ln *.
m4 ..
/${tempdir}/m4)
401 echo "Making links to \`nt'"
403 ln emacs-x86.manifest emacs-x64.manifest emacs.rc ..
/${tempdir}/nt
404 ln config.nt emacsclient.rc emacs-src.tags ..
/${tempdir}/nt
405 ln nmake.defs gmake.defs subdirs.el
[a-z
]*.bat
[a-z
]*.
[ch
] ..
/${tempdir}/nt
406 ln Makefile.
in gnulib.mk ..
/${tempdir}/nt
407 ln mingw-cfg.site epaths.nt INSTALL.OLD ..
/${tempdir}/nt
408 ln ChangeLog INSTALL README README.W32 makefile.w32-in ..
/${tempdir}/nt
)
410 echo "Making links to \`nt/inc' and its subdirectories"
411 for f
in `find nt/inc -type f -name '[a-z]*.h'`; do
415 echo "Making links to \`nt/icons'"
417 ln README
[a-z
]*.ico ..
/..
/${tempdir}/nt
/icons
418 ln [a-z
]*.cur ..
/..
/${tempdir}/nt
/icons
)
420 echo "Making links to \`msdos'"
422 ln ChangeLog INSTALL README emacs.ico emacs.pif ..
/${tempdir}/msdos
423 ln depfiles.bat inttypes.h ..
/${tempdir}/msdos
424 ln is_exec.c sigaction.c mainmake.v2
sed*.inp ..
/${tempdir}/msdos
)
426 echo "Making links to \`nextstep'"
428 ln ChangeLog README INSTALL Makefile.
in ..
/${tempdir}/nextstep
)
430 echo "Making links to \`nextstep/templates'"
431 (cd nextstep
/templates
432 ln Emacs.desktop.
in Info-gnustep.plist.
in Info.plist.
in InfoPlist.
strings.
in ..
/..
/${tempdir}/nextstep
/templates
)
434 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents'"
435 (cd nextstep
/Cocoa
/Emacs.base
/Contents
436 ln PkgInfo ..
/..
/..
/..
/${tempdir}/nextstep
/Cocoa
/Emacs.base
/Contents
)
438 echo "Making links to \`nextstep/Cocoa/Emacs.base/Contents/Resources'"
439 (cd nextstep
/Cocoa
/Emacs.base
/Contents
/Resources
440 ln Credits.html
*.icns ..
/..
/..
/..
/..
/${tempdir}/nextstep
/Cocoa
/Emacs.base
/Contents
/Resources
)
442 echo "Making links to \`nextstep/GNUstep/Emacs.base/Resources'"
443 (cd nextstep
/GNUstep
/Emacs.base
/Resources
444 ln README emacs.tiff ..
/..
/..
/..
/${tempdir}/nextstep
/GNUstep
/Emacs.base
/Resources
)
446 echo "Making links to \`oldXMenu'"
448 ln *.
[ch
] *.
in ..
/${tempdir}/oldXMenu
449 ln README ChangeLog ..
/${tempdir}/oldXMenu
)
451 echo "Making links to \`lwlib'"
453 ln *.
[ch
] *.
in ..
/${tempdir}/lwlib
454 ln README ChangeLog ..
/${tempdir}/lwlib
)
456 ## It is important to distribute admin/ because it contains sources
457 ## for generated lisp/international/uni-*.el files.
458 echo "Making links to \`admin' and its subdirectories"
459 for f
in `find admin -type f`; do
461 admin
/unidata
/Makefile
) continue ;;
466 if [ "$with_tests" = "yes" ]; then
467 echo "Making links to \`test' and its subdirectories"
468 for f
in `find test -type f`; do
470 test
/automated
/flymake
/warnpred
/a.out
) continue ;;
471 test
/automated
/Makefile
) continue ;;
477 echo "Making links to \`etc' and its subdirectories"
478 for f
in `find etc -type f`; do
480 etc
/DOC
*|etc
/*.pyc
) continue ;;
481 ## Arguably we should not exclude *.ps.
482 etc
/refcards
/*.aux|etc
/refcards
/*.dvi|etc
/refcards
/*.log|etc
/refcards
/*.ps
)
488 echo "Making links to \`info'"
489 ln `find info -type f -print` ${tempdir}/info
491 echo "Making links to \`doc/emacs'"
493 ln *.texi
*.
in makefile.w32-in ChangeLog
* ..
/..
/${tempdir}/doc
/emacs
)
495 echo "Making links to \`doc/misc'"
497 ln *.texi
*.tex
*.
in makefile.w32-in gnus-news.el ChangeLog
* ..
/..
/${tempdir}/doc
/misc
)
499 echo "Making links to \`doc/lispref'"
501 ln *.texi
*.
in makefile.w32-in README ChangeLog
* ..
/..
/${tempdir}/doc
/lispref
502 ln spellfile ..
/..
/${tempdir}/doc
/lispref
503 ln two-volume.
make two-volume-cross-refs.txt ..
/..
/${tempdir}/doc
/lispref
)
505 echo "Making links to \`doc/lispintro'"
507 ln *.texi
*.
in makefile.w32-in
*.eps
*.pdf ..
/..
/${tempdir}/doc
/lispintro
508 ln README ChangeLog
* ..
/..
/${tempdir}/doc
/lispintro
509 cd ..
/..
/${tempdir}/doc
/lispintro
)
511 echo "Making links to \`doc/man'"
513 ln ChangeLog
* *.1 ..
/..
/${tempdir}/doc
/man
514 cd ..
/..
/${tempdir}/doc
/man
)
516 ### It would be nice if they could all be symlinks to top-level copy, but
517 ### you're not supposed to have any symlinks in distribution tar files.
518 echo "Making sure copying notices are all copies of \`COPYING'"
519 for subdir
in . etc info leim lib lib-src lisp lwlib msdos nt src
; do
520 rm -f ${tempdir}/${subdir}/COPYING
521 cp COPYING
${tempdir}/${subdir}
524 if [ "${newer}" ]; then
525 echo "Removing files older than $newer"
526 ## We remove .elc files unconditionally, on the theory that anyone picking
527 ## up an incremental distribution already has a running Emacs to byte-compile
529 find ${tempparent} \( -name '*.elc' -o ! -newer ${newer} \) -exec rm -f {} \
;
532 ## Don't distribute backups, autosaves, etc.
533 echo "Removing unwanted files"
534 find ${tempparent} \
( -name '*~' -o -name '#*#' -o -name '.*ignore' -o -name '=*' -o -name 'TAGS' \
) -exec rm -f {} \
;
536 if [ "${make_tar}" = yes ]; then
537 echo "Looking for $default_gzip"
539 temppath
=`echo $PATH | sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' \
541 for dir
in ${temppath}; do
542 [ -x ${dir}/$default_gzip ] ||
continue
545 if [ "$found" = "0" ]; then
546 echo "WARNING: \`$default_gzip' not found, will not compress" >&2
549 case "${default_gzip}" in
550 bzip2) gzip_extension
=.bz2
;;
551 xz
) gzip_extension
=.xz
;;
552 gzip) gzip_extension
=.gz
; default_gzip
="gzip --best";;
553 *) gzip_extension
= ;;
555 echo "Creating tar file"
556 (cd ${tempparent} ; tar cvf
- ${emacsname} ) \
558 > ${emacsname}.
tar${gzip_extension}
561 if [ "${clean_up}" != yes ]; then
562 (cd ${tempparent}; mv ${emacsname} ..
)
566 ### make-dist ends here