mirror of
git://git.gnupg.org/gnupg.git
synced 2024-12-22 10:19:57 +01:00
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. * Makefile.am (EXTRA_DIST): Add new files. (gen-ChangeLog): New. (dist-hook): Run gen-ChangeLog.
This commit is contained in:
Werner Koch
parent
76b73caf91
commit
120b0ce136
31
Makefile.am
31
Makefile.am
@ -1,4 +1,4 @@
|
|||||||
# Copyright (C) 1998,1999,2000,2001,2003 Free Software Foundation, Inc.
|
# Copyright (C) 1998,1999,2000,2001,2003,2011 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# This file is part of GnuPG.
|
# This file is part of GnuPG.
|
||||||
#
|
#
|
||||||
@ -30,7 +30,18 @@ checks = checks
|
|||||||
endif
|
endif
|
||||||
|
|
||||||
SUBDIRS = m4 intl zlib util mpi cipher tools g10 keyserver po doc ${checks}
|
SUBDIRS = m4 intl zlib util mpi cipher tools g10 keyserver po doc ${checks}
|
||||||
EXTRA_DIST = scripts/config.rpath PROJECTS BUGS config.h.in autogen.sh
|
|
||||||
|
EXTRA_DIST = scripts/config.rpath PROJECTS BUGS config.h.in \
|
||||||
|
autogen.sh ChangeLog-2011 po/ChangeLog-2011 \
|
||||||
|
util/ChangeLog-2011 scripts/ChangeLog-2011 \
|
||||||
|
doc/ChangeLog-2011 tools/ChangeLog-2011 \
|
||||||
|
zlib/ChangeLog-2011 m4/ChangeLog-2011 \
|
||||||
|
include/ChangeLog-2011 g10/ChangeLog-2011 \
|
||||||
|
checks/ChangeLog-2011 cipher/ChangeLog-2011 \
|
||||||
|
intl/ChangeLog-2011 keyserver/ChangeLog-2011 \
|
||||||
|
tests/ChangeLog-2011 mpi/ChangeLog-2011
|
||||||
|
|
||||||
|
|
||||||
DISTCLEANFILES =
|
DISTCLEANFILES =
|
||||||
|
|
||||||
# We do not install README into the doc directory because that would
|
# We do not install README into the doc directory because that would
|
||||||
@ -41,7 +52,7 @@ DISTCLEANFILES =
|
|||||||
# Add all the files listed in "distfiles" files to the distribution,
|
# Add all the files listed in "distfiles" files to the distribution,
|
||||||
# apply version numbers to some files and create a VERSION file which
|
# apply version numbers to some files and create a VERSION file which
|
||||||
# we need for the Prereq: patch file trick.
|
# we need for the Prereq: patch file trick.
|
||||||
dist-hook:
|
dist-hook: gen-ChangeLog
|
||||||
@set -e; \
|
@set -e; \
|
||||||
for file in `cd $(top_srcdir); \
|
for file in `cd $(top_srcdir); \
|
||||||
find scripts mpi include -type f -name distfiles`; do \
|
find scripts mpi include -type f -name distfiles`; do \
|
||||||
@ -57,3 +68,17 @@ dist-hook:
|
|||||||
> $(distdir)/gnupg.spec
|
> $(distdir)/gnupg.spec
|
||||||
echo "$(VERSION)" > $(distdir)/VERSION
|
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
|
||||||
|
|
||||||
|
|||||||
62
doc/HACKING
62
doc/HACKING
@ -3,30 +3,41 @@
|
|||||||
(Some notes on GNUPG internals.)
|
(Some notes on GNUPG internals.)
|
||||||
|
|
||||||
|
|
||||||
|
* 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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
===> Under construction <=======
|
===> Under construction <=======
|
||||||
|
|
||||||
|
|
||||||
CVS Access
|
GIT Access
|
||||||
==========
|
==========
|
||||||
|
|
||||||
NOTE: CVS access has been disabled while we are migrating to Subversion.
|
The GIT repository is available at:
|
||||||
Watch www.gnupg.org for instarctions on how to use the Subversion repository.
|
|
||||||
|
|
||||||
Anonymous read-only CVS access is available:
|
git clone git://git.gnupg.org/gnupg.git
|
||||||
|
git checkout STABLE-BRANCH-1-4
|
||||||
|
|
||||||
cvs -z3 -d :pserver:anoncvs@cvs.gnupg.org:/cvs/gnupg login
|
You may want to subscribe to:
|
||||||
|
|
||||||
use the password "anoncvs". To check out the the complete
|
|
||||||
archive use:
|
|
||||||
|
|
||||||
cvs -z3 -d :pserver:anoncvs@cvs.gnupg.org:/cvs/gnupg \
|
|
||||||
checkout -R STABLE-BRANCH-1-0 gnupg
|
|
||||||
|
|
||||||
This service is provided to help you in hunting bugs and not to deliver
|
|
||||||
stable snapshots; it may happen that it even does not compile, so please
|
|
||||||
don't complain. CVS may put a high load on a server, so please don't poll
|
|
||||||
poll for new updates but wait for an announcement; to receive this you may
|
|
||||||
want to subscribe to:
|
|
||||||
|
|
||||||
gnupg-commit-watchers@gnupg.org
|
gnupg-commit-watchers@gnupg.org
|
||||||
|
|
||||||
@ -36,8 +47,8 @@ by sending a mail with subject "subscribe" to
|
|||||||
|
|
||||||
|
|
||||||
You must run scripts/autogen.sh before doing the ./configure,
|
You must run scripts/autogen.sh before doing the ./configure,
|
||||||
as this creates some needed while which are not in the CVS.
|
as this creates some needed while which are not in the repository.
|
||||||
autogen.sh should checks that you have all required tools
|
autogen.sh should check that you have all required tools
|
||||||
installed.
|
installed.
|
||||||
|
|
||||||
|
|
||||||
@ -49,17 +60,6 @@ of the CVS head revision is also available. See rsync(1) and try
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
Special Tools
|
|
||||||
=============
|
|
||||||
Documentation is based on the docbook DTD. Actually we have only the
|
|
||||||
man page for now. To build a man page you need the docbook-to-man
|
|
||||||
tool and all the other thinks needed for SGML processing. Debian
|
|
||||||
comes with the docbook tools and you only need this docbook-to-man
|
|
||||||
script which is comes with gtk-doc or download it from
|
|
||||||
ftp.openit.de:/pub/devel/sgml. If you don't have it everything
|
|
||||||
should still work fine but you will have only a dummy man page.
|
|
||||||
|
|
||||||
|
|
||||||
RFCs
|
RFCs
|
||||||
====
|
====
|
||||||
|
|
||||||
@ -78,7 +78,7 @@ RFCs
|
|||||||
|
|
||||||
2279 UTF-8, a transformation format of ISO 10646.
|
2279 UTF-8, a transformation format of ISO 10646.
|
||||||
|
|
||||||
2440 OpenPGP.
|
4880 OpenPGP (replaces by 2440).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -16,5 +16,3 @@ assuan.h
|
|||||||
compat.h
|
compat.h
|
||||||
srv.h
|
srv.h
|
||||||
estream-printf.h
|
estream-printf.h
|
||||||
|
|
||||||
ChangeLog
|
|
||||||
|
|||||||
@ -376,7 +376,6 @@ install-data: all
|
|||||||
if test "$(PACKAGE)" = "gettext-tools"; then \
|
if test "$(PACKAGE)" = "gettext-tools"; then \
|
||||||
$(mkdir_p) $(DESTDIR)$(gettextsrcdir); \
|
$(mkdir_p) $(DESTDIR)$(gettextsrcdir); \
|
||||||
$(INSTALL_DATA) VERSION $(DESTDIR)$(gettextsrcdir)/VERSION; \
|
$(INSTALL_DATA) VERSION $(DESTDIR)$(gettextsrcdir)/VERSION; \
|
||||||
$(INSTALL_DATA) ChangeLog.inst $(DESTDIR)$(gettextsrcdir)/ChangeLog; \
|
|
||||||
dists="COPYING.LIB-2.0 COPYING.LIB-2.1 $(DISTFILES.common)"; \
|
dists="COPYING.LIB-2.0 COPYING.LIB-2.1 $(DISTFILES.common)"; \
|
||||||
for file in $$dists; do \
|
for file in $$dists; do \
|
||||||
$(INSTALL_DATA) $(srcdir)/$$file \
|
$(INSTALL_DATA) $(srcdir)/$$file \
|
||||||
@ -545,7 +544,7 @@ dist distdir: Makefile
|
|||||||
additional="$(DISTFILES.normal)"; \
|
additional="$(DISTFILES.normal)"; \
|
||||||
fi; \
|
fi; \
|
||||||
$(MAKE) $(DISTFILES.common) $(DISTFILES.generated) $$additional; \
|
$(MAKE) $(DISTFILES.common) $(DISTFILES.generated) $$additional; \
|
||||||
for file in ChangeLog $(DISTFILES.common) $(DISTFILES.generated) $$additional; do \
|
for file in $(DISTFILES.common) $(DISTFILES.generated) $$additional; do \
|
||||||
if test -f $$file; then dir=.; else dir=$(srcdir); fi; \
|
if test -f $$file; then dir=.; else dir=$(srcdir); fi; \
|
||||||
cp -p $$dir/$$file $(distdir) || test $$file = Makefile.in || exit 1; \
|
cp -p $$dir/$$file $(distdir) || test $$file = Makefile.in || exit 1; \
|
||||||
done; \
|
done; \
|
||||||
|
|||||||
@ -275,6 +275,13 @@ EOF
|
|||||||
cp -av .git/hooks/pre-commit.sample .git/hooks/pre-commit
|
cp -av .git/hooks/pre-commit.sample .git/hooks/pre-commit
|
||||||
chmod -c +x .git/hooks/pre-commit
|
chmod -c +x .git/hooks/pre-commit
|
||||||
fi
|
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
|
||||||
tmp=$(git config --get filter.cleanpo.clean)
|
tmp=$(git config --get filter.cleanpo.clean)
|
||||||
if [ "$tmp" != "awk '/^\"POT-Creation-Date:/&&!s{s=1;next};!/^#: /{print}'" ]
|
if [ "$tmp" != "awk '/^\"POT-Creation-Date:/&&!s{s=1;next};!/^#: /{print}'" ]
|
||||||
then
|
then
|
||||||
|
|||||||
127
scripts/git-hooks/commit-msg
Executable file
127
scripts/git-hooks/commit-msg
Executable file
@ -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:
|
||||||
3
scripts/git-log-fix
Normal file
3
scripts/git-log-fix
Normal file
@ -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.
|
||||||
16
scripts/git-log-footer
Normal file
16
scripts/git-log-footer
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
|
||||||
|
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) 1997, 1998, 1999, 2000, 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.
|
||||||
345
scripts/gitlog-to-changelog
Executable file
345
scripts/gitlog-to-changelog
Executable file
@ -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:
|
||||||
@ -3,7 +3,7 @@
|
|||||||
# For conditions of distribution and use, see copyright notice in zlib.h
|
# For conditions of distribution and use, see copyright notice in zlib.h
|
||||||
# This is used if a systems lacks support of zlib
|
# This is used if a systems lacks support of zlib
|
||||||
|
|
||||||
EXTRA_DIST = README algorithm.doc ChangeLog
|
EXTRA_DIST = README algorithm.doc ChangeLog-2011
|
||||||
|
|
||||||
# I found no other easy way to use this only if zlib is neede
|
# I found no other easy way to use this only if zlib is neede
|
||||||
# doing this with SUBDIR = @xxx@ in the top Makefile.am does not
|
# doing this with SUBDIR = @xxx@ in the top Makefile.am does not
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user