Re: [PATCH] Clarify documentation on commit message strip

[Junio C Hamano <gitster@pobox.com>]

Fredrik Gustafsson <iveqy@iveqy.com> writes:

> I agree that it is very clear once you do edit the commit message. My main
> point with this patch was to clarify -v, since it's not obvious from the
> documentation that it will be removed.

While I agree with you that the documentation should make it clear
that the patch will not be part of the commit, I think the root
cause of the current "unclear-ness" is because the documentation
does not make it clear *WHY* the "-v" option gives the patch text
there.

Doing something like this on top of your patch may clarify the
reason what "-v" is used for, and I suspect that it may even make it
unnecessary to explicitly say that the patch text will not be part
of the log message (but I didn't remove that with this "how about
this" follow-up).

 Documentation/git-commit.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 1db4c7f..617dea0 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -282,7 +282,9 @@ 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
+	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.
 +