Rewrite gencl as an enhanced replacement of gitlog-to-changelog.

* mu-aux/gencl: Rewritten as a replacement for gitlog-to-changelog.
* ChangeLog.amend: More spell fixes.
* Makefile.am: Use gencl instead of gitlog-to-changelog.
* doc/ChangeLog.CVS: Spell checking
* gnulib.modules: Remove gitlog-to-changelog.

1 files changed, 468 insertions, 59 deletions

diff --git a/mu-aux/gencl b/mu-aux/gencl
index af6056bd5..f124cacde 100755
--- a/mu-aux/gencl
+++ b/mu-aux/gencl
@@ -5,59 +5,265 @@ eval '(exit $?0)' && eval 'exec perl -wS "$0" "$@"'
 use strict;
 use POSIX qw(strftime);
 use Getopt::Long qw(:config gnu_getopt no_ignore_case);
+use Text::Wrap;
+use Data::Dumper;
+use threads;
+use Thread::Queue;
+use Time::ParseDate;
+use Safe;
+use Pod::Usage;
+use Pod::Man;
+use Pod::Find qw(pod_where);
 
 my @append_files;
 my $force;
 my $verbose;
 my $changelog_file = 'ChangeLog';
+my $since_date;
+my $until_date;
+my $strip_cherry_pick;
+my $amend_file;
+my %amendment;
+my $append_dot;
 
