From: Matt McCutchen <matt@mattmccutchen.net>
Date: Thu, 14 Aug 2008 17:37:41 +0000 (-0400)
Subject: git format-patch documentation: clarify what --cover-letter does
X-Git-Tag: v1.6.0~16
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f491239170cb1463c7c3cd970862d6de636ba787;p=git

git format-patch documentation: clarify what --cover-letter does

Signed-off-by: Matt McCutchen <matt@mattmccutchen.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 010d9e4322..adb4ea7b1b 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -147,9 +147,9 @@ include::diff-options.txt[]
 	to any configured headers, and may be used multiple times.
 
 --cover-letter::
-	Generate a cover letter template.  You still have to fill in
-	a description, but the shortlog and the diffstat will be
-	generated for you.
+	In addition to the patches, generate a cover letter file
+	containing the shortlog and the overall diffstat.  You can
+	fill in a description in the file before sending it out.
 
 --suffix=.<sfx>::
 	Instead of using `.patch` as the suffix for generated