Re: git patch comments

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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

Attachment: pgpXrnVIkvQ_E.pgp
Description: PGP signature

-- 
users mailing list
users@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe or change subscription options:
https://admin.fedoraproject.org/mailman/listinfo/users
Guidelines: http://fedoraproject.org/wiki/Mailing_list_guidelines
[Index of Archives]     [Older Fedora Users]     [Fedora Announce]     [Fedora Package Announce]     [EPEL Announce]     [EPEL Devel]     [Fedora Magazine]     [Fedora Summer Coding]     [Fedora Laptop]     [Fedora Cloud]     [Fedora Advisory Board]     [Fedora Education]     [Fedora Security]     [Fedora Scitech]     [Fedora Robotics]     [Fedora Infrastructure]     [Fedora Websites]     [Anaconda Devel]     [Fedora Devel Java]     [Fedora Desktop]     [Fedora Fonts]     [Fedora Marketing]     [Fedora Management Tools]     [Fedora Mentors]     [Fedora Package Review]     [Fedora R Devel]     [Fedora PHP Devel]     [Kickstart]     [Fedora Music]     [Fedora Packaging]     [Fedora SELinux]     [Fedora Legal]     [Fedora Kernel]     [Fedora OCaml]     [Coolkey]     [Virtualization Tools]     [ET Management Tools]     [Yum Users]     [Yosemite News]     [Gnome Users]     [KDE Users]     [Fedora Art]     [Fedora Docs]     [Fedora Sparc]     [Libvirt Users]     [Fedora ARM]

  Powered by Linux