-GetOptions('append|a=s@' => \@append_files,
-           'file|F=s' => \$changelog_file,
-           'force|f' => \$force,
-           'verbose|v' => \$verbose) or exit(1);
+sub set_date {
+    my ($time, $err) = parsedate($_[1], PREFER_PAST => 1, UK => 1);
+    unless (defined($time)) {
+        print STDERR "--$_[0]=$_[1]: $err\n";
+        exit(1);
+    }
+    return strftime('%Y-%m-%d', localtime($time));
+}
+
+=head1 NAME
+
+gencl - generate ChangeLog from git log output
+
+=head1 SYNOPSIS
+
+B<gencl>
+[B<-fv>]    
+[B<-a> I<FILE>]
+[B<-F> I<FILE>]
+[B<--amend=>I<FILE>]
+[B<--append-dot>]
+[B<--append=>I<FILE>]
+[B<--file=>I<FILE>]
+[B<--force>]
+[B<--since=>I<DATE>]
+[B<--strip-cherry-pick>]
+[B<--until=>I<DATE>]    
+[B<--verbose>]
+
+B<gencl> B<-h> | B<--help> | B<--usage>
+
+=head1 DESCRIPTION
+
+Retrieves git log messages and reformats them as a valid ChangeLog
+file.  The file begins with an automatically generated entry stating
+the SHA1 hash of the git HEAD commit.  This entry is followed by
+the log entries recreated from the git log, in reverse chronological
+order.  By default, entire log is converted.  This can be changed by
+using B<--since> and/or B<--until> options.  Files specified with the
+B<--append> options (if any), are appended after the converted entries.
+The file ends with the B<emacs> B<Local Variables> stanza.
+
+If the B<ChangeLog> file exists, B<gencl> verifies if the source tree
+has changed since the file was created.  The file is re-created only if
+there were some changes (whether committed or not).  The the B<--force>
+(B<-f>) option instructs B<gencl> to recreate the file unconditionally.
+
+The file supplied with the B<--amend> option is used to correct spelling
+(and other) errors in the log entries.  It consists of entries delimited
+with one or more empty lines.  Each entry begins with a full SHA1 hash
+of the commit it applies to.  The hash is followed by one or more lines
+with a valid Perl code (typically, B<s///> statements).  Comments are
+introduced with the B<#> sign.  For each git log entry, its hash is looked
+up in that file.  If found, the B<$_> variable is set to the commit subject,
+followed by the commit body and the code is evaluated.
+        
+=head1 OPTIONS
+
+=over 4
+
+=item B<-a>, B<--append=>I<FILE>
+
+Append I<FILE> to the end of the generated file.  Multiple B<--append>
+are processed in the order of their occurrence on the command line.
+The content of I<FILE> is appended verbatim, except that the line beginning
+with the text B<Local Variables:> is taken to mark the end of file.
+   
+=item B<-F>, B<--file=>I<FILE>
+
+Create I<FILE> instead of the B<ChangeLog>.
+
+=item B<-f>, B<--force>
+
+Force recreating the ChangeLog, even if no new commits were added to the
+repository since its creation.
+    
+=item B<-v>, B<--verbose>
+
+Increase output verbosity.
+
+=item B<--since=>I<DATE>
+
+Convert only the logs since I<DATE>.  See B<Time::ParseDate>(3), for
+a list of valid I<DATE> formats.
+
+=item B<--until=>I<DATE>
+
+Convert only the logs until I<DATE>.  See B<Time::ParseDate>(3), for
+a list of valid I<DATE> formats.
+    
+=item B<--strip-cherry-pick>
+
+Remove data inserted by B<git cherry-pick>.  This includes the "cherry picked
+from commit ..." line, and the possible final "Conflicts:" paragraph.
+
+=item B<--amend=>I<FILE>
+
+Read amendment instructions from I<FILE>.
+
+=item B<--append-dot>
+
+Append a dot to the subject line of each commit message if there is no other
+punctuation the end.     
+    
+=back
+
+=head1 DIFFERENCES FROM GITLOG-TO-CHANGELOG
+
+=over 4
+
+=item 1
+
+B<gencl> writes output to the disk file, whereas B<gitlog-to-changelog>
+prints it to the standard output.
+
+=item 2
+
+The created B<ChangeLog> begins with an automatically generated entry and
+ends with the B<Local Variables> stanza.
+
+=item 3
+
+The B<ChangeLog> file is re-created only if the source tree was changed
+since it was written (whether these changes have been committed or not).
+
+=item 4
+
+Arbitrary number of files can be concatenated to the produced file.  This
+is handy for projects that switched to B<git> from other VCS.
+
+=item 5
+
+Each entry is reformatted using B<Text::Wrap>.
+
+=item 6
+
+The following B<gitlab-to-changelog> options are not implemented: B<--cluster>,
+B<--ignore-matching>, B<--ignore_line>.
+    
+=back
+    
+=cut    
+    
+sub pod_usage_msg {
+    my ($obj) = @_;
+    open my $fd, '>', \my $msg;
+
+    pod2usage(-verbose => 99,
+              -sections => 'NAME',
+              -output => $fd,
+              -exitval => 'NOEXIT');
+    my @a = split /\n/, $msg;
+    $msg = $a[1];
+    $msg =~ s/^\s+//;
+    $msg =~ s/ - /: /;
+    return $msg;
+}
+
+GetOptions(
+    'h' => sub {
+        pod2usage(-message => pod_usage_msg(),
+                  -exitstatus => 0,
+                  -input => pod_where({-inc => 1}, $0))
+    },
+    'help' => sub {
+        pod2usage(-exitstatus => 0,
+                  -verbose => 2,
+                  -input => pod_where({-inc => 1}, $0));
+    },
+    'usage' => sub {
+        pod2usage(-exitstatus => 0,
+                  -verbose => 0,
+                  -input => pod_where({-inc => 1}, $0));
+    },
+    'append|a=s@' => \@append_files,
+    'file|F=s' => \$changelog_file,
+    'force|f' => \$force,
+    'verbose|v' => \$verbose,
+    'since=s' => sub { $since_date = set_date(@_) },
+    'until=s' => sub { $until_date = set_date(@_) },
+    'strip-cherry-pick' => \$strip_cherry_pick,
+    'amend=s' => \$amend_file,
+    'append-dot' => \$append_dot
+    ) or exit(1);
 
 if (! -d '.git') {
     exit 0;
 }
 
-my ($hash, $date) = split / /, `git log --max-count=1 --pretty=format:'%H %ad' --date=short HEAD`;
+read_amend_file($amend_file) if $amend_file;
+    
+$Text::Wrap::columns = 72;
 
-my @modlines;
-if (open(my $fd, '-|', 'git diff-index --name-status HEAD 2>/dev/null')) {
-    chomp(@modlines = map {chomp; [split /\s+/, $_, 2]} <$fd>);
+create_changelog();