threads / patch / 15008

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

Subject: [PATCH] git format-patch documentation: clarify what --cover-letter does

## tl;dr

One message between Aug 14, 2008 and Aug 14, 2008. Diffs are folded; open one to read it.

replies: 0people: 1as markdown or json

Matt McCutchen· Aug 14, 2008, 17:37 UTC · lore
Signed-off-by: Matt McCutchen <matt@mattmccutchen.net>
---
 Documentation/git-format-patch.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
Show changes to Documentation/git-format-patch.txt +3 −3
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 010d9e4..2f1deec 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 still have
+	to fill in a description.
 
 --suffix=.<sfx>::
 	Instead of using `.patch` as the suffix for generated
-- 
1.6.0.rc3.8.g24bd

← back to recent threads