gitlog-to-emacslog 3.94 KB
Newer Older
1 2 3 4
#!/bin/sh

# Convert git log output to ChangeLog format for GNU Emacs.

Paul Eggert's avatar
Paul Eggert committed
5
# Copyright (C) 2014-2019 Free Software Foundation, Inc.
6

7 8
# Author: Paul Eggert

9 10 11 12 13 14 15 16 17 18 19
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
21 22 23 24

LC_ALL=C
export LC_ALL

25
# The newest revision that should not appear in the generated ChangeLog.
26 27
gen_origin=

28 29
force=
output=ChangeLog
30
nmax=2
31 32 33 34 35

while [ $# -gt 0 ]; do
  case "$1" in
      -g|--gen-origin) gen_origin="$2" ; shift ;;
      -f|--force) force=1 ;;
36
      -n|--nmax) nmax="$2"; shift ;;
37
      -o|--output) output="$2" ; shift ;;
38
      *) printf '%s\n' "Unrecognized argument: $1" >&2; exit 1 ;;
39 40 41 42
  esac
  shift
done

43
if [ ! -f ChangeLog.$nmax ]; then
44 45
    printf '%s\n' "Can't find ChangeLog.$nmax" >&2
    printf '%s\n' "Must be run from the top source directory" >&2
46 47 48
    exit 1
fi

49 50 51 52 53 54
# 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
    ` || {
55
	printf '%s\n' "ChangeLog.$nmax lacks a 'commit ... (inclusive)' line" >&2
56 57 58 59 60 61 62 63 64
	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

65
if [ -f "$output" ]; then
66
    [ ! "$force" ] && printf '%s\n' "$output exists" >&2 && exit 1
67
    rm -f "$output" || exit 1
68
fi
69 70

# If this is not a Git repository, just generate an empty ChangeLog.
71
test -r .git || {
72
  >"$output"
73 74 75 76
  exit
}

# Use Gnulib's packaged ChangeLog generator.
77 78 79
# Maybe we should skip all "Merge branch 'master'" messages.
# See eg the cairo-related ones.
./build-aux/gitlog-to-changelog \
80
    --ignore-matching="^; |^Merge branch '[^']*' of git\.(savannah|sv)\.gnu\.org:/srv/git/emacs|^Merge remote-tracking branch '.*'$" \
81
  --ignore-line='^; ' --format='%B' \
82
  "$gen_origin..$new_origin" >"ChangeLog.tmp" || exit
83

84
if test -r "ChangeLog.tmp"; then
85

86 87 88 89 90
  # 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)/' \
91 92
      "ChangeLog.tmp" > "ChangeLog.tmp2"
  mv "ChangeLog.tmp2" "ChangeLog.tmp"
93

94 95 96
  # Find the years covered by the generated ChangeLog, so that
  # a proper copyright notice can be output.
  years=`
97
    sed -n 's/^\([0-9][0-9]*\).*/\1/p' "ChangeLog.tmp" |
98 99 100 101
    sort -nu
  `
  start_year=
  end_year=
102
  for year in ${years:-`date +%Y`}; do
103 104 105 106 107 108 109 110 111 112
    : ${start_year:=$year}
    end_year=$year
  done

  if test "$start_year" = "$end_year"; then
    year_range=$start_year
  else
    year_range=$start_year-$end_year
  fi

113 114 115 116 117 118 119 120 121 122
  # 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
123

124 125
  # Append a proper copyright notice.
  sed -n '
126 127
    /^See ChangeLog.[0-9]* for earlier/,${
       s/ChangeLog\.[0-9]*/ChangeLog.'$nmax'/
128 129 130
       s/\(Copyright[ (C)]*\)[0-9]*-[0-9]*/\1'"$year_range"'/
       p
    }
131
  ' <ChangeLog.$nmax >>"ChangeLog.tmp" || exit
132 133 134
fi

# Install the generated ChangeLog.
135
test "$output" = "ChangeLog.tmp" || mv "ChangeLog.tmp" "$output"