summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorNguyễn Thái Ngọc Duy <pclouds@gmail.com>2014-05-17 01:52:23 (GMT)
committerJunio C Hamano <gitster@pobox.com>2014-05-19 20:37:25 (GMT)
commit84c9dc2c5a2d34351a06554af32501d4f99990e9 (patch)
tree737dde6bdaab102e46f8694558c3645aaeecb1fa /Documentation
parent50b54fd72a8776d628365c7760bc922902d29d11 (diff)
downloadgit-84c9dc2c5a2d34351a06554af32501d4f99990e9.zip
git-84c9dc2c5a2d34351a06554af32501d4f99990e9.tar.gz
git-84c9dc2c5a2d34351a06554af32501d4f99990e9.tar.bz2
commit: allow core.commentChar=auto for character auto selection
When core.commentChar is "auto", the comment char starts with '#' as in default but if it's already in the prepared message, find another char in a small subset. This should stop surprises because git strips some lines unexpectedly. Note that git is not smart enough to recognize '#' as the comment char in custom templates and convert it if the final comment char is different. It thinks '#' lines in custom templates as part of the commit message. So don't use this with custom templates. Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1932e9b..9f3ce06 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -544,6 +544,9 @@ core.commentchar::
messages consider a line that begins with this character
commented, and removes them after the editor returns
(default '#').
++
+If set to "auto", `git-commit` would select a character that is not
+the beginning character of any line in existing commit messages.
sequence.editor::
Text editor used by `git rebase -i` for editing the rebase instruction file.