admin/update_autogen

   1 #!/bin/bash
   2 ### update_autogen - update some auto-generated files in the Emacs tree
   3
   4 ## Copyright (C) 2011-2014 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 [ -d .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 -I: also update info/dir.
  73 -L: also update ldefs-boot.el.
  74 -C: start from a clean state.  Slower, but more correct.
  75 EOF
  76     exit 1
  77 }
  78
  79
  80 ## Defaults.
  81
  82 force=
  83 commit=
  84 quiet=
  85 clean=
  86 autogendir=                     # was "autogen"
  87 ldefs_flag=1
  88 lboot_flag=
  89 info_flag=
  90
  91 ## Parameters.
  92 ldefs_in=lisp/loaddefs.el
  93 ldefs_out=lisp/ldefs-boot.el
  94 sources="configure.ac lib/Makefile.am"
  95 ## Files to copy into autogendir.
  96 ## Everything:
  97 genfiles="
  98   configure aclocal.m4 src/config.in lib/Makefile.in
  99   build-aux/compile build-aux/config.guess build-aux/config.sub
 100   build-aux/depcomp build-aux/install-sh build-aux/missing
 101 "
 102 ## msdos-only:
 103 genfiles="src/config.in lib/Makefile.in"
 104
 105 for g in $genfiles; do
 106     basegen="$basegen ${g##*/}"
 107 done
 108
 109 [ "$basegen" ] || die "internal error"
 110
 111 tempfile=/tmp/$PN.$$
 112
 113 trap "rm -f $tempfile 2> /dev/null" EXIT
 114
 115
 116 while getopts ":hcfqA:CIL" option ; do
 117     case $option in
 118         (h) usage ;;
 119
 120         (c) commit=1 ;;
 121
 122         (f) force=1 ;;
 123
 124         (q) quiet=1 ;;
 125
 126         (A) autogendir=$OPTARG
 127             [ -d "$autogendir" ] || die "No autogen directory: $autogendir"
 128             ;;
 129
 130         (C) clean=1 ;;
 131
 132         (I) info_flag=1 ;;
 133
 134         (L) lboot_flag=1 ;;
 135
 136         (\?) die "Bad option -$OPTARG" ;;
 137
 138         (:) die "Option -$OPTARG requires an argument" ;;
 139
 140         (*) die "getopts error" ;;
 141     esac
 142 done
 143 shift $(( --OPTIND ))
 144 OPTIND=1
 145
 146
 147 ## Does not work 100% because a lot of Emacs batch output comes on stderr (?).
 148 [ "$quiet" ] && exec 1> /dev/null
 149
 150
 151 ## Run status on inputs, list modified files on stdout.
 152 status ()
 153 {
 154     local statflag="-S"
 155     [ "$vcs" = "git" ] && statflag="-s"
 156
 157     $vcs status $statflag "$@" >| $tempfile || die "$vcs status error for $@"
 158
 159     local stat file modified
 160
 161     while read stat file; do
 162
 163         [ "$stat" != "M" ] && \
 164             die "Unexpected status ($stat) for generated $file"
 165         modified="$modified $file"
 166
 167     done < $tempfile
 168
 169     echo "$modified"
 170
 171     return 0
 172 }                               # function status
 173
 174
 175 echo "Checking input file status..."
 176
 177 ## The lisp portion could be more permissive, eg only care about .el files.
 178 modified=$(status ${autogendir:+$sources} ${ldefs_flag:+lisp} ${info_flag:+doc}) || die
 179
 180 [ "$modified" ] && {
 181     echo "Locally modified: $modified"
 182     [ "$force" ] || die "There are local modifications"
 183 }
 184
 185
 186 ## Probably this is overkill, and there's no need to "bootstrap" just
 187 ## for making autoloads.
 188 [ "$clean" ] && {
 189
 190     echo "Running 'make maintainer-clean'..."
 191
 192     make maintainer-clean #|| die "Cleaning error"
 193
 194     rm -f $ldefs_in
 195 }
 196
 197
 198 echo "Running autoreconf..."
 199
 200 autoreconf ${clean:+-f} -i -I m4 2>| $tempfile
 201
 202 retval=$?
 203
 204 ## Annoyingly, autoreconf puts the "installing `./foo' messages on stderr.
 205 if [ "$quiet" ]; then
 206     grep -v 'installing `\.' $tempfile 1>&2
 207 else
 208     cat "$tempfile" 1>&2
 209 fi
 210
 211 [ $retval -ne 0 ] && die "autoreconf error"
 212
 213
 214 ## Uses global $commit.
 215 commit ()
 216 {
 217     local type=$1
 218     shift
 219
 220     [ $# -gt 0 ] || {
 221         echo "No files were modified"
 222         return 0
 223     }
 224
 225     echo "Modified file(s): $@"
 226
 227     [ "$commit" ] || return 0
 228
 229     echo "Committing..."
 230
 231     $vcs commit -m "Auto-commit of $type files." "$@" || return $?
 232
 233     [ "$vcs" = "git" ] && {
 234         $vcs push || return $?
 235     }
 236
 237     echo "Committed files: $@"
 238 }                               # function commit
 239
 240
 241 ## No longer used since info/dir is now generated at install time if needed,
 242 ## and is not in the repository any more.
 243 info_dir ()
 244 {
 245     local basefile=build-aux/dir_top outfile=info/dir
 246
 247     echo "Regenerating info/dir..."
 248
 249     ## Header contains non-printing characters, so this is more
 250     ## reliable than using echo.
 251     rm -f $outfile
 252     cp $basefile $outfile
 253
 254     local topic file dircat dirent
 255
 256     ## FIXME inefficient looping.
 257     for topic in "Texinfo documentation system" "Emacs" "GNU Emacs Lisp" \
 258         "Emacs editing modes" "Emacs network features" "Emacs misc features" \
 259         "Emacs lisp libraries"; do
 260
 261         cat - <<EOF >> $outfile
 262
 263 $topic
 264 EOF
 265         ## Bit faster than doc/*/*.texi.
 266         for file in doc/emacs/emacs.texi doc/lispintro/*.texi \
 267             doc/lispref/elisp.texi doc/misc/*.texi; do
 268
 269             ## FIXME do not ignore w32 if OS is w32.
 270             case $file in
 271                 *-xtra.texi|*efaq-w32.texi) continue ;;
 272             esac
 273
 274             dircat=$(sed -n -e 's/@value{emacsname}/Emacs/' -e 's/^@dircategory //p' $file)
 275
 276             ## TODO warn about unknown topics (check-info in top-level
 277             ## Makefile does this).
 278             [ "$dircat" = "$topic" ] || continue
 279
 280             sed -n -e 's/@value{emacsname}/Emacs/' \
 281                 -e 's/@acronym{\([A-Z]*\)}/\1/' \
 282                 -e '/^@direntry/,/^@end direntry/ s/^\([^@]\)/\1/p' \
 283                 $file >> $outfile
 284
 285         done
 286     done
 287
 288     local modified
 289
 290     modified=$(status $outfile) || die
 291
 292     commit "info/dir" $modified || die "commit error"
 293 }                               # function info_dir
 294
 295
 296 [ "$autogendir" ] && {
 297
 298     oldpwd=$PWD
 299
 300     cp $genfiles $autogendir/
 301
 302     cd $autogendir || die "cd error for $autogendir"
 303
 304     echo "Checking status of generated files..."
 305
 306     modified=$(status $basegen) || die
 307
 308     ## bzr status output is always relative to top-level, not PWD.
 309     [ "$vcs" = "bzr" ] && cd $oldpwd
 310
 311     commit "generated" $modified || die "commit error"
 312
 313     exit 0
 314 }                               # $autogendir
 315
 316
 317 [ "$info_flag" ] && info_dir
 318
 319
 320 [ "$ldefs_flag" ] || exit 0
 321
 322
 323 echo "Finding loaddef targets..."
 324
 325 sed -n -e '/^AUTOGEN_VCS/,/^$/p' lisp/Makefile.in | \
 326     sed -e '/AUTOGEN_VCS/d' -e '/^$/d' -e 's/\\//' \
 327     >| $tempfile || die "sed error"
 328
 329 genfiles=
 330
 331 while read genfile; do
 332
 333     genfile=lisp/$genfile
 334     [ -r $genfile ] || die "Unable to read $genfile"
 335
 336     genfiles="$genfiles $genfile"
 337 done < $tempfile
 338
 339
 340 [ "$genfiles" ] || die "Error setting genfiles"
 341
 342
 343 [ -e Makefile ] || {
 344     echo "Running ./configure..."
 345
 346     ## Minimize required packages.
 347     ./configure --without-x || die "configure error"
 348 }
 349
 350
 351 ## Build the minimum needed to get the autoloads.
 352 echo "Running lib/ make..."
 353
 354 make -C lib "$@" all || die "make lib error"
 355
 356
 357 echo "Running src/ make..."
 358
 359 make -C src "$@" bootstrap-emacs || die "make src error"
 360
 361
 362 echo "Running lisp/ make..."
 363
 364 make -C lisp "$@" autoloads EMACS=../src/bootstrap-emacs || die "make src error"
 365
 366
 367 ## Ignore comment differences.
 368 [ ! "$lboot_flag" ] || \
 369     diff -q -I '^;' $ldefs_in $ldefs_out || \
 370     cp $ldefs_in $ldefs_out || die "cp ldefs_boot error"
 371
 372
 373 echo "Checking status of loaddef files..."
 374
 375 ## It probably would be fine to just check+commit lisp/, since
 376 ## making autoloads should not effect any other files.  But better
 377 ## safe than sorry.
 378 modified=$(status $genfiles $ldefs_out) || die
 379
 380
 381 commit "loaddefs" $modified || die "commit error"
 382
 383
 384 exit 0
 385
 386 ### update_autogen ends here