X-Authentication-Warning: delorie.com: mail set sender to geda-user-bounces using -f
X-Recipient: geda-user AT delorie DOT com
Date: Thu, 30 Aug 2012 14:08:45 -0700
From: Larry Doolittle <ldoolitt AT recycle DOT lbl DOT gov>
To: geda-user AT delorie DOT com
Subject: Re: [geda-user] couple of patches
Message-ID: <20120830210845.GA14863@recycle.lbl.gov>
References: <20120830193343 DOT GA14368 AT recycle DOT lbl DOT gov>
 <20120830200744 DOT GA20825 AT visitor2 DOT iram DOT es>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="pWyiEgJYm5f9v55/"
Content-Disposition: inline
In-Reply-To: <20120830200744.GA20825@visitor2.iram.es>
User-Agent: Mutt/1.5.20 (2009-06-14)
Reply-To: geda-user AT delorie DOT com
Errors-To: nobody AT delorie DOT com
X-Mailing-List: geda-user AT delorie DOT com
X-Unsubscribes-To: listserv AT delorie DOT com
Precedence: bulk


--pWyiEgJYm5f9v55/
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Gabriel et al. -

On Thu, Aug 30, 2012 at 10:07:44PM +0200, Gabriel Paubert wrote:
> I might be wrong, but I was convinced that ChangeLog was no
> more updated and that the Right Way (TM) was to write proper
> git commit messages.

Well, it turns out the ChangeLog is generated during the snapshot
process.

> >  If you are updating you may wish to read the ChangeLog
> You also need to rewrite this to point people to gitk
> or similar (git log?).

Ask and ye shall receive.  :-)

Patch attached.  I hope the result will be less confusing.
Or maybe the ChangeLog file shouldn't be in git at all,
just the snapshots?

   - Larry

--pWyiEgJYm5f9v55/
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="0001-Improve-documentation-of-ChangeLog-file.patch"

From 5411d93f4080bf284ada259d878022c9ca089727 Mon Sep 17 00:00:00 2001
From: Larry Doolittle <ldoolitt AT recycle DOT lbl DOT gov>
Date: Thu, 30 Aug 2012 14:02:27 -0700
Subject: [PATCH] Improve documentation of ChangeLog file

Note in the file where it comes from.
Mention it and git commit messages in the README.
---
 ChangeLog    |    8 ++------
 README       |    4 +++-
 utils/git2cl |    5 +++++
 3 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 1d5a740..18b0be4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,9 +1,5 @@
-2012-08-30   Larry Doolittle * ldoolitt AT recycle dot lbl dot gov *
-	* replace gpleda.org with geda-project.org
-
-2012-02-06   Kai-Martin Knaak * kmk AT lilalaser dot de * 
-	* allow "px" as a unit of measure to set RatThickness to a fixed 
-	number of screen pixels.
+This ChangeLog is automatically generated from git commit messages
+during the snapshot process.  See README.snapshots and utils/git2cl.
 
 2011-09-18   DJ Delorie * dj AT delorie dot com *
 
diff --git a/README b/README
index 54c65cc..6906d17 100644
--- a/README
+++ b/README
@@ -4,7 +4,9 @@ design of printed circuit boards.
 For installing the release refer to the file 'INSTALL'.
 For additional information read the manual (doc/pcb.pdf) 
 
-If you are updating you may wish to read the ChangeLog
+If you are updating to a new snapshot, you may wish to read
+the ChangeLog file.  People using git are expected to look
+at the git commit messages, instead.
 
 There is also a bug tracking system available which can
 be found from http://pcb.geda-project.org.  
diff --git a/utils/git2cl b/utils/git2cl
index 40f29d4..1e42e0a 100755
--- a/utils/git2cl
+++ b/utils/git2cl
@@ -390,6 +390,11 @@ else
 	or die("Cannot execute git log...$!\n");
 }
 
+print "This ChangeLog is automatically generated from the git commit messages
+during the snapshot process.  See README.snapshots and utils/git2cl.
+
+";
+
 while (my $_l = <$fh>) {
     #print STDERR "debug ($state, " . (@date ? (strftime "%Y-%m-%d", @date) : "") . "): `$_'\n";
     if ($state == 0) {
-- 
1.7.2.5


--pWyiEgJYm5f9v55/--