Allow custom "comment char"
commiteff80a9fd990de3605063050dae32f969ef18ba8
authorJunio C Hamano <gitster@pobox.com>
Wed, 16 Jan 2013 19:18:48 +0000 (16 20:18 +0100)
committerJunio C Hamano <gitster@pobox.com>
Wed, 16 Jan 2013 20:48:22 +0000 (16 12:48 -0800)
tree6a7b0c000cea480ac8e2714cbbf92691b7237b55
parent44fe83502edf5391bb3a5997cab01794b4568062
Allow custom "comment char"

Some users do want to write a line that begin with a pound sign, #,
in their commit log message.  Many tracking system recognise
a token of #<bugid> form, for example.

The support we offer these use cases is not very friendly to the end
users.  They have a choice between

 - Don't do it.  Avoid such a line by rewrapping or indenting; and

 - Use --cleanup=whitespace but remove all the hint lines we add.

Give them a way to set a custom comment char, e.g.

    $ git -c core.commentchar="%" commit

so that they do not have to do either of the two workarounds.

[jc: although I started the topic, all the tests and documentation
updates, many of the call sites of the new strbuf_add_commented_*()
functions, and the change to git-submodule.sh scripted Porcelain are
from Ralf.]

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Ralf Thielow <ralf.thielow@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
20 files changed:
Documentation/config.txt
Documentation/git-stripspace.txt
Documentation/technical/api-strbuf.txt
builtin/branch.c
builtin/commit.c
builtin/fmt-merge-msg.c
builtin/merge.c
builtin/notes.c
builtin/stripspace.c
builtin/tag.c
cache.h
config.c
environment.c
git-submodule.sh
strbuf.c
strbuf.h
t/t0030-stripspace.sh
t/t7502-commit.sh
t/t7508-status.sh
wt-status.c