]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: config: mention core.commentChar on commit.cleanup
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Tue, 27 May 2025 21:19:31 +0000 (23:19 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 27 May 2025 22:31:06 +0000 (15:31 -0700)
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>
Documentation/config/commit.adoc

index d3f4624fd27811238a99eade43a85c396b8c4552..208ae76c816f3b3113596289386d872ff590ed5a 100644 (file)
@@ -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.