diff options
| author | Fredrik Gustafsson <iveqy@iveqy.com> | 2015-04-25 07:42:45 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-04-27 11:32:55 -0700 |
| commit | 9a35c14d64c3f76f99dd2853077e27cde2a30db7 (patch) | |
| tree | 1ae59a4f360d6e0a0cf780bc8802d3048cfc6274 | |
| parent | 564705c7f0938107f372cc1aa3a54689f30473bf (diff) | |
| download | git-fg/document-commit-message-stripping.tar.gz | |
Documentation: clarify how "git commit" cleans up the edited log messagefg/document-commit-message-stripping
The `-v` shows a unified diff in the editor to edit the commit
message to help the user to describe the change. The diff is
stripped and will not become a part of the commit message.
Add a note about this with the `-v` description and slightly modify
the description for the default `--cleanup` mode.
Signed-off-by: Fredrik Gustafsson <iveqy@iveqy.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-commit.txt | 11 |
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 |