freshlybakedca.ke
Git fork
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 <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
authored by
Kristoffer Haugsbakk
and committed by
Junio C Hamano
e2971d6f
e2de9b35
+4
-3
Documentation/config/commit.adoc
+4
-3
Documentation/config/commit.adoc
···
8
8
This setting overrides the default of the `--cleanup` option in
9
9
`git commit`. {see-git-commit} Changing the default can be useful
10
10
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
12
13
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).
15
16
16
17
`commit.gpgSign`::
17
18
A boolean to specify whether all commits should be GPG signed.