git patch comments

Todd Zullinger tmz at pobox.com
Sun Jun 12 15:29:24 UTC 2011


James McKenzie wrote:
> On 6/8/11 2:52 PM, Michael Cronenworth wrote:
>> Turns into:
>> Git comment - bullet 1 - bullet 2
>>
> This is how git formats the text when it sends the bug in.  I've
> done this myself and was surprised when formatting I applied
> disappeared.  If you want the latter, you'll have to inform the git
> folks in their forum/bug reporting system.

For git commits, you should use the format:

$subject

$body

Git treats the text up to the first newline as the subject of the
commit and many tools are designed around that expectation.

Refer to the "DISCUSSION" section of the git commit manpage:
http://www.kernel.org/pub/software/scm/git/docs/git-commit.html#_discussion

The SubmittingPatches document also includes some helpful advice.
This document is primarily designed for those submitting patches to
the git project, but it's got a lot of good advice.

http://git.kernel.org/?p=git/git.git;a=blob_plain;f=Documentation/SubmittingPatches

-- 
Todd        OpenPGP -> KeyID: 0xBEAF0CE3 | URL: www.pobox.com/~tmz/pgp
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The power of accurate observation is frequently called cynicism by
those who don't have it.
    -- George Bernard Shaw

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 542 bytes
Desc: not available
Url : http://lists.fedoraproject.org/pipermail/users/attachments/20110612/e9f4e6bc/attachment.bin 


More information about the users mailing list