Skip to content

Commit e2971d6

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: config: mention core.commentChar on commit.cleanup
Mention it in parentheses since we are in a configuration context. Refer to the default as such, not as “the” character. Also don’t mention `#` again; just say “comment character”. Signed-off-by: Kristoffer Haugsbakk <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e2de9b3 commit e2971d6

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Documentation/config/commit.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ endif::git-commit[]
88
This setting overrides the default of the `--cleanup` option in
99
`git commit`. {see-git-commit} Changing the default can be useful
1010
when you always want to keep lines that begin
11-
with the comment character `#` in your log message, in which case you
11+
with the comment character (`core.commentChar`, default `#`)
12+
in your log message, in which case you
1213
would do `git config commit.cleanup whitespace` (note that you will
13-
have to remove the help lines that begin with `#` in the commit log
14-
template yourself, if you do this).
14+
have to remove the help lines that begin with the comment character
15+
in the commit log template yourself, if you do this).
1516

1617
`commit.gpgSign`::
1718
A boolean to specify whether all commits should be GPG signed.

0 commit comments

Comments
 (0)