summaryrefslogtreecommitdiff
path: root/build-aux/gitlog-to-emacslog
blob: bced7e498611e9a3cf4ee73dbcdcb52156da99f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
#!/bin/sh

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

# Copyright (C) 2014-2017 Free Software Foundation, Inc.

# Author: Paul Eggert

# 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
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

LC_ALL=C
export LC_ALL

# The newest revision that should not appear in the generated ChangeLog.
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 ;;
      *) printf '%s\n' "Unrecognized argument: $1" >&2; exit 1 ;;
  esac
  shift
done

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 -r .git || {
  >"$output"
  exit
}

# Use Gnulib's packaged ChangeLog generator.
# 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 -r "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)/' \
      "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' "ChangeLog.tmp" |
    sort -nu
  `
  start_year=
  end_year=
  for year in ${years:-`date +%Y`}; do
    : ${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

  # 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 '
    /^See ChangeLog.[0-9]* for earlier/,${
       s/ChangeLog\.[0-9]*/ChangeLog.'$nmax'/
       s/\(Copyright[ (C)]*\)[0-9]*-[0-9]*/\1'"$year_range"'/
       p
    }
  ' <ChangeLog.$nmax >>"ChangeLog.tmp" || exit
fi

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