aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/config/commit.adoc
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2025-05-30 11:59:17 -0700
committerJunio C Hamano <gitster@pobox.com>2025-05-30 11:59:17 -0700
commit1a140c870d1fe069387d13c68d5e219b466a0af6 (patch)
tree62cb60e241ed4bda9e05f156ce5772b5cc028f76 /Documentation/config/commit.adoc
parentMerge branch 'mm/apply-reverse-mode-of-deleted-path' (diff)
parentdoc: notes: use stuck form throughout (diff)
downloadgit-1a140c870d1fe069387d13c68d5e219b466a0af6.tar.gz
git-1a140c870d1fe069387d13c68d5e219b466a0af6.zip
Merge branch 'kh/notes-doc-fixes'
"git notes --help" documentation updates. * kh/notes-doc-fixes: doc: notes: use stuck form throughout doc: notes: treat --stdin equally between copy/remove doc: notes: point out copy --stdin use with argv doc: notes: clearly state that --stripspace is the default doc: notes: remove stripspace discussion from other options doc: notes: rework --[no-]stripspace doc: notes: split out options with negated forms doc: config: mention core.commentChar on commit.cleanup doc: stripspace: mention where the default comes from
Diffstat (limited to 'Documentation/config/commit.adoc')
-rw-r--r--Documentation/config/commit.adoc7
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.