mirror of git://git.gnupg.org/gnupg.git
Generate the ChangeLog from commit logs.
* scripts/gitlog-to-changelog: New script. Taken from gnulib. * scripts/git-log-fix: New file. * scripts/git-log-footer: New file. * scripts/git-hooks/commit-msg: New script. * autogen.sh: Install commit-msg hook for git. * doc/HACKING: Describe the ChangeLog policy. * ChangeLog: New file. * Makefile.am (EXTRA_DIST): Add new files. (gen-ChangeLog): New. (dist-hook): Run gen-ChangeLog. Rename all ChangeLog files to ChangeLog-2011.
This commit is contained in:
Werner Koch
parent
0137097fbb
commit
28c6cef128
File diff suppressed because it is too large
Load Diff
21
Makefile.am
21
Makefile.am
|
|
@ -22,7 +22,9 @@ ACLOCAL_AMFLAGS = -I m4 -I gl/m4
|
|||
AUTOMAKE_OPTIONS = dist-bzip2 no-dist-gzip
|
||||
DISTCHECK_CONFIGURE_FLAGS = --enable-symcryptrun --enable-mailto --enable-gpgtar
|
||||
|
||||
EXTRA_DIST = scripts/config.rpath autogen.sh README.SVN
|
||||
EXTRA_DIST = scripts/config.rpath autogen.sh README.SVN \
|
||||
ChangeLog-2011 po/ChangeLog-2011 scripts/ChangeLog-2011
|
||||
|
||||
DISTCLEANFILES = g10defs.h
|
||||
|
||||
if BUILD_GPGSM
|
||||
|
|
@ -77,9 +79,24 @@ SUBDIRS = m4 gl include jnlib common ${kbx} \
|
|||
dist_doc_DATA = README
|
||||
|
||||
|
||||
dist-hook:
|
||||
dist-hook: gen-ChangeLog
|
||||
echo "$(VERSION)" > $(distdir)/VERSION
|
||||
|
||||
|
||||
gen_start_date = 2011-12-01T06:00:00
|
||||
.PHONY: gen-ChangeLog
|
||||
gen-ChangeLog:
|
||||
if test -d $(top_srcdir)/.git; then \
|
||||
(cd $(top_srcdir) && \
|
||||
./scripts/gitlog-to-changelog \
|
||||
--amend=scripts/git-log-fix \
|
||||
--since=$(gen_start_date) ) > $(distdir)/cl-t; \
|
||||
cat $(top_srcdir)/scripts/git-log-footer >> $(distdir)/cl-t; \
|
||||
rm -f $(distdir)/ChangeLog; \
|
||||
mv $(distdir)/cl-t $(distdir)/ChangeLog; \
|
||||
fi
|
||||
|
||||
|
||||
stowinstall:
|
||||
$(MAKE) $(AM_MAKEFLAGS) install prefix=/usr/local/stow/gnupg
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-08-04 Werner Koch <wk@g10code.com>
|
||||
|
||||
* command.c (cmd_keyinfo, do_one_keyinfo): Support options --data
|
||||
|
|
@ -22,6 +22,7 @@ libexec_PROGRAMS = gpg-protect-tool gpg-preset-passphrase
|
|||
noinst_PROGRAMS = $(TESTS)
|
||||
|
||||
# EXTRA_DIST = gpg-agent.ico gpg-agent-resource.rc
|
||||
EXTRA_DIST = ChangeLog-2011
|
||||
|
||||
AM_CPPFLAGS = -I$(top_srcdir)/gl -I$(top_srcdir)/common -I$(top_srcdir)/intl
|
||||
|
||||
|
|
|
|||
|
|
@ -199,7 +199,7 @@ EOF
|
|||
fi
|
||||
|
||||
|
||||
# Check the git setup.
|
||||
# Update the git setup.
|
||||
if [ -d .git ]; then
|
||||
if [ -f .git/hooks/pre-commit.sample -a ! -f .git/hooks/pre-commit ] ; then
|
||||
cat <<EOF >&2
|
||||
|
|
@ -219,6 +219,13 @@ EOF
|
|||
git config --add filter.cleanpo.clean \
|
||||
"awk '/^\"POT-Creation-Date:/&&!s{s=1;next};!/^#: /{print}'"
|
||||
fi
|
||||
if [ -f scripts/git-hooks/commit-msg -a ! -f .git/hooks/commit-msg ] ; then
|
||||
cat <<EOF >&2
|
||||
*** Activating commit log message check hook. ***
|
||||
EOF
|
||||
cp -av scripts/git-hooks/commit-msg .git/hooks/commit-msg
|
||||
chmod -c +x .git/hooks/commit-msg
|
||||
fi
|
||||
fi
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-08-04 Werner Koch <wk@g10code.com>
|
||||
|
||||
* ssh-utils.c, ssh-utils.h: New.
|
||||
|
|
@ -19,7 +19,7 @@
|
|||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
EXTRA_DIST = mkstrtable.awk exaudit.awk exstatus.awk \
|
||||
audit-events.h status-codes.h
|
||||
audit-events.h status-codes.h ChangeLog-2011
|
||||
|
||||
noinst_LIBRARIES = libcommon.a libcommonpth.a libsimple-pwquery.a libgpgrl.a
|
||||
noinst_PROGRAMS = $(module_tests) $(module_maint_tests)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-01-13 Werner Koch <wk@g10code.com>
|
||||
|
||||
* FAQ: Make it a static file with a pointer to the online location.
|
||||
|
|
@ -655,7 +662,7 @@
|
|||
* gnupg.texi: Include gpg.texi
|
||||
|
||||
* tools.texi: Add a few @command markups.
|
||||
* gpgsm.texi: Ditto
|
||||
* gpgsm.texi: Ditto.
|
||||
* gpg-agent.texi: Ditto.
|
||||
* scdaemon.texi: Ditto.
|
||||
|
||||
26
doc/HACKING
26
doc/HACKING
|
|
@ -3,7 +3,31 @@
|
|||
(Some notes on GNUPG internals.)
|
||||
|
||||
|
||||
===> Under construction <=======
|
||||
* No more ChangeLog files
|
||||
|
||||
Do not modify any of the ChangeLog files in GnuPG. Starting on
|
||||
December 1st, 2011 we put change information only in the GIT commit
|
||||
log, and generate a top-level ChangeLog file from logs at "make dist"
|
||||
time. As such, there are strict requirements on the form of the
|
||||
commit log messages. The old ChangeLog files have all be renamed to
|
||||
ChangeLog-2011
|
||||
|
||||
|
||||
* Commit log requirements
|
||||
|
||||
Your commit log should always start with a one-line summary, the second
|
||||
line should be blank, and the remaining lines are usually ChangeLog-style
|
||||
entries for all affected files. However, it's fine -- even recommended --
|
||||
to write a few lines of prose describing the change, when the summary
|
||||
and ChangeLog entries don't give enough of the big picture. Omit the
|
||||
leading TABs that you're used to seeing in a "real" ChangeLog file, but
|
||||
keep the maximum line length at 72 or smaller, so that the generated
|
||||
ChangeLog lines, each with its leading TAB, will not exceed 80 columns.
|
||||
|
||||
|
||||
|
||||
===> What follows is probably out of date <===
|
||||
|
||||
|
||||
|
||||
RFCs
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ helpfiles = help.txt help.be.txt help.ca.txt help.cs.txt \
|
|||
help.pt_BR.txt help.ro.txt help.ru.txt help.sk.txt \
|
||||
help.sv.txt help.tr.txt help.zh_CN.txt help.zh_TW.txt
|
||||
|
||||
EXTRA_DIST = samplekeys.asc \
|
||||
EXTRA_DIST = samplekeys.asc ChangeLog-2011 \
|
||||
gnupg-logo.eps gnupg-logo.pdf gnupg-logo.png \
|
||||
gnupg-card-architecture.eps gnupg-card-architecture.png \
|
||||
gnupg-card-architecture.pdf \
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-08-04 Werner Koch <wk@g10code.com>
|
||||
|
||||
* keyedit.c (show_key_with_all_names): Remove set but unused var
|
||||
|
|
@ -18,7 +18,7 @@
|
|||
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
EXTRA_DIST = options.skel
|
||||
EXTRA_DIST = options.skel ChangeLog-2011
|
||||
|
||||
AM_CPPFLAGS = -I$(top_srcdir)/gl -I$(top_srcdir)/common \
|
||||
-I$(top_srcdir)/include -I$(top_srcdir)/intl
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-07-01 Werner Koch <wk@g10code.com>
|
||||
|
||||
* cipher.h (PUBKEY_ALGO_ECDH, PUBKEY_ALGO_ECDSA): New.
|
||||
|
|
@ -1 +1 @@
|
|||
EXTRA_DIST = cipher.h types.h host2net.h _regex.h
|
||||
EXTRA_DIST = cipher.h types.h host2net.h _regex.h ChangeLog-2011
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2009-08-26 Werner Koch <wk@g10code.com>
|
||||
|
||||
* stringhelp.c (do_make_filename): Factor some code out to ..
|
||||
|
|
@ -20,7 +20,7 @@
|
|||
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
EXTRA_DIST = README
|
||||
EXTRA_DIST = README ChangeLog-2011
|
||||
noinst_PROGRAMS = $(module_tests)
|
||||
TESTS = $(module_tests)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-08-04 Werner Koch <wk@g10code.com>
|
||||
|
||||
* keybox-openpgp.c (parse_key): Remove set but unused vars
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
localedir = $(datadir)/locale
|
||||
INCLUDES = -I../intl -DLOCALEDIR=\"$(localedir)\"
|
||||
|
||||
EXTRA_DIST = mkerrors
|
||||
EXTRA_DIST = mkerrors ChangeLog-2011
|
||||
AM_CPPFLAGS = -I$(top_srcdir)/gl -I$(top_srcdir)/common -I$(top_srcdir)/intl \
|
||||
$(LIBGCRYPT_CFLAGS) $(KSBA_CFLAGS)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2009-08-26 Werner Koch <wk@g10code.com>
|
||||
|
||||
* gpgkeys_hkp.c: Include util.h.
|
||||
|
|
@ -26,6 +26,8 @@ EXTRA_PROGRAMS = gpg2keys_ldap gpg2keys_hkp gpg2keys_finger gpg2keys_curl \
|
|||
gpg2keys_kdns
|
||||
EXTRA_SCRIPTS = gpg2keys_mailto
|
||||
|
||||
EXTRA_DIST = ChangeLog-2011
|
||||
|
||||
AM_CPPFLAGS = -I$(top_srcdir)/gl -I$(top_srcdir)/common -I$(top_srcdir)/intl
|
||||
|
||||
AM_CFLAGS = $(LIBGCRYPT_CFLAGS) $(GPG_ERROR_CFLAGS)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-09-12 Werner Koch <wk@g10code.com>
|
||||
|
||||
* libcurl.m4: Fix lost hash sign introduced by previous change.
|
||||
|
|
@ -150,4 +157,3 @@
|
|||
* uintmax_t.m4: New file, from gettext-0.11.5.
|
||||
* ulonglong.m4: New file, from gettext-0.11.5.
|
||||
* Makefile.am: New file.
|
||||
|
||||
|
|
@ -12,6 +12,8 @@ EXTRA_DIST += estream.m4
|
|||
|
||||
EXTRA_DIST += sys_socket_h.m4 socklen.m4
|
||||
|
||||
EXTRA_DIST += ChangeLog-2011
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-01-12 Jakub Bogusz <qboosh@pld-linux.org> (wk)
|
||||
|
||||
* pl.po: Update.
|
||||
|
|
@ -327,5 +334,3 @@
|
|||
This file is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
|
||||
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
|
||||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-08-04 Werner Koch <wk@g10code.com>
|
||||
|
||||
* pcsc-wrapper.c (handle_open): Remove unused var LISTLEN.
|
||||
|
|
@ -22,6 +22,8 @@ if ! HAVE_W32_SYSTEM
|
|||
libexec_PROGRAMS = gnupg-pcsc-wrapper
|
||||
endif
|
||||
|
||||
EXTRA_DIST = ChangeLog-2011
|
||||
|
||||
AM_CPPFLAGS = -I$(top_srcdir)/gl -I$(top_srcdir)/intl -I$(top_srcdir)/common
|
||||
|
||||
include $(top_srcdir)/am/cmacros.am
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-07-22 Werner Koch <wk@g10code.com>
|
||||
|
||||
* config.sub, config.guess: Update to version 2011-06-03.
|
||||
|
|
@ -43,5 +50,3 @@
|
|||
This file is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
|
||||
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,127 @@
|
|||
eval '(exit $?0)' && eval 'exec perl -w "$0" ${1+"$@"}'
|
||||
& eval 'exec perl -w "$0" $argv:q'
|
||||
if 0;
|
||||
|
||||
# An hook script to check the commit log message.
|
||||
# Called by "git commit" with one argument, the name of the file
|
||||
# that has the commit message. The hook should exit with non-zero
|
||||
# status after issuing an appropriate message if it wants to stop the
|
||||
# commit. The hook is allowed to edit the commit message file.
|
||||
#
|
||||
# To enable this hook, copy it to "~/.git/hooks/commit-msg".
|
||||
#
|
||||
# This script is based on the one from GNU coreutils.
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
(my $ME = $0) =~ s|.*/||;
|
||||
|
||||
my $editor = $ENV{EDITOR} || 'vi';
|
||||
$ENV{PATH} = '/bin:/usr/bin';
|
||||
|
||||
# Rewrite the $LOG_FILE (old contents in @$LINE_REF) with an additional
|
||||
# commented diagnostic "# $ERR" line at the top.
|
||||
sub rewrite($$$)
|
||||
{
|
||||
my ($log_file, $err, $line_ref) = @_;
|
||||
local *LOG;
|
||||
open LOG, '>', $log_file
|
||||
or die "$ME: $log_file: failed to open for writing: $!";
|
||||
print LOG "# $err";
|
||||
print LOG @$line_ref;
|
||||
close LOG
|
||||
or die "$ME: $log_file: failed to rewrite: $!\n";
|
||||
}
|
||||
|
||||
sub re_edit($)
|
||||
{
|
||||
my ($log_file) = @_;
|
||||
|
||||
warn "Interrupt (Ctrl-C) to abort...\n";
|
||||
|
||||
system 'sh', '-c', "$editor $log_file";
|
||||
($? & 127) || ($? >> 8)
|
||||
and die "$ME: $log_file: the editor ($editor) failed, aborting\n";
|
||||
}
|
||||
|
||||
# Given a $LOG_FILE name and a \@LINE buffer,
|
||||
# read the contents of the file into the buffer and analyze it.
|
||||
# If the log message passes muster, return the empty string.
|
||||
# If not, return a diagnostic.
|
||||
sub check_msg($$)
|
||||
{
|
||||
my ($log_file, $line_ref) = @_;
|
||||
|
||||
local *LOG;
|
||||
open LOG, '<', $log_file
|
||||
or return "failed to open for reading: $!";
|
||||
@$line_ref = <LOG>;
|
||||
close LOG;
|
||||
|
||||
my @line = @$line_ref;
|
||||
chomp @line;
|
||||
|
||||
# Don't filter out blank or comment lines; git does that already,
|
||||
# and if we were to ignore them here, it could lead to committing
|
||||
# with lines that start with "#" in the log.
|
||||
|
||||
# Filter out leading blank and comment lines.
|
||||
# while (@line && $line[0] =~ /^(?:#.*|[ \t]*)$/) { shift @line; }
|
||||
|
||||
# Filter out blank and comment lines at EOF.
|
||||
# while (@line && $line[$#line] =~ /^(?:#.*|[ \t]*)$/) { pop @line; }
|
||||
|
||||
@line == 0
|
||||
and return 'no log message';
|
||||
|
||||
# The first line should not be too short
|
||||
8 < length $line[0] || return 'summary line too short';
|
||||
|
||||
# The first line should not start with an asterisk or a hash sign.
|
||||
# An asterisk might indicate that a change entry was started right
|
||||
# at the first line.
|
||||
$line[0] =~ /^[*#]/ && return "summary line starts with an * or #";
|
||||
|
||||
# Second line should be blank or not present.
|
||||
2 <= @line && length $line[1]
|
||||
and return 'second line must be empty';
|
||||
|
||||
# Limit line length to allow for the ChangeLog's leading TAB.
|
||||
foreach my $line (@line)
|
||||
{
|
||||
72 < length $line && $line =~ /^[^#]/
|
||||
and return 'line longer than 72 characters';
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
{
|
||||
@ARGV == 1
|
||||
or die;
|
||||
|
||||
my $log_file = $ARGV[0];
|
||||
|
||||
while (1)
|
||||
{
|
||||
my @line;
|
||||
my $err = check_msg $log_file, \@line;
|
||||
$err eq ''
|
||||
and last;
|
||||
$err = "$ME: $err\n";
|
||||
warn $err;
|
||||
exit 1;
|
||||
|
||||
# Insert the diagnostic as a comment on the first line of $log_file.
|
||||
#rewrite $log_file, $err, \@line;
|
||||
#re_edit $log_file;
|
||||
#
|
||||
## Stop if our parent is killed.
|
||||
#getppid() == 1
|
||||
# and last;
|
||||
}
|
||||
}
|
||||
|
||||
# Local Variables:
|
||||
# mode: perl
|
||||
# End:
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# This file is expected to be used via gitlog-to-changelog's --amend=FILE
|
||||
# option. It specifies what changes to make to each given SHA1's commit
|
||||
# log and metadata, using Perl-eval'able expressions.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
|
||||
2011-12-01 Werner Koch <wk@gnupg.org>
|
||||
|
||||
NB: Changes done before December 1st, 2011 are described in
|
||||
per directory files named ChangeLog-2011. See doc/HACKING for
|
||||
details.
|
||||
|
||||
-----
|
||||
Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
|
||||
2010, 2011 Free Software Foundation, Inc.
|
||||
|
||||
Copying and distribution of this file and/or the original GIT
|
||||
commit log messages, with or without modification, are
|
||||
permitted provided the copyright notice and this notice are
|
||||
preserved.
|
||||
|
|
@ -0,0 +1,345 @@
|
|||
eval '(exit $?0)' && eval 'exec perl -wS "$0" ${1+"$@"}'
|
||||
& eval 'exec perl -wS "$0" $argv:q'
|
||||
if 0;
|
||||
# Convert git log output to ChangeLog format.
|
||||
|
||||
my $VERSION = '2011-11-02 07:53'; # UTC
|
||||
# The definition above must lie within the first 8 lines in order
|
||||
# for the Emacs time-stamp write hook (at end) to update it.
|
||||
# If you change this file with Emacs, please let the write hook
|
||||
# do its job. Otherwise, update this string manually.
|
||||
|
||||
# Copyright (C) 2008-2011 Free Software Foundation, Inc.
|
||||
|
||||
# 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/>.
|
||||
|
||||
# Written by Jim Meyering
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
use Getopt::Long;
|
||||
use POSIX qw(strftime);
|
||||
|
||||
(my $ME = $0) =~ s|.*/||;
|
||||
|
||||
# use File::Coda; # http://meyering.net/code/Coda/
|
||||
END {
|
||||
defined fileno STDOUT or return;
|
||||
close STDOUT and return;
|
||||
warn "$ME: failed to close standard output: $!\n";
|
||||
$? ||= 1;
|
||||
}
|
||||
|
||||
sub usage ($)
|
||||
{
|
||||
my ($exit_code) = @_;
|
||||
my $STREAM = ($exit_code == 0 ? *STDOUT : *STDERR);
|
||||
if ($exit_code != 0)
|
||||
{
|
||||
print $STREAM "Try `$ME --help' for more information.\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
print $STREAM <<EOF;
|
||||
Usage: $ME [OPTIONS] [ARGS]
|
||||
|
||||
Convert git log output to ChangeLog format. If present, any ARGS
|
||||
are passed to "git log". To avoid ARGS being parsed as options to
|
||||
$ME, they may be preceded by '--'.
|
||||
|
||||
OPTIONS:
|
||||
|
||||
--amend=FILE FILE maps from an SHA1 to perl code (i.e., s/old/new/) that
|
||||
makes a change to SHA1's commit log text or metadata.
|
||||
--append-dot append a dot to the first line of each commit message if
|
||||
there is no other punctuation or blank at the end.
|
||||
--since=DATE convert only the logs since DATE;
|
||||
the default is to convert all log entries.
|
||||
--format=FMT set format string for commit subject and body;
|
||||
see 'man git-log' for the list of format metacharacters;
|
||||
the default is '%s%n%b%n'
|
||||
|
||||
--help display this help and exit
|
||||
--version output version information and exit
|
||||
|
||||
EXAMPLE:
|
||||
|
||||
$ME --since=2008-01-01 > ChangeLog
|
||||
$ME -- -n 5 foo > last-5-commits-to-branch-foo
|
||||
|
||||
In a FILE specified via --amend, comment lines (starting with "#") are ignored.
|
||||
FILE must consist of <SHA,CODE+> pairs where SHA is a 40-byte SHA1 (alone on
|
||||
a line) referring to a commit in the current project, and CODE refers to one
|
||||
or more consecutive lines of Perl code. Pairs must be separated by one or
|
||||
more blank line.
|
||||
|
||||
Here is sample input for use with --amend=FILE, from coreutils:
|
||||
|
||||
3a169f4c5d9159283548178668d2fae6fced3030
|
||||
# fix typo in title:
|
||||
s/all tile types/all file types/
|
||||
|
||||
1379ed974f1fa39b12e2ffab18b3f7a607082202
|
||||
# Due to a bug in vc-dwim, I mis-attributed a patch by Paul to myself.
|
||||
# Change the author to be Paul. Note the escaped "@":
|
||||
s,Jim .*>,Paul Eggert <eggert\@cs.ucla.edu>,
|
||||
|
||||
EOF
|
||||
}
|
||||
exit $exit_code;
|
||||
}
|
||||
|
||||
# If the string $S is a well-behaved file name, simply return it.
|
||||
# If it contains white space, quotes, etc., quote it, and return the new string.
|
||||
sub shell_quote($)
|
||||
{
|
||||
my ($s) = @_;
|
||||
if ($s =~ m![^\w+/.,-]!)
|
||||
{
|
||||
# Convert each single quote to '\''
|
||||
$s =~ s/\'/\'\\\'\'/g;
|
||||
# Then single quote the string.
|
||||
$s = "'$s'";
|
||||
}
|
||||
return $s;
|
||||
}
|
||||
|
||||
sub quoted_cmd(@)
|
||||
{
|
||||
return join (' ', map {shell_quote $_} @_);
|
||||
}
|
||||
|
||||
# Parse file F.
|
||||
# Comment lines (starting with "#") are ignored.
|
||||
# F must consist of <SHA,CODE+> pairs where SHA is a 40-byte SHA1
|
||||
# (alone on a line) referring to a commit in the current project, and
|
||||
# CODE refers to one or more consecutive lines of Perl code.
|
||||
# Pairs must be separated by one or more blank line.
|
||||
sub parse_amend_file($)
|
||||
{
|
||||
my ($f) = @_;
|
||||
|
||||
open F, '<', $f
|
||||
or die "$ME: $f: failed to open for reading: $!\n";
|
||||
|
||||
my $fail;
|
||||
my $h = {};
|
||||
my $in_code = 0;
|
||||
my $sha;
|
||||
while (defined (my $line = <F>))
|
||||
{
|
||||
$line =~ /^\#/
|
||||
and next;
|
||||
chomp $line;
|
||||
$line eq ''
|
||||
and $in_code = 0, next;
|
||||
|
||||
if (!$in_code)
|
||||
{
|
||||
$line =~ /^([0-9a-fA-F]{40})$/
|
||||
or (warn "$ME: $f:$.: invalid line; expected an SHA1\n"),
|
||||
$fail = 1, next;
|
||||
$sha = lc $1;
|
||||
$in_code = 1;
|
||||
exists $h->{$sha}
|
||||
and (warn "$ME: $f:$.: duplicate SHA1\n"),
|
||||
$fail = 1, next;
|
||||
}
|
||||
else
|
||||
{
|
||||
$h->{$sha} ||= '';
|
||||
$h->{$sha} .= "$line\n";
|
||||
}
|
||||
}
|
||||
close F;
|
||||
|
||||
$fail
|
||||
and exit 1;
|
||||
|
||||
return $h;
|
||||
}
|
||||
|
||||
{
|
||||
my $since_date;
|
||||
my $format_string = '%s%n%b%n';
|
||||
my $amend_file;
|
||||
my $append_dot = 0;
|
||||
GetOptions
|
||||
(
|
||||
help => sub { usage 0 },
|
||||
version => sub { print "$ME version $VERSION\n"; exit },
|
||||
'since=s' => \$since_date,
|
||||
'format=s' => \$format_string,
|
||||
'amend=s' => \$amend_file,
|
||||
'append-dot' => \$append_dot,
|
||||
) or usage 1;
|
||||
|
||||
|
||||
defined $since_date
|
||||
and unshift @ARGV, "--since=$since_date";
|
||||
|
||||
# This is a hash that maps an SHA1 to perl code (i.e., s/old/new/)
|
||||
# that makes a correction in the log or attribution of that commit.
|
||||
my $amend_code = defined $amend_file ? parse_amend_file $amend_file : {};
|
||||
|
||||
my @cmd = (qw (git log --log-size),
|
||||
'--pretty=format:%H:%ct %an <%ae>%n%n'.$format_string, @ARGV);
|
||||
open PIPE, '-|', @cmd
|
||||
or die ("$ME: failed to run `". quoted_cmd (@cmd) ."': $!\n"
|
||||
. "(Is your Git too old? Version 1.5.1 or later is required.)\n");
|
||||
|
||||
my $prev_date_line = '';
|
||||
my @prev_coauthors = ();
|
||||
while (1)
|
||||
{
|
||||
defined (my $in = <PIPE>)
|
||||
or last;
|
||||
$in =~ /^log size (\d+)$/
|
||||
or die "$ME:$.: Invalid line (expected log size):\n$in";
|
||||
my $log_nbytes = $1;
|
||||
|
||||
my $log;
|
||||
my $n_read = read PIPE, $log, $log_nbytes;
|
||||
$n_read == $log_nbytes
|
||||
or die "$ME:$.: unexpected EOF\n";
|
||||
|
||||
# Extract leading hash.
|
||||
my ($sha, $rest) = split ':', $log, 2;
|
||||
defined $sha
|
||||
or die "$ME:$.: malformed log entry\n";
|
||||
$sha =~ /^[0-9a-fA-F]{40}$/
|
||||
or die "$ME:$.: invalid SHA1: $sha\n";
|
||||
|
||||
# If this commit's log requires any transformation, do it now.
|
||||
my $code = $amend_code->{$sha};
|
||||
if (defined $code)
|
||||
{
|
||||
eval 'use Safe';
|
||||
my $s = new Safe;
|
||||
# Put the unpreprocessed entry into "$_".
|
||||
$_ = $rest;
|
||||
|
||||
# Let $code operate on it, safely.
|
||||
my $r = $s->reval("$code")
|
||||
or die "$ME:$.:$sha: failed to eval \"$code\":\n$@\n";
|
||||
|
||||
# Note that we've used this entry.
|
||||
delete $amend_code->{$sha};
|
||||
|
||||
# Update $rest upon success.
|
||||
$rest = $_;
|
||||
}
|
||||
|
||||
my @line = split "\n", $rest;
|
||||
my $author_line = shift @line;
|
||||
defined $author_line
|
||||
or die "$ME:$.: unexpected EOF\n";
|
||||
$author_line =~ /^(\d+) (.*>)$/
|
||||
or die "$ME:$.: Invalid line "
|
||||
. "(expected date/author/email):\n$author_line\n";
|
||||
|
||||
my $date_line = sprintf "%s $2\n", strftime ("%F", localtime ($1));
|
||||
|
||||
# Format 'Co-authored-by: A U Thor <email@example.com>' lines in
|
||||
# standard multi-author ChangeLog format.
|
||||
my @coauthors = grep /^Co-authored-by:.*$/, @line;
|
||||
for (@coauthors)
|
||||
{
|
||||
s/^Co-authored-by:\s*/\t /;
|
||||
s/\s*</ </;
|
||||
|
||||
/<.*?@.*\..*>/
|
||||
or warn "$ME: warning: missing email address for "
|
||||
. substr ($_, 5) . "\n";
|
||||
}
|
||||
|
||||
# If this header would be the same as the previous date/name/email/
|
||||
# coauthors header, then arrange not to print it.
|
||||
if ($date_line ne $prev_date_line or "@coauthors" ne "@prev_coauthors")
|
||||
{
|
||||
$prev_date_line eq ''
|
||||
or print "\n";
|
||||
print $date_line;
|
||||
@coauthors
|
||||
and print join ("\n", @coauthors), "\n";
|
||||
}
|
||||
$prev_date_line = $date_line;
|
||||
@prev_coauthors = @coauthors;
|
||||
|
||||
# Omit "Co-authored-by..." and "Signed-off-by..." lines.
|
||||
@line = grep !/^Signed-off-by: .*>$/, @line;
|
||||
@line = grep !/^Co-authored-by: /, @line;
|
||||
|
||||
# Remove leading and trailing blank lines.
|
||||
if (@line)
|
||||
{
|
||||
while ($line[0] =~ /^\s*$/) { shift @line; }
|
||||
while ($line[$#line] =~ /^\s*$/) { pop @line; }
|
||||
}
|
||||
|
||||
# If there were any lines
|
||||
if (@line == 0)
|
||||
{
|
||||
warn "$ME: warning: empty commit message:\n $date_line\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
if ($append_dot)
|
||||
{
|
||||
# If the first line of the message has enough room, then
|
||||
if (length $line[0] < 72)
|
||||
{
|
||||
# append a dot if there is no other punctuation or blank
|
||||
# at the end.
|
||||
$line[0] =~ /[[:punct:]\s]$/
|
||||
or $line[0] .= '.';
|
||||
}
|
||||
}
|
||||
|
||||
# Prefix each non-empty line with a TAB.
|
||||
@line = map { length $_ ? "\t$_" : '' } @line;
|
||||
|
||||
print "\n", join ("\n", @line), "\n";
|
||||
}
|
||||
|
||||
defined ($in = <PIPE>)
|
||||
or last;
|
||||
$in ne "\n"
|
||||
and die "$ME:$.: unexpected line:\n$in";
|
||||
}
|
||||
|
||||
close PIPE
|
||||
or die "$ME: error closing pipe from " . quoted_cmd (@cmd) . "\n";
|
||||
# FIXME-someday: include $PROCESS_STATUS in the diagnostic
|
||||
|
||||
# Complain about any unused entry in the --amend=F specified file.
|
||||
my $fail = 0;
|
||||
foreach my $sha (keys %$amend_code)
|
||||
{
|
||||
warn "$ME:$amend_file: unused entry: $sha\n";
|
||||
$fail = 1;
|
||||
}
|
||||
|
||||
exit $fail;
|
||||
}
|
||||
|
||||
# Local Variables:
|
||||
# mode: perl
|
||||
# indent-tabs-mode: nil
|
||||
# eval: (add-hook 'write-file-hooks 'time-stamp)
|
||||
# time-stamp-start: "my $VERSION = '"
|
||||
# time-stamp-format: "%:y-%02m-%02d %02H:%02M"
|
||||
# time-stamp-time-zone: "UTC"
|
||||
# time-stamp-end: "'; # UTC"
|
||||
# End:
|
||||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-08-04 Werner Koch <wk@g10code.com>
|
||||
|
||||
* keydb.c (keydb_add_resource): Remove set but unused var
|
||||
|
|
@ -20,6 +20,8 @@
|
|||
|
||||
bin_PROGRAMS = gpgsm
|
||||
|
||||
EXTRA_DIST = ChangeLog-2011
|
||||
|
||||
AM_CFLAGS = $(LIBGCRYPT_CFLAGS) $(KSBA_CFLAGS) $(LIBASSUAN_CFLAGS)
|
||||
|
||||
AM_CPPFLAGS = -I$(top_srcdir)/gl -I$(top_srcdir)/common -I$(top_srcdir)/intl
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2009-10-13 Werner Koch <wk@g10code.com>
|
||||
|
||||
* asschk.c (die): Replace this vararg macro by C-89 compliant
|
||||
|
|
@ -133,5 +140,3 @@
|
|||
This file is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
|
||||
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ TESTS_ENVIRONMENT = GNUPGHOME=`/bin/pwd` GPG_AGENT_INFO= LC_ALL=C \
|
|||
|
||||
testscripts = sm-sign+verify sm-verify
|
||||
|
||||
EXTRA_DIST = runtest inittests $(testscripts) \
|
||||
EXTRA_DIST = runtest inittests $(testscripts) ChangeLog-2011 \
|
||||
text-1.txt text-2.txt text-3.txt \
|
||||
text-1.osig.pem text-1.dsig.pem text-1.osig-bad.pem \
|
||||
text-2.osig.pem text-2.osig-bad.pem \
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2010-05-12 Werner Koch <wk@g10code.com>
|
||||
|
||||
* armor.test: Add test for bug#1179.
|
||||
|
|
@ -370,5 +377,3 @@ Mon May 18 15:40:02 1998 Werner Koch (wk@isil.d.shuttle.de)
|
|||
This file is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
|
||||
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
|
||||
|
|
@ -50,7 +50,7 @@ TEST_FILES = pubring.asc secring.asc plain-1o.asc plain-2o.asc plain-3o.asc \
|
|||
|
||||
DATA_FILES = data-500 data-9000 data-32000 data-80000 plain-large
|
||||
|
||||
EXTRA_DIST = defs.inc $(TESTS) $(TEST_FILES) \
|
||||
EXTRA_DIST = defs.inc $(TESTS) $(TEST_FILES) ChangeLog-2011 \
|
||||
mkdemodirs signdemokey
|
||||
|
||||
# Note that removing S.gpg-agent forces a running gpg-agent to
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2009-03-03 Werner Koch <wk@g10code.com>
|
||||
|
||||
* inittests (clean_files): Use /bin/pwd here as well.
|
||||
|
|
@ -43,7 +43,7 @@ testscripts = import-all-certs validate-all-certs \
|
|||
private-certificate-extensions
|
||||
|
||||
|
||||
EXTRA_DIST = inittests runtest common.sh $(testscripts)
|
||||
EXTRA_DIST = inittests runtest common.sh $(testscripts) ChangeLog-2011 \
|
||||
import-all-certs.data
|
||||
|
||||
TESTS = $(testscripts)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
2011-12-02 Werner Koch <wk@g10code.com>
|
||||
|
||||
NB: ChangeLog files are no longer manually maintained. Starting
|
||||
on December 1st, 2011 we put change information only in the GIT
|
||||
commit log, and generate a top-level ChangeLog file from logs at
|
||||
"make dist". See doc/HACKING for details.
|
||||
|
||||
2011-08-04 Werner Koch <wk@g10code.com>
|
||||
|
||||
* symcryptrun.c: Include utmp.h for login_tty.
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
# along with this program; if not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
EXTRA_DIST = \
|
||||
Manifest watchgnupg.c \
|
||||
Manifest watchgnupg.c ChangeLog-2011 \
|
||||
addgnupghome applygnupgdefaults gpgsm-gencert.sh \
|
||||
lspgpot mail-signed-keys convert-from-106 sockprox.c \
|
||||
ccidmon.c
|
||||
|
|
|
|||
Loading…
Reference in New Issue