make-dist

   1 #!/bin/sh
   2 ### make-dist: create an Emacs distribution tar file from current srcdir
   3
   4 ## Copyright (C) 1995, 1997-1998, 2000-2024 Free Software Foundation,
   5 ## Inc.
   6
   7 ## This file is part of GNU Emacs.
   8
   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.
  13
  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.
  18
  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/>.
  21
  22 ### Commentary:
  23
  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.
  28
  29 ### Code:
  30
  31 progname="$0"
  32
  33 ### Exit if a command fails.
  34 #set -e
  35
  36 ### Print out each line we read, for debugging's sake.
  37 #set -v
  38
  39 LANGUAGE=C
  40 LC_ALL=C
  41 LC_MESSAGES=
  42 LANG=
  43 export LANGUAGE LC_ALL LC_MESSAGES LANG
  44
  45 ## Remove unnecessary restrictions on file access.
  46 umask 022
  47
  48 update=yes
  49 check=yes
  50 clean_up=no
  51 make_tar=no
  52 default_gzip=gzip
  53 newer=""
  54 with_info=yes
  55 changelog=yes
  56 verbose=no
  57
  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
  64     ;;
  65     ## This option tells make-dist to make a tar file.
  66     "--tar" )
  67       make_tar=yes
  68     ;;
  69     ## This option tells make-dist not to recompile or do analogous things.
  70     "--no-update" )
  71       update=no
  72     ;;
  73     ## This option says don't check for bad file names, etc.
  74     "--no-check" )
  75       check=no
  76     ;;
  77     "--no-changelog" )
  78       changelog=no
  79     ;;
  80     ## This options tells make-dist to skip the info files.  This can
  81     ## be useful for creating a tarball purely for test purposes.
  82     "--no-info" )
  83       with_info=no
  84       ;;
  85     ## This option tells make-dist to make the distribution normally, then
  86     ## remove all files older than the given timestamp file.  This is useful
  87     ## for creating incremental or patch distributions.
  88     "--newer")
  89       newer="$2"
  90       new_extension=".new"
  91       shift
  92     ;;
  93     ## This option tells make-dist to use 'bzip2' instead of gzip.
  94     "--bzip2")
  95       default_gzip="bzip2"
  96     ;;
  97     ## Same with xz.
  98     "--xz")
  99       default_gzip="xz"
 100     ;;
 101     "--no-compress")
 102       default_gzip="cat"
 103     ;;
 104
 105     "--snapshot")
 106       clean_up=yes
 107       make_tar=yes
 108       update=no
 109      ;;
 110
 111     "--tests"|"--no-tests")
 112       echo "The option $1 no longer does anything"
 113      ;;
 114
 115
 116     "--verbose")
 117       verbose=yes
 118      ;;
 119
 120     "--help")
 121       printf '%s\n' "Usage: ${progname} [options]"
 122       echo ""
 123       echo "  --bzip2   use bzip2 instead of gzip"
 124       echo "  --clean-up        delete staging directories when done"
 125       echo "  --xz              use xz instead of gzip"
 126       echo "  --no-compress     don't compress"
 127       echo "  --newer=TIME      don't include files older than TIME"
 128       echo "  --no-check        don't check for bad file names etc."
 129       echo "  --no-update       don't recompile or do analogous things"
 130       echo "  --no-changelog    don't generate the top-level ChangeLog"
 131       echo "  --no-info         don't include info files"
 132       echo "  --snapshot        same as --clean-up --no-update --tar"
 133       echo "  --tar             make a tar file"
 134       echo "  --verbose         noisier output"
 135       echo ""
 136       exit 0
 137     ;;
 138
 139     * )
 140       printf '%s\n' "${progname}: Unrecognized argument: $1" >&2
 141       exit 1
 142     ;;
 143   esac
 144   shift
 145 done
 146
 147 ### Make sure we're running in the right place.
 148 if [ ! -d src -o ! -f src/lisp.h -o ! -d lisp -o ! -f lisp/subr.el ]; then
 149   printf '%s\n' "${progname}: Can't find 'src/lisp.h' and 'lisp/subr.el'." >&2
 150   printf '%s\n' "${progname} must be run in the top directory of the Emacs" >&2
 151   printf '%s\n' "distribution tree.  cd to that directory and try again." >&2
 152   exit 1
 153 fi
 154
 155 ### Find where to run Emacs.
 156 ### (Accept only absolute file names.)
 157 if [ $update = yes ];
 158 then
 159   if [ -f src/emacs ];
 160   then
 161     EMACS=`pwd`/src/emacs
 162   else
 163     case $EMACS in
 164       /*) ;;
 165       *)
 166         if [ ! -f "$EMACS" ]; then
 167           printf '%s\n' "$0: You must set the EMACS environment variable " \
 168                "to an absolute file name." 2>&1
 169           exit 1
 170         fi;;
 171     esac
 172   fi
 173 fi
 174
 175 ### Find out which version of Emacs this is.
 176 version=`
 177   sed -n 's/^AC_INIT(\[GNU Emacs],[      ]*\[\([^]]*\).*/\1/p' <configure.ac
 178 ` || version=
 179 if [ ! "${version}" ]; then
 180   printf '%s\n' \
 181     "${progname}: can't find current Emacs version in './src/emacs.c'" >&2
 182   exit 1
 183 fi
 184
 185 echo Version number is "$version"
 186
 187 if [ $update = yes ]; then
 188   if ! grep -q "tree holds version  *${version}" README; then
 189     echo "WARNING: README has the wrong version number"
 190     echo "Consider running M-x set-version from admin/admin.el"
 191     sleep 5
 192   fi
 193 fi
 194
 195 ### Make sure we don't already have a directory  emacs-${version}.
 196
 197 emacsname="emacs-${version}${new_extension}"
 198
 199 if [ -d ${emacsname} ]
 200 then
 201   echo Directory "${emacsname}" already exists >&2
 202   exit 1
 203 fi
 204
 205 ### Make sure the subdirectory is available.
 206 tempparent="make-dist.tmp.$$"
 207 if [ -d ${tempparent} ]; then
 208   printf '%s\n' "${progname}: staging directory '${tempparent}' already exists.
 209 Perhaps a previous invocation of '${progname}' failed to clean up after
 210 itself.  Check that directories whose names are of the form
 211 'make-dist.tmp.NNNNN' don't contain any important information, remove
 212 them, and try again." >&2
 213   exit 1
 214 fi
 215
 216 if [ $check = yes ]; then
 217
 218   echo "Sanity checking (use --no-check to disable this)..."
 219
 220   error=no
 221
 222   temp_el=/tmp/make-dist.tmp.$$
 223   temp_elc=$temp_el.1
 224   temp_elelc=$temp_el.2
 225   temp_elcel=$temp_el.3
 226
 227   ls -1 lisp/[a-zA-Z]*.el lisp/[a-z]*/[a-zA-Z0-9]*.el \
 228         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el \
 229         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.el > $temp_el
 230
 231   ls -1 lisp/[a-zA-Z]*.elc lisp/[a-z]*/[a-zA-Z0-9]*.elc \
 232         lisp/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc \
 233         lisp/[a-z]*/[a-z]*/[a-z]*/[a-zA-Z0-9]*.elc > $temp_elc
 234
 235   ## Check for .elc files with no corresponding .el file.
 236   sed 's/\.el$/.elc/' $temp_el > $temp_elelc
 237
 238   bogosities=`comm -13 $temp_elelc $temp_elc`
 239   if [ x"${bogosities}" != x"" ]; then
 240     error=yes
 241     echo "The following .elc files have no corresponding .el files:"
 242     echo "${bogosities}"
 243   fi
 244
 245   ### Check for .el files with no corresponding .elc file.
 246   sed 's/\.elc$/.el/' $temp_elc > $temp_elcel
 247   losers=`comm -23 $temp_el $temp_elcel`
 248
 249   bogosities=
 250   while read elc; do
 251       el=`echo $elc | sed 's/c$//'`
 252       [ -r "$el" ] || continue
 253       [ "$elc" -nt "$el" ] || bogosities="$bogosities $elc"
 254   done < $temp_elc
 255
 256   if [ x"${bogosities}" != x"" ]; then
 257       error=yes
 258       echo "The following .elc files are older than their .el files:"
 259       echo "${bogosities}"
 260   fi
 261
 262   rm -f $temp_el*
 263
 264   bogosities=
 265   for file in $losers; do
 266     grep -q "^;.*no-byte-compile: t" "$file" && continue
 267     case $file in
 268       site-init.el | site-load.el | site-start.el | default.el) continue ;;
 269     esac
 270
 271     bogosities="$file $bogosities"
 272
 273   done
 274   if [ x"${bogosities}" != x"" ]; then
 275     error=yes
 276     echo "The following .el files have no corresponding .elc files:"
 277     echo "${bogosities}"
 278   fi
 279
 280
 281   ## This is only a crude check, eg it does not handle .info
 282   ## files with multiple .texi source files.
 283   find doc -name '*.texi' > $temp_el
 284
 285   bogosities=
 286   while read texi; do
 287       info=`sed -n 's/^@setfilename //p' $texi | sed 's|.*info/||'`
 288       [ x"${info}" != x"" ] || continue
 289       info=info/$info
 290       [ -r "$info" ] || continue
 291       [ "$info" -nt "$texi" ] || bogosities="$bogosities $info"
 292   done < $temp_el
 293
 294   rm -f $temp_el
 295
 296   if [ x"${bogosities}" != x"" ]; then
 297     error=yes
 298     echo "The following .info files are older than their .texi files:"
 299     echo "${bogosities}"
 300   fi
 301
 302   ## Is this a release?
 303   case $version in
 304       [1-9][0-9].[0-9])
 305           if [ -r ChangeLog ]; then
 306               if ! grep -q "Version $version released" ChangeLog; then
 307                   echo "No release notice in ChangeLog"
 308                   error=yes
 309               fi
 310           else
 311               echo "A release must have a ChangeLog"
 312               error=yes
 313           fi
 314       ;;
 315   esac
 316
 317   if [ $error = yes ]; then
 318       echo "Failed checks" >&2
 319       exit 1
 320   fi
 321
 322 fi
 323
 324 if [ $update = yes ]; then
 325
 326   ## Make sure configure is newer than configure.ac, etc.
 327   ## It is better to let autoreconf do what is needed than
 328   ## for us to try and duplicate all its checks.
 329   echo "Running autoreconf"
 330   autoreconf -i -I m4 || { x=$?; echo Autoreconf FAILED! >&2; exit $x; }
 331
 332   if [ "$make_info" = yes ] ; then
 333     echo "Updating Info files"
 334     make info
 335   fi
 336
 337   echo "Updating finder, custom and autoload data"
 338   (cd lisp && make updates EMACS="$EMACS")
 339
 340   echo "Updating leim-list.el"
 341   (cd leim && make leim-list.el EMACS="$EMACS")
 342
 343   echo "Recompiling Lisp files"
 344   $EMACS -batch -f batch-byte-recompile-directory lisp
 345 fi                              # $update = yes
 346
 347 if [ "$changelog" = yes ] && [ -r .git ]; then
 348   top_level_ChangeLog=ChangeLog
 349 else
 350   top_level_ChangeLog=
 351 fi
 352
 353 # Files to distribute that might not be under version control.
 354 # Don't distribute site-init.el, site-load.el, or default.el.
 355 possibly_non_vc_files="
 356   $top_level_ChangeLog
 357   MANIFEST aclocal.m4 configure
 358   admin/charsets/jisx2131-filter
 359   src/config.in
 360   exec/configure exec/config.h.in
 361   exec/config.sub exec/config.guess
 362   exec/install-sh
 363   leim/small-ja-dic-option
 364 "$(
 365   find admin doc etc lisp \
 366    \( -name '*.el' -o -name '*.elc' -o -name '*.map' -o -name '*.stamp' \
 367       -o -name '*.texi' -o -name '*.tex' -o -name '*.txt' -o -name '*.pdf' \) \
 368    ! -name 'site-init*' ! -name 'site-load*' ! -name 'default*'
 369 ) || exit
 370
 371 if [ $with_info = yes ]; then
 372   info_files="info/dir $(echo info/*.info)" || exit
 373 else
 374   info_files=
 375 fi
 376
 377 echo "Creating staging directory: '${tempparent}'"
 378
 379 mkdir ${tempparent} || exit
 380 tempdir="${tempparent}/${emacsname}"
 381
 382 manifest=MANIFEST
 383
 384 [ -f $manifest ] || manifest=${tempparent}/MANIFEST
 385
 386 # If Git is in use update the file MANIFEST, which can substitute for
 387 # 'git ls-files' later (e.g., after extraction from a tarball).
 388 # Otherwise, rely on the existing MANIFEST, which should be maintained some
 389 # other way when adding or deleting a distributed file while not using Git.
 390 # TODO: maybe this should ignore $update, and always update MANIFEST
 391 # if .git is present.
 392 # Filter out the files in msdos/autogen/, as they aren't useful in the
 393 # tarball, and get in the way during the build of the MSDOS port.
 394 if ( [ $update = yes ] || [ ! -f $manifest ] ) && [ -r .git ]; then
 395   echo "Updating $manifest"
 396   git ls-files | sed -e '/^msdos\/autogen\//d' > $manifest || exit
 397   printf '%s\n' $possibly_non_vc_files $info_files >>$manifest || exit
 398   sort -u -o $manifest $manifest || exit
 399 fi
 400
 401 <$manifest || exit
 402
 403 ### This trap ensures that the staging directory will be cleaned up even
 404 ### when the script is interrupted in mid-career.
 405 if [ "${clean_up}" = yes ]; then
 406   trap "echo 'Cleaning up the staging directory'; rm -rf ${tempparent}" EXIT
 407 fi
 408
 409 echo "Creating top directory: '${tempdir}'"
 410 if [ $verbose = yes ] && (mkdir --verbose ${tempdir}) >/dev/null 2>&1; then
 411   mkdir_verbose='mkdir --verbose'
 412 else
 413   mkdir $tempdir || exit
 414   mkdir_verbose="mkdir"
 415 fi
 416
 417 # file_to_skip is normally empty to link every file,
 418 # but it can be 'ChangeLog' if we do not want to link the
 419 # top-level ChangeLog.
 420 file_to_skip=
 421
 422 if [ "$changelog" = yes ]; then
 423   if test -r .git; then
 424     ## When making a release or pretest the ChangeLog should already
 425     ## have been created and edited as needed.  Don't ignore it.
 426     if [ -r ChangeLog ] && [ ! -L ChangeLog ]; then
 427       echo "Using existing top-level ChangeLog"
 428     else
 429       echo "Making top-level ChangeLog"
 430       make ChangeLog CHANGELOG=${tempdir}/ChangeLog || \
 431         { x=$?; echo "make ChangeLog FAILED (try --no-changelog?)" >&2; exit $x; }
 432       file_to_skip=ChangeLog
 433     fi
 434   else
 435     echo "No repository, so omitting top-level ChangeLog"
 436   fi
 437 fi
 438
 439 echo "Creating subdirectories"
 440 MANIFEST_subdir_sed='
 441   $a\
 442 '$tempdir'/info\
 443 '$tempdir'/site-lisp
 444   s,[^/]*$,,
 445   s,/$,,
 446   /^$/d
 447   s,^,'$tempdir'/,
 448 '
 449 tempsubdirs=$(sed "$MANIFEST_subdir_sed" $manifest | sort -u)
 450 $mkdir_verbose -p $tempsubdirs || exit
 451
 452 echo "Making links to files"
 453 while read file; do
 454   case $file in
 455     MANIFEST) ln $manifest $tempdir/MANIFEST || exit ;;
 456     $file_to_skip) continue ;;
 457     *) ln "$file" $tempdir/"$file" || exit ;;
 458   esac
 459 done <$manifest
 460
 461 if [ "${newer}" ]; then
 462   printf '%s\n' "Removing files older than $newer"
 463   ## We remove .elc files unconditionally, on the theory that anyone picking
 464   ## up an incremental distribution already has a running Emacs to byte-compile
 465   ## them with.
 466   find ${tempdir} \( -name '*.elc' -o ! -newer "${newer}" \) \
 467     -exec rm -f {} \; || exit
 468 fi
 469
 470 if [ "${make_tar}" = yes ]; then
 471   echo "Looking for $default_gzip"
 472   found=0
 473   temppath=`printf '%s\n' "$PATH" |
 474     sed -e 's/^:/.:/' -e 's/::/:.:/g' -e 's/:$/:./' -e 's/:/ /g'
 475   `
 476   for dir in ${temppath}; do
 477     [ -x "${dir}"/$default_gzip ] || continue
 478     found=1; break
 479   done
 480   if [ "$found" = "0" ]; then
 481     echo "WARNING: '$default_gzip' not found, will not compress" >&2
 482     default_gzip="cat"
 483   fi
 484   case "${default_gzip}" in
 485     bzip2) gzip_extension=.bz2 ;;
 486     xz)  gzip_extension=.xz ;;
 487     gzip)  gzip_extension=.gz ; default_gzip="gzip --best --no-name";;
 488        *)  gzip_extension= ;;
 489   esac
 490   echo "Creating tar file"
 491   taropt='--numeric-owner --owner=0 --group=0 --mode=go+u,go-w'
 492   tar -H ustar -cf /dev/null $tempdir/src/lisp.h 2>/dev/null &&
 493     taropt="$taropt -H ustar"
 494   tar --sort=name -cf /dev/null $tempdir/src/lisp.h 2>/dev/null &&
 495     taropt="$taropt --sort=name"
 496   [ "$verbose" = "yes" ] && taropt="$taropt --verbose"
 497
 498   (cd $tempparent &&
 499    case $default_gzip in
 500      cat) tar $taropt -cf - $emacsname;;
 501      *) if tar $taropt -cf /dev/null --use-compress-program="$default_gzip" \
 502                $emacsname/src/lisp.h > /dev/null 2>&1
 503         then
 504           tar $taropt -cf - --use-compress-program="$default_gzip" $emacsname
 505         else
 506           tar $taropt -cf $emacsname.tar $emacsname &&
 507           $default_gzip <$emacsname.tar
 508         fi;;
 509    esac
 510   ) >$emacsname.tar"$gzip_extension" || exit
 511 fi
 512
 513 ## Why are we deleting the staging directory if clean_up is no?
 514 if [ "${clean_up}" != yes ]; then
 515   (cd ${tempparent} && mv ${emacsname} ..) &&
 516   rm -rf ${tempparent}
 517 fi
 518
 519 # Local Variables:
 520 # sh-basic-offset: 2
 521 # End: