Re: [RFC/PATCH] commit notes workflow

From: Drew Northup <drew.northup@maine.edu>
Date: Mar 1, 2011, 22:18 UTC
Message-ID: <1299017913.14490.10.camel@drew-northup.unet.maine.edu>
In-Reply-To: <20110301220053.GB23945@sigill.intra.peff.net>

On Tue, 2011-03-01 at 17:00 -0500, Jeff King wrote:

Show 26 quoted lines

> On Fri, Feb 25, 2011 at 03:30:54PM -0500, Drew Northup wrote:
> 
> > > 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.
> 
> We could add one pretty easily, but I'm not sure what you would be
> delimiting it from. Can you describe a case where it would be useful?
> 
> -Peff

A notes message which contains "the usual template stuff" as means of describing a change to it, for starters...

There is likely good reason why the commit message already has an end mark, I suspect that also applies here. (Unless you count "---" between the commit message and the patch as "the usual template stuff"--which wasn't clear at this keyboard anyway.) If that's already in there then please forgive the noise--it didn't jump out at me, but I also spend way too much time programming in too many languages for that to be very likely.

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