Skip to content

Commit

Permalink
Documentation: clarify how "git commit" cleans up the edited log message
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Fredrik Gustafsson authored and Junio C Hamano committed Apr 27, 2015
1 parent 564705c commit 9a35c14
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions Documentation/git-commit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 9a35c14

Please sign in to comment.