admin/update_autogen

   1 #!/usr/bin/env bash
   2 ### update_autogen - update some auto-generated files in the Emacs tree
   3
   4 ## Copyright (C) 2011-2017 Free Software Foundation, Inc.
   5
   6 ## Author: Glenn Morris <rgm@gnu.org>
   7
   8 ## This file is part of GNU Emacs.
   9
  10 ## GNU Emacs is free software: you can redistribute it and/or modify
  11 ## it under the terms of the GNU General Public License as published by
  12 ## the Free Software Foundation, either version 3 of the License, or
  13 ## (at your option) any later version.
  14
  15 ## GNU Emacs is distributed in the hope that it will be useful,
  16 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ## GNU General Public License for more details.
  19
  20 ## You should have received a copy of the GNU General Public License
  21 ## along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ### Commentary:
  24
  25 ## This is a helper script to update some generated files in the Emacs
  26 ## repository.  This is suitable for running from cron.
  27 ## Only Emacs maintainers need use this, so it uses bash features.
  28 ##
  29 ## By default, it updates the versioned loaddefs-like files in lisp,
  30 ## except ldefs-boot.el.
  31
  32 ### Code:
  33
  34 die ()                 # write error to stderr and exit
  35 {
  36     [ $# -gt 0 ] && echo "$PN: $@" >&2
  37     exit 1
  38 }
  39
  40 PN=${0##*/}                     # basename of script
  41 PD=${0%/*}
  42
  43 [ "$PD" = "$0" ] && PD=.        # if PATH includes PWD
  44
  45 ## This should be the admin directory.
  46 cd $PD
  47 cd ../
  48 [ -d admin ] || die "Could not locate admin directory"
  49
  50 if [ -d .bzr ]; then
  51     vcs=bzr
  52 elif [ -e .git ]; then
  53     vcs=git
  54 else
  55     die "Cannot determine vcs"
  56 fi
  57
  58
  59 usage ()
  60 {
  61     cat 1>&2 <<EOF
  62 Usage: ${PN} [-f] [-c] [-q] [-A dir] [-I] [-L] [-C] [-- make-flags]
  63 Update some auto-generated files in the Emacs tree.
  64 By default, only does the versioned loaddefs-like files in lisp/.
  65 This requires a build.  Passes any non-option args to make (eg -- -j2).
  66 Options:
  67 -f: force an update even if the source files are locally modified.
  68 -c: if the update succeeds and the generated files are modified,
  69     commit them (caution).
  70 -q: be quiet; only give error messages, not status messages.
  71 -A: only update autotools files, copying into specified dir.
  72 -H: also update ChangeLog.${changelog_n}
  73 -I: also update info/dir.
  74 -L: also update ldefs-boot.el.
  75 -C: start from a clean state.  Slower, but more correct.
  76 EOF
  77     exit 1
  78 }
  79
  80
  81 ## Defaults.
  82
  83 force=
  84 commit=
  85 quiet=
  86 clean=
  87 autogendir=                     # was "autogen"
  88 ldefs_flag=1
  89 lboot_flag=
  90 info_flag=
  91 changelog_flag=
  92
  93 ## Parameters.
  94 ldefs_in=lisp/loaddefs.el
  95 ldefs_out=lisp/ldefs-boot.el
  96 changelog_n=$(sed -n 's/CHANGELOG_HISTORY_INDEX_MAX *= *//p' Makefile.in)
  97 changelog_files="ChangeLog.$changelog_n"
  98 sources="configure.ac lib/Makefile.am"
  99 ## Files to copy into autogendir.
 100 ## Everything:
 101 genfiles="
 102   configure aclocal.m4 src/config.in
 103   build-aux/config.guess build-aux/config.sub
 104   build-aux/install-sh
 105 "
 106 ## msdos-only:
 107 genfiles="src/config.in"
 108
 109 for g in $genfiles; do
 110     basegen="$basegen ${g##*/}"
 111 done
 112
 113 [ "$basegen" ] || die "internal error"
 114
 115 tempfile=/tmp/$PN.$$
 116
 117 trap "rm -f $tempfile 2> /dev/null" EXIT
 118
 119
 120 while getopts ":hcfqA:HCIL" option ; do
 121     case $option in
 122         (h) usage ;;
 123
 124         (c) commit=1 ;;
 125
 126         (f) force=1 ;;
 127
 128         (q) quiet=1 ;;
 129
 130         (A) autogendir=$OPTARG
 131             [ -d "$autogendir" ] || die "No autogen directory: $autogendir"
 132             ;;
 133
 134         (C) clean=1 ;;
 135
 136         (H) changelog_flag=1 ;;
 137
 138         (I) info_flag=1 ;;
 139
 140         (L) lboot_flag=1 ;;
 141
 142         (\?) die "Bad option -$OPTARG" ;;
 143
 144         (:) die "Option -$OPTARG requires an argument" ;;
 145
 146         (*) die "getopts error" ;;
 147     esac
 148 done
 149 shift $(( --OPTIND ))
 150 OPTIND=1
 151
 152
 153 ## Does not work 100% because a lot of Emacs batch output comes on stderr (?).
 154 [ "$quiet" ] && exec 1> /dev/null
 155
 156
 157 ## Run status on inputs, list modified files on stdout.
 158 status ()
 159 {
 160     local statflag="-S"
 161     [ "$vcs" = "git" ] && statflag="-s"
 162
 163     $vcs status $statflag "$@" >| $tempfile || die "$vcs status error for $@"
 164
 165     local stat file modified
 166
 167     while read stat file; do
 168
 169         [ "$stat" != "M" ] && \
 170             die "Unexpected status ($stat) for generated $file"
 171         modified="$modified $file"
 172
 173     done < $tempfile
 174
 175     echo "$modified"
 176
 177     return 0
 178 }                               # function status
 179
 180
 181 echo "Checking input file status..."
 182
 183 ## The lisp portion could be more permissive, eg only care about .el files.
 184 modified=$(status ${autogendir:+$sources} ${ldefs_flag:+lisp} ${info_flag:+doc}) || die
 185
 186 [ "$modified" ] && {
 187     echo "Locally modified: $modified"
 188     [ "$force" ] || die "There are local modifications"
 189 }
 190
 191
 192 ## Probably this is overkill, and there's no need to "bootstrap" just
 193 ## for making autoloads.
 194 [ "$clean" ] && {
 195
 196     echo "Running 'make maintainer-clean'..."
 197
 198     make maintainer-clean #|| die "Cleaning error"
 199
 200     rm -f $ldefs_in
 201 }
 202
 203
 204 echo "Running autoreconf..."
 205
 206 autoreconf ${clean:+-f} -i -I m4 2>| $tempfile
 207
 208 retval=$?
 209
 210 ## Annoyingly, autoreconf puts the "installing `./foo' messages on stderr.
 211 if [ "$quiet" ]; then
 212     grep -v 'installing `\.' $tempfile 1>&2
 213 else
 214     cat "$tempfile" 1>&2
 215 fi
 216
 217 [ $retval -ne 0 ] && die "autoreconf error"
 218
 219
 220 ## Uses global $commit.
 221 commit ()
 222 {
 223     local type=$1
 224     shift
 225
 226     [ $# -gt 0 ] || {
 227         echo "No files were modified"
 228         return 0
 229     }
 230
 231     echo "Modified file(s): $@"
 232
 233     [ "$commit" ] || return 0
 234
 235     echo "Committing..."
 236
 237     $vcs commit -m "; Auto-commit of $type files." "$@" || return $?
 238
 239     [ "$vcs" = "git" ] && {
 240         ## In case someone else pushed something while we were working.
 241         $vcs pull --rebase || return $?
 242         $vcs push || return $?
 243     }
 244
 245     echo "Committed files: $@"
 246 }                               # function commit
 247
 248
 249 ## No longer used since info/dir is now generated at install time if needed,
 250 ## and is not in the repository any more.
 251 info_dir ()
 252 {
 253     local basefile=build-aux/dir_top outfile=info/dir
 254
 255     echo "Regenerating info/dir..."
 256
 257     ## Header contains non-printing characters, so this is more
 258     ## reliable than using echo.
 259     rm -f $outfile
 260     cp $basefile $outfile
 261
 262     local topic file dircat dirent
 263
 264     ## FIXME inefficient looping.
 265     for topic in "Texinfo documentation system" "Emacs" "GNU Emacs Lisp" \
 266         "Emacs editing modes" "Emacs network features" "Emacs misc features" \
 267         "Emacs lisp libraries"; do
 268
 269         cat - <<EOF >> $outfile
 270
 271 $topic
 272 EOF
 273         ## Bit faster than doc/*/*.texi.
 274         for file in doc/emacs/emacs.texi doc/lispintro/*.texi \
 275             doc/lispref/elisp.texi doc/misc/*.texi; do
 276
 277             ## FIXME do not ignore w32 if OS is w32.
 278             case $file in
 279                 *-xtra.texi|*efaq-w32.texi) continue ;;
 280             esac
 281
 282             dircat=$(sed -n -e 's/@value{emacsname}/Emacs/' -e 's/^@dircategory //p' $file)
 283
 284             ## TODO warn about unknown topics (check-info in top-level
 285             ## Makefile does this).
 286             [ "$dircat" = "$topic" ] || continue
 287
 288             sed -n -e 's/@value{emacsname}/Emacs/' \
 289                 -e 's/@acronym{\([A-Z]*\)}/\1/' \
 290                 -e '/^@direntry/,/^@end direntry/ s/^\([^@]\)/\1/p' \
 291                 $file >> $outfile
 292
 293         done
 294     done
 295
 296     local modified
 297
 298     modified=$(status $outfile) || die
 299
 300     commit "info/dir" $modified || die "commit error"
 301 }                               # function info_dir
 302
 303
 304 [ "$autogendir" ] && {
 305
 306     oldpwd=$PWD
 307
 308     cp $genfiles $autogendir/
 309
 310     cd $autogendir || die "cd error for $autogendir"
 311
 312     echo "Checking status of generated files..."
 313
 314     modified=$(status $basegen) || die
 315
 316     commit "generated" $modified || die "commit error"
 317
 318     exit 0
 319 }                               # $autogendir
 320
 321
 322 [ "$info_flag" ] && info_dir
 323
 324
 325 [ "$ldefs_flag" ] || exit 0
 326
 327
 328 echo "Finding loaddef targets..."
 329
 330 find lisp -name '*.el' -exec grep '^;.*generated-autoload-file:' {} + | \
 331     sed -e '/loaddefs\|esh-groups/d' -e 's|/[^/]*: "|/|' -e 's/"//g' \
 332     >| $tempfile || die "Error finding targets"
 333
 334 genfiles=
 335
 336 while read genfile; do
 337
 338     ## Or we can just use sort -u when making tempfile...
 339     case " $genfiles " in
 340         *" $genfile "*) continue ;;
 341     esac
 342
 343     [ -r $genfile ] || die "Unable to read $genfile"
 344
 345     genfiles="$genfiles $genfile"
 346 done < $tempfile
 347
 348
 349 [ "$genfiles" ] || die "Error setting genfiles"
 350
 351
 352 [ -e Makefile ] || {
 353     echo "Running ./configure..."
 354
 355     ## Minimize required packages.
 356     ./configure --without-x || die "configure error"
 357 }
 358
 359
 360 ## Build the minimum needed to get the autoloads.
 361 echo "Running lib/ make..."
 362
 363 make -C lib "$@" all || die "make lib error"
 364
 365
 366 echo "Running src/ make..."
 367
 368 make -C src "$@" bootstrap-emacs || die "make src error"
 369
 370
 371 echo "Running lisp/ make..."
 372
 373 make -C lisp "$@" autoloads EMACS=../src/bootstrap-emacs || die "make src error"
 374
 375
 376 ## Ignore comment differences.
 377 [ ! "$lboot_flag" ] || \
 378     diff -q -I '^;' $ldefs_in $ldefs_out || \
 379     cp $ldefs_in $ldefs_out || die "cp ldefs_boot error"
 380
 381
 382 echo "Checking status of loaddef files..."
 383
 384 ## It probably would be fine to just check+commit lisp/, since
 385 ## making autoloads should not effect any other files.  But better
 386 ## safe than sorry.
 387 modified=$(status $genfiles $ldefs_out) || die
 388
 389
 390 commit "loaddefs" $modified || die "commit error"
 391
 392
 393 ## Less important than the other stuff, so do it last.
 394 [ ! "$changelog_flag" ] || {
 395     make change-history-nocommit || die "make change-history error"
 396     modified=$(status $changelog_files) || die
 397     commit "ChangeLog" $modified || die "commit error"
 398 }
 399
 400
 401 exit 0
 402
 403 ### update_autogen ends here