* build-aux/gitlog-to-emacslog: Handle empty generated ChangeLog.

[gnu-emacs] / build-aux / gitlog-to-emacslog

diff --git a/build-aux/gitlog-to-emacslog b/build-aux/gitlog-to-emacslog
index 0db91d52205239d15bbabe802d5d38a62ff5d89c..345c37f63dafefa40dc795fa9df806ec14e31e00 100755 (executable)
--- a/build-aux/gitlog-to-emacslog
+++ b/build-aux/gitlog-to-emacslog
@@ -2,7 +2,7 @@
 
 # Convert git log output to ChangeLog format for GNU Emacs.
 
-# Copyright (C) 2014-2015 Free Software Foundation, Inc.
+# Copyright (C) 2014-2016 Free Software Foundation, Inc.
 
 # Author: Paul Eggert
 
@@ -23,55 +23,83 @@ LC_ALL=C
 export LC_ALL
 
 # The newest revision that should not appear in the generated ChangeLog.
-gen_origin=2c1b8604946efbcd8ec5dd6c6dda7541ce4fc3c0
+gen_origin=
+
 force=
 output=ChangeLog
+nmax=2
 
 while [ $# -gt 0 ]; do
   case "$1" in
       -g|--gen-origin) gen_origin="$2" ; shift ;;
       -f|--force) force=1 ;;
+      -n|--nmax) nmax="$2"; shift ;;
       -o|--output) output="$2" ; shift ;;
-      *) echo "Unrecognized argument: $1" >&2; exit 1 ;;
+      *) printf '%s\n' "Unrecognized argument: $1" >&2; exit 1 ;;
   esac
   shift
 done
 
-if [ -f "${distprefix}$output" ]; then
-    [ ! "$force" ] && echo "${distprefix}$output exists" && exit 1
-    rm -f "${distprefix}$output" || exit 1
+if [ ! -f ChangeLog.$nmax ]; then
+    printf '%s\n' "Can't find ChangeLog.$nmax" >&2
+    printf '%s\n' "Must be run from the top source directory" >&2
+    exit 1
+fi
+
+# If not specified in the command line, get gen_origin from the existing
+# ChangeLog file.
+[ "$gen_origin" ] || {
+    gen_origin_line=`
+      grep -E '^commit [0-9a-f]+ [(]inclusive[)]' ChangeLog.$nmax
+    ` || {
+       printf '%s\n' "ChangeLog.$nmax lacks a 'commit ... (inclusive)' line" >&2
+       exit 1
+    }
+    set $gen_origin_line
+    gen_origin=$2
+}
+
+# Get the new value for gen_origin from the latest version in the repository.
+new_origin=`git log --pretty=format:%H 'HEAD^!'` || exit
+
+if [ -f "$output" ]; then
+    [ ! "$force" ] && printf '%s\n' "$output exists" >&2 && exit 1
+    rm -f "$output" || exit 1
 fi
 
 # If this is not a Git repository, just generate an empty ChangeLog.
-test -d ${srcprefix}.git || {
-  >"${distprefix}$output"
+test -d .git || {
+  >"$output"
   exit
 }
 
 # Use Gnulib's packaged ChangeLog generator.
-${srcprefix}build-aux/gitlog-to-changelog --ignore-matching='^; ' \
-  --format='%B' \
-  "$gen_origin.." >"${distprefix}ChangeLog.tmp" || exit
+# Maybe we should skip all "Merge branch 'master'" messages.
+# See eg the cairo-related ones.
+./build-aux/gitlog-to-changelog \
+    --ignore-matching="^; |^Merge branch '[^']*' of git\.(savannah|sv)\.gnu\.org:/srv/git/emacs|^Merge remote-tracking branch '.*'$" \
+  --ignore-line='^; ' --format='%B' \
+  "$gen_origin..$new_origin" >"ChangeLog.tmp" || exit
 
-if test -s "${distprefix}ChangeLog.tmp"; then
+if test -e "ChangeLog.tmp"; then
 
   # Fix up bug references.
   # This would be better as eg a --transform option to gitlog-to-changelog,
   # but... effort.  FIXME does not handle rare cases like:
   # Fixes: debbugs:19434 debbugs:19519
   sed 's/      Fixes: \(debbugs:\|bug#\)\([0-9][0-9]*\)/       (Bug#\2)/' \
-      "${distprefix}ChangeLog.tmp" > "${distprefix}ChangeLog.tmp2"
-  mv "${distprefix}ChangeLog.tmp2" "${distprefix}ChangeLog.tmp"
+      "ChangeLog.tmp" > "ChangeLog.tmp2"
+  mv "ChangeLog.tmp2" "ChangeLog.tmp"
 
   # Find the years covered by the generated ChangeLog, so that
   # a proper copyright notice can be output.
   years=`
-    sed -n 's/^\([0-9][0-9]*\).*/\1/p' "${distprefix}ChangeLog.tmp" |
+    sed -n 's/^\([0-9][0-9]*\).*/\1/p' "ChangeLog.tmp" |
     sort -nu
   `
   start_year=
   end_year=
-  for year in $years; do
+  for year in ${years:-`date +%Y`}; do
     : ${start_year:=$year}
     end_year=$year
   done
@@ -82,18 +110,26 @@ if test -s "${distprefix}ChangeLog.tmp"; then
     year_range=$start_year-$end_year
   fi
 
+  # Update gen_origin
+  if test "$gen_origin" != "$new_origin"; then
+      sed -n '
+        1i\
+
+        /^This file records repository revisions/p
+        s/^commit [0-9a-f]* (exclusive)/commit '"$gen_origin"' (exclusive)/p
+        s/^commit [0-9a-f]* (inclusive)/commit '"$new_origin"' (inclusive)/p
+      ' <ChangeLog.$nmax >>"ChangeLog.tmp" || exit
+  fi
+
   # Append a proper copyright notice.
   sed -n '
-    1i\
-
-    /^See ChangeLog.1 for earlier/,${
-       s/ChangeLog\.1/ChangeLog.2/
+    /^See ChangeLog.[0-9]* for earlier/,${
+       s/ChangeLog\.[0-9]*/ChangeLog.'$nmax'/
        s/\(Copyright[ (C)]*\)[0-9]*-[0-9]*/\1'"$year_range"'/
        p
     }
-  ' <ChangeLog.2 >>"${distprefix}ChangeLog.tmp" || exit
+  ' <ChangeLog.$nmax >>"ChangeLog.tmp" || exit
 fi
 
 # Install the generated ChangeLog.
-test "$output" = "ChangeLog.tmp" || \
-  mv -i "${distprefix}ChangeLog.tmp" "${distprefix}$output"
+test "$output" = "ChangeLog.tmp" || mv "ChangeLog.tmp" "$output"