[PATCH v3 2/9] doc: config: mention core.commentChar on commit.cleanup
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- May 27, 2025, 21:19 UTC
- Message-ID
- <e9cf956a824c888b7313d6a2ff5c513374b3e40e.1748380390.git.code@khaugsbakk.name>
- In-Reply-To
- <cover.1748380390.git.code@khaugsbakk.name>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
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> --- Documentation/config/commit.adoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/config/commit.adoc b/Documentation/config/commit.adoc index d3f4624fd27..208ae76c816 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.
-- 2.49.0.780.g892193c3f50