diff options
| author | Kristoffer Haugsbakk <code@khaugsbakk.name> | 2025-05-27 23:19:31 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-05-27 15:31:06 -0700 |
| commit | e2971d6f76cae5f8414f606be3c459e991093a15 (patch) | |
| tree | 9cc6ca0edea001a93aa8a85fa0f24055b63f2221 /Documentation/config/commit.adoc | |
| parent | doc: stripspace: mention where the default comes from (diff) | |
| download | git-e2971d6f76cae5f8414f606be3c459e991093a15.tar.gz git-e2971d6f76cae5f8414f606be3c459e991093a15.zip | |
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>
Diffstat (limited to 'Documentation/config/commit.adoc')
| -rw-r--r-- | Documentation/config/commit.adoc | 7 |
1 files changed, 4 insertions, 3 deletions
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. |