admin/update_autogen

   1 #!/bin/bash
   2 ### update_autogen - update some auto-generated files in the Emacs tree
   3
   4 ## Copyright (C) 2011-2013 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
  51 usage ()
  52 {
  53     cat 1>&2 <<EOF
  54 Usage: ${PN} [-f] [-c] [-q] [-A dir] [-L] [-C] [-- make-flags]
  55 Update some auto-generated files in the Emacs tree.
  56 By default, only does the versioned loaddefs-like files in lisp/.
  57 This requires a build.  Passes any non-option args to make (eg -- -j2).
  58 Options:
  59 -f: force an update even if the source files are locally modified.
  60 -c: if the update succeeds and the generated files are modified,
  61     commit them (caution).
  62 -q: be quiet; only give error messages, not status messages.
  63 -A: only update autotools files, copying into specified dir.
  64 -L: also update ldefs-boot.el.
  65 -C: start from a clean state.  Slower, but more correct.
  66 EOF
  67     exit 1
  68 }
  69
  70
  71 ## Defaults.
  72
  73 force=
  74 commit=
  75 quiet=
  76 clean=
  77 autogendir=                     # was "autogen"
  78 ldefs_flag=1
  79 lboot_flag=
  80
  81 ## Parameters.
  82 ldefs_in=lisp/loaddefs.el
  83 ldefs_out=lisp/ldefs-boot.el
  84 sources="configure.ac lib/Makefile.am"
  85 ## Files to copy into autogendir.
  86 ## Everything:
  87 genfiles="
  88   configure aclocal.m4 src/config.in lib/Makefile.in
  89   build-aux/compile build-aux/config.guess build-aux/config.sub
  90   build-aux/depcomp build-aux/install-sh build-aux/missing
  91 "
  92 ## msdos-only:
  93 genfiles="src/config.in lib/Makefile.in"
  94
  95 for g in $genfiles; do
  96     basegen="$basegen ${g##*/}"
  97 done
  98
  99 [ "$basegen" ] || die "internal error"
 100
 101 tempfile=/tmp/$PN.$$
 102
 103 trap "rm -f $tempfile 2> /dev/null" EXIT
 104
 105
 106 while getopts ":hcfqA:CL" option ; do
 107     case $option in
 108         (h) usage ;;
 109
 110         (c) commit=1 ;;
 111
 112         (f) force=1 ;;
 113
 114         (q) quiet=1 ;;
 115
 116         (A) autogendir=$OPTARG
 117             [ -d "$autogendir" ] || die "No autogen directory: $autogendir"
 118             ;;
 119
 120         (C) clean=1 ;;
 121
 122         (L) lboot_flag=1 ;;
 123
 124         (\?) die "Bad option -$OPTARG" ;;
 125
 126         (:) die "Option -$OPTARG requires an argument" ;;
 127
 128         (*) die "getopts error" ;;
 129     esac
 130 done
 131 shift $(( --OPTIND ))
 132 OPTIND=1
 133
 134
 135 ## Does not work 100% because a lot of Emacs batch output comes on stderr (?).
 136 [ "$quiet" ] && exec 1> /dev/null
 137
 138
 139 echo "Running bzr status..."
 140
 141 bzr status -S ${autogendir:+$sources} ${ldefs_flag:+lisp} >| $tempfile || \
 142     die "bzr status error for input files"
 143
 144 ## The lisp portion could be more permissive, eg only care about .el files.
 145 while read stat file; do
 146
 147     case $stat in
 148         M)
 149             echo "Locally modified: $file"
 150             [ "$force" ] || die "There are local modifications"
 151             ;;
 152
 153         *) die "Unexpected status ($stat) for $file" ;;
 154     esac
 155 done < $tempfile
 156
 157
 158 ## Probably this is overkill, and there's no need to "bootstrap" just
 159 ## for making autoloads.
 160 [ "$clean" ] && {
 161
 162     echo "Running 'make maintainer-clean'..."
 163
 164     make maintainer-clean #|| die "Cleaning error"
 165
 166     rm -f $ldefs_in
 167 }
 168
 169
 170 echo "Running autoreconf..."
 171
 172 autoreconf ${clean:+-f} -i -I m4 2>| $tempfile
 173
 174 retval=$?
 175
 176 ## Annoyingly, autoreconf puts the "installing `./foo' messages on stderr.
 177 if [ "$quiet" ]; then
 178     grep -v 'installing `\.' $tempfile 1>&2
 179 else
 180     cat "$tempfile" 1>&2
 181 fi
 182
 183 [ $retval -ne 0 ] && die "autoreconf error"
 184
 185
 186 ## Uses global $commit.
 187 commit ()
 188 {
 189     local type=$1
 190     shift
 191
 192     [ $# -gt 0 ] || {
 193         echo "No files were modified"
 194         return 0
 195     }
 196
 197     echo "Modified file(s): $@"
 198
 199     [ "$commit" ] || return 0
 200
 201     echo "Committing..."
 202
 203     ## bzr status output is always relative to top-level, not PWD.
 204     bzr commit -m "Auto-commit of $type files." "$@" || return $?
 205
 206     echo "Committed files: $@"
 207 }                               # function commit
 208
 209
 210 [ "$autogendir" ] && {
 211
 212     oldpwd=$PWD
 213
 214     cp $genfiles $autogendir/
 215
 216     cd $autogendir || die "cd error for $autogendir"
 217
 218     echo "Checking status of generated files..."
 219
 220     bzr status -S $basegen >| $tempfile || \
 221         die "bzr status error for generated files"
 222
 223     modified=
 224
 225     while read stat file; do
 226
 227         [ "$stat" != "M" ] && \
 228             die "Unexpected status ($stat) for generated $file"
 229
 230         modified="$modified $file"
 231
 232     done < $tempfile
 233
 234     cd $oldpwd
 235
 236     commit "generated" $modified || die "bzr commit error"
 237
 238     exit 0
 239 }                               # $autogendir
 240
 241
 242 [ "$ldefs_flag" ] || exit 0
 243
 244
 245 echo "Finding loaddef targets..."
 246
 247 sed -n -e '/^AUTOGEN_VCS/,/^$/ s/\\//p' lisp/Makefile.in | \
 248     sed '/AUTOGEN_VCS/d' >| $tempfile || die "sed error"
 249
 250 genfiles=
 251
 252 while read genfile; do
 253
 254     [ -r lisp/$genfile ] || die "Unable to read $genfile"
 255
 256     genfiles="$genfiles $genfile"
 257 done < $tempfile
 258
 259
 260 [ "$genfiles" ] || die "Error setting genfiles"
 261
 262
 263 [ -e Makefile ] || {
 264     echo "Running ./configure..."
 265
 266     ## Minimize required packages.
 267     ./configure --without-x || die "configure error"
 268 }
 269
 270
 271 ## Build the minimum needed to get the autoloads.
 272 echo "Running lib/ make..."
 273
 274 make -C lib "$@" all || die "make lib error"
 275
 276
 277 echo "Running src/ make..."
 278
 279 make -C src "$@" bootstrap-emacs || die "make src error"
 280
 281
 282 echo "Running lisp/ make..."
 283
 284 make -C lisp "$@" autoloads EMACS=../src/bootstrap-emacs || die "make src error"
 285
 286
 287 ## Ignore comment differences.
 288 [ ! "$lboot_flag" ] || \
 289     diff -q -I '^;' $ldefs_in $ldefs_out || \
 290     cp $ldefs_in $ldefs_out || die "cp ldefs_boot error"
 291
 292
 293 cd lisp
 294
 295 echo "Checking status of loaddef files..."
 296
 297 ## It probably would be fine to just check+commit lisp/, since
 298 ## making autoloads should not effect any other files.  But better
 299 ## safe than sorry.
 300 bzr status -S $genfiles ${ldefs_out#lisp/} >| $tempfile || \
 301     die "bzr status error for generated files"
 302
 303
 304 modified=
 305
 306 while read stat file; do
 307
 308     [ "$stat" != "M" ] && die "Unexpected status ($stat) for generated $file"
 309     modified="$modified $file"
 310
 311 done < $tempfile
 312
 313
 314 cd ../
 315
 316
 317 commit "loaddefs" $modified || die "bzr commit error"
 318
 319
 320 exit 0
 321
 322 ### update_autogen ends here