summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-06-05 12:00:26 -0700
committerJunio C Hamano <gitster@pobox.com>2015-06-05 12:00:26 -0700
commit48feda5873deab617a368df0af4bc10a0731124c (patch)
tree362f7e686349fc12b0e156b3b37e313d4b84b69d
parent5c2e65497be246c6b61e772e79f54b346baf5f49 (diff)
parent9a35c14d64c3f76f99dd2853077e27cde2a30db7 (diff)
downloadgit-48feda5873deab617a368df0af4bc10a0731124c.tar.gz
Merge branch 'fg/document-commit-message-stripping' into maint
* fg/document-commit-message-stripping: Documentation: clarify how "git commit" cleans up the edited log message
-rw-r--r--Documentation/git-commit.txt11
1 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 617e29b38b..617dea083e 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -180,8 +180,8 @@ OPTIONS
+
--
strip::
- Strip leading and trailing empty lines, trailing whitespace, and
- #commentary and collapse consecutive empty lines.
+ Strip leading and trailing empty lines, trailing whitespace,
+ commentary and collapse consecutive empty lines.
whitespace::
Same as `strip` except #commentary is not removed.
verbatim::
@@ -282,8 +282,11 @@ configuration variable documented in linkgit:git-config[1].
--verbose::
Show unified diff between the HEAD commit and what
would be committed at the bottom of the commit message
- template. Note that this diff output doesn't have its
- lines prefixed with '#'.
+ template to help the user describe the commit by reminding
+ what changes the commit has.
+ Note that this diff output doesn't have its
+ lines prefixed with '#'. This diff will not be a part
+ of the commit message.
+
If specified twice, show in addition the unified diff between
what would be committed and the worktree files, i.e. the unstaged