From: Kristoffer Haugsbakk Date: Tue, 27 May 2025 21:19:31 +0000 (+0200) Subject: doc: config: mention core.commentChar on commit.cleanup X-Git-Tag: v2.50.0-rc1~11^2~7 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e2971d6f76cae5f8414f606be3c459e991093a15;p=thirdparty%2Fgit.git 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 Signed-off-by: Junio C Hamano --- diff --git a/Documentation/config/commit.adoc b/Documentation/config/commit.adoc index d3f4624fd2..208ae76c81 100644 --- a/Documentation/config/commit.adoc +++ b/Documentation/config/commit.adoc @@ -8,10 +8,11 @@ endif::git-commit[] This setting overrides the default of the `--cleanup` option in `git commit`. {see-git-commit} Changing the default can be useful when you always want to keep lines that begin - with the comment character `#` in your log message, in which case you + with the comment character (`core.commentChar`, default `#`) + in your log message, in which case you would do `git config commit.cleanup whitespace` (note that you will - have to remove the help lines that begin with `#` in the commit log - template yourself, if you do this). + have to remove the help lines that begin with the comment character + in the commit log template yourself, if you do this). `commit.gpgSign`:: A boolean to specify whether all commits should be GPG signed.