# inaccurate commit message message? 4 messages from 2010-09-04 to 2010-09-04. Participants: Ramana Kumar, Sverre Rabbelier. Thread: https://gitlist.dev/t/24976 ## Ramana Kumar, 2010-09-04 21:37 Subject: inaccurate commit message message? Message-ID: URL: https://gitlist.dev/e/AANLkTinbq8z-ygVUWPRq9PA95-%2B8O8SwOJCLkfMKCg9T%40mail.gmail.com ``` The commit message message says "Lines starting with '#' will be ignored", but fails to say "Lines below this message will be ignored, even if they don't start with '#'". If the second sentence is true, I think it (or something equivalent) should be said, especially because of the relevance during commit --verbose. In fact the documentation for commit --verbose explicitly says to note that the diff lines won't start with '#'s, as if warning people that those lines might show up in the commit message. Yet they do not seem to show up... (and I don't think they should) ``` ## Sverre Rabbelier, 2010-09-04 21:55 Subject: Re: inaccurate commit message message? Message-ID: URL: https://gitlist.dev/e/AANLkTinGNss5siAjpic07OB036y8K0kvBjSj%3DunDhQWs%40mail.gmail.com In-Reply-To: ``` Heya, On Sat, Sep 4, 2010 at 16:37, Ramana Kumar wrote: > The commit message message says "Lines starting with '#' will be > ignored", but fails to say "Lines below this message will be ignored, > even if they don't start with '#'". Because they're not. Only those starting with # are ignored. > If the second sentence is true, I think it (or something equivalent) > should be said, especially because of the relevance during commit > --verbose. It is not true. > In fact the documentation for commit --verbose explicitly says to note > that the diff lines won't start with '#'s, as if warning people that > those lines might show up in the commit message. > Yet they do not seem to show up... (and I don't think they should) Ah, you are apparently talking about 'git commit --verbose'. It works a little different there, all lines starting with # are ignored, as well as everything in and after the diff. -- Cheers, Sverre Rabbelier ``` ## Ramana Kumar, 2010-09-04 22:55 Subject: Re: inaccurate commit message message? Message-ID: URL: https://gitlist.dev/e/AANLkTi%3DVb2cQHPo388m9HYVdYkk3XC_-pM9bm182PWyf%40mail.gmail.com In-Reply-To: ``` On Sun, Sep 5, 2010 at 7:55 AM, Sverre Rabbelier wrote: > Heya, > > On Sat, Sep 4, 2010 at 16:37, Ramana Kumar wrote: >> The commit message message says "Lines starting with '#' will be >> ignored", but fails to say "Lines below this message will be ignored, >> even if they don't start with '#'". > > Because they're not. Only those starting with # are ignored. > >> If the second sentence is true, I think it (or something equivalent) >> should be said, especially because of the relevance during commit >> --verbose. > > It is not true. > >> In fact the documentation for commit --verbose explicitly says to note >> that the diff lines won't start with '#'s, as if warning people that >> those lines might show up in the commit message. >> Yet they do not seem to show up... (and I don't think they should) > > Ah, you are apparently talking about 'git commit --verbose'. It works > a little different there, all lines starting with # are ignored, as > well as everything in and after the diff. The documentation, both in man git-commit and in the commit message message, is misleading when you do git commit --verbose. My proposal is to make it less misleading, by saying in at least one, and ideally both, of those places what you just told me for the first time: when you do a git commit --verbose, the diff lines and everything after will be ignored for the commit message. > > -- > Cheers, > > Sverre Rabbelier > ``` ## Sverre Rabbelier, 2010-09-04 23:07 Subject: Re: inaccurate commit message message? Message-ID: URL: https://gitlist.dev/e/AANLkTi%3DeK4qt7KLg7z-3vqV%2BhgUoW_xire6WftBJAYku%40mail.gmail.com In-Reply-To: ``` Heya, On Sat, Sep 4, 2010 at 17:55, Ramana Kumar wrote: > The documentation, both in man git-commit and in the commit message > message, is misleading when you do git commit --verbose. Correct. > My proposal is to make it less misleading, by saying in at least one, > and ideally both, of those places what you just told me for the first > time: when you do a git commit --verbose, the diff lines and > everything after will be ignored for the commit message. Sounds like a good idea. See builtin/commit.c around line 660. You'll want to check for the verbose flag and adjust the message printed there accordingly. See Documentation/SubmittingPatches.txt on how to submit patches. Please do ask if you have any questions, I'd be glad to help. -- Cheers, Sverre Rabbelier ```