Documentation: clarify how "git commit" cleans up the edited log message
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>
Fredrik Gustafsson committed
Apr 25, 2015 at 07:42 UTC
9a35c14d64c3f76f99dd2853077e27cde2a30db7
1 file changed
+7
-4
Documentation/git-commit.txt
+7
-4
@@ -180,8 +180,8 @@ OPTIONS
180
+
181
--
182
strip::
183
- Strip leading and trailing empty lines, trailing whitespace, and
184
- #commentary and collapse consecutive empty lines.
183
+ Strip leading and trailing empty lines, trailing whitespace,
184
+ commentary and collapse consecutive empty lines.
185
whitespace::
186
Same as `strip` except #commentary is not removed.
187
verbatim::
@@ -282,8 +282,11 @@ configuration variable documented in linkgit:git-config[1].
282
--verbose::
283
Show unified diff between the HEAD commit and what
284
would be committed at the bottom of the commit message
285
- template. Note that this diff output doesn't have its
286
- lines prefixed with '#'.
285
+ template to help the user describe the commit by reminding
286
+ what changes the commit has.
287
+ Note that this diff output doesn't have its
288
+ lines prefixed with '#'. This diff will not be a part
289
+ of the commit message.
290
+
291
If specified twice, show in addition the unified diff between
292
what would be committed and the worktree files, i.e. the unstaged