Re: [RFC/PATCH] commit notes workflow

From: Jeff King <peff@peff.net>
Date: Mar 1, 2011, 22:23 UTC
Message-ID: <20110301222350.GA24215@sigill.intra.peff.net>
In-Reply-To: <1299017913.14490.10.camel@drew-northup.unet.maine.edu>

On Tue, Mar 01, 2011 at 05:18:33PM -0500, Drew Northup wrote:

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

But we strip that from the notes, unless you use --cleanup. But in that case, you would have deleted the template cruft, since it pollutes your message.

> There is likely good reason why the commit message already has an end
> mark, I suspect that also applies here.

It doesn't have an end mark. The "usual template stuff" just happens to be at the end. But any line starting with "#" will be removed unless you use --cleanup, whether you use --notes or no. Similarly, unadorned lines after the "#" lines will be counted as part of the message.

> (Unless you count "---" between the commit message and the patch as
> "the usual template stuff"--which wasn't clear at this keyboard
> anyway.)

No, I meant the "#" lines. The "---" of format-patch isn't relevant here, since we're just talking about commit messages inside the editor during git-commit.

The really evil bit is "-v" which appends a giant diff with no real indication that it isn't part of the commit message. We already get rid of it with some heuristics (which I remember improving a while back). I don't think my RFC patch handles it very well, but that is something I will be looking at for the next revision.

-Peff