Re: [RFC/PATCH] commit notes workflow

From: Drew Northup <drew.northup@maine.edu>
Date: Feb 25, 2011, 20:30 UTC
Message-ID: <1298665854.27129.25.camel@drew-northup.unet.maine.edu>
In-Reply-To: <20110225133056.GA1026@sigill.intra.peff.net>

On Fri, 2011-02-25 at 08:30 -0500, Jeff King wrote:

> I was revising a long-ish series today, and I have been wanting to start
> using "git notes" to store information on what's changed between
> versions (which will eventually go after the "---" in format-patch).

Show 21 quoted lines

>   1. If we are amending, it populates the commit message not just with
>      the existing message, but also with a "---" divider and any notes on
>      the commit.
> 
>   2. After editing the commit message, it looks for the "---" divider
>      and puts everything after it into a commit note (whether or not it
>      put in a divider in step (1), so you can add new notes, too).
> 
> So your commit template looks like:
> 
>   subject
> 
>   commit message body
>   ---
>   notes data
> 
>   # usual template stuff
> 
> I'm curious what people think. Do others find this useful? Does it seem
> harmful?
>

I'm in agreement with the others that it doesn't seem like a bad idea, and likely a good one. Just one thing, can you add an end-of-note delimiter (the same thing perhaps)? I didn't spend a long time looking at the code, but I can imagine more than a few ways for this to go wrong without one.

-- 
-Drew Northup
________________________________________________
"As opposed to vegetable or mineral error?"
-John Pescatore, SANS NewsBites Vol. 12 Num. 59