kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

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>
maint
Kristoffer Haugsbakk 2025-05-27 23:19:31 +02:00 committed by Junio C Hamano
parent e2de9b354f
commit e2971d6f76
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/config/commit.adoc
View 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.