Re: [PATCH] maint: support amending the generated ChangeLog, and fix a typo

[Peter Rosin]

Stefano Lattarini skrev 2012-02-17 09:33:
> On 02/17/2012 08:55 AM, Peter Rosin wrote:
>> * Makefile.am (gitlog_to_changelog_options): Add support for
>> amending the generated ChangeLog.
>> * lib/git-log-fix: New file with things to amend to the generated
>> ChangeLog, starting with a fix for a typo in v1.11-1963-g3b369e6
>> from yesterday.
>> ---
>>  Makefile.am     |    4 +++-
>>  lib/git-log-fix |    8 ++++++++
>>  2 files changed, 11 insertions(+), 1 deletions(-)
>>  create mode 100644 lib/git-log-fix
>>
>> I noticed a typo in a commit message and thought I'd start the
>> ChangeLog amend thing.  Is it ok to put the fixes in lib/git-log-fix?
>>
> Hmm....  What about placing them in a .git-log-fix or .gitlogfix file
> in the top-level directory instead?  This seem more appropriate to me.

Ok, done.

>> I didn't think the fixes should be distributed, since the ChangeLog
>> is already generated in that case and "git log" is kind of useless
>> without a repo.
>>
> While this is true, I'd like to distribute all the files that might
> interest an hypotetical "curious user" who's gotten automake though
> a distribution tarball -- even if such files are actually usable only
> from a git checkout.  Would that be OK to you?

Certainly.

>> Also, other projects don't seem to do it...
>>
>> Ok for master?
>>
> OK once the issues raised above has been addressed (or refuted).
> Thanks.

All addressed, I think.  I also noted that the previously recommended
style of to refer to commits "in v1.11-1963-g3b369e6 from yesterday"
doesn't really work in the ChangeLog, so I changed that reference to
also include the short one-line description.

>> Or should this be two patches, with the infrastructure commited to
>> maint and the fixlet commited to master?
>>
> Nah, don't bother about maint anymore but for the most basic bug
> fixes...  Let's point straight to 1.12 instead :-)

If we're commiting too hard to that and it doesn't actually happen
for one reason or another, we're in for a ride...

Anyway, I pushed the below to master.

Cheers,
Peter

From: Peter Rosin <address@hidden>
Date: Fri, 17 Feb 2012 09:52:07 +0100
Subject: [PATCH] maint: support amending the generated ChangeLog, and fix a
 typo

* Makefile.am (gitlog_to_changelog_options): Add support for
amending the generated ChangeLog.
(EXTRA_DIST): Update.
* .git-log-fix: New file with things to amend to the generated
ChangeLog, starting with a fix for a typo in v1.11-1963-g3b369e6
"maint: use AC_PACKAGE_BUGREPORT to avoid duplication" from
yesterday.
---
 .git-log-fix |    8 ++++++++
 Makefile.am  |    5 ++++-
 2 files changed, 12 insertions(+), 1 deletions(-)
 create mode 100755 .git-log-fix

diff --git a/.git-log-fix b/.git-log-fix
new file mode 100755
index 0000000..561181d
--- /dev/null
+++ b/.git-log-fix
@@ -0,0 +1,8 @@
+# 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.
+
+3b369e6bbe0fb6d7359398935706c87dd9375cb6
+# Date:   Thu Feb 16 22:29:32 2012 +0100
+# Fix a typo.
+s| bur | bug |
diff --git a/Makefile.am b/Makefile.am
index b11e8fd..ce0e0b4 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -44,6 +44,7 @@ EXTRA_DIST = \
   ChangeLog.09 \
   ChangeLog.11 \
   bootstrap \
+  $(gitlog_to_changelog_fixes) \
   $(AUTOMAKESOURCES)
 
 ## Make versioned links.  We only run the transform on the root name;
@@ -117,7 +118,9 @@ recheck:
 ##
 
 gitlog_to_changelog_command = $(PERL) $(srcdir)/lib/gitlog-to-changelog
-gitlog_to_changelog_options = --since='2011-12-28 00:00:00' \
+gitlog_to_changelog_fixes = $(srcdir)/.git-log-fix
+gitlog_to_changelog_options = --amend=$(gitlog_to_changelog_fixes) \
+                              --since='2011-12-28 00:00:00' \
                               --no-cluster --format '%s%n%n%b'
 
 # Automatic generation of the ChangeLog from git history.
-- 
1.7.9