tarantool / checkpatch

Checkpatch for Tarantool
GNU General Public License v2.0
2 stars 2 forks source link

'Commit log lines starting with '#' are dropped by git as comments' #30

Closed Totktonada closed 2 years ago

Totktonada commented 2 years ago

Sometimes I use the hash symbol as a comment in a code block (wrapped in three-backticks as in Markdown) or for splitting my description into sections. I have the following lines in ~/.gitconfig, so it it not stripped:

[commit]
    cleanup = scissors

At the end, if I successfully placed those lines into the commit message (and it is not stripped), what is the point of pointing me that it can be stripped? Something around git format-patch + git am?

I checked it and, it seems, it doesn't strip lines starting from the hash symbol, at least with my git configuration.

I observed that git am is confused by three dashes in a commit messsage (strips the commit message part after them), but since we have #14 fixed (and use pull requests, not git am), I think it is not a problem.

(Yes, I sometimes use Markdown in contexts, where just plain text is expected. It allows to copy-paste it to issue comment/pull request description/wiki page and get nice looking formatted text.)