summaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
diff options
context:
space:
mode:
authorPhilip Oakley <philipoakley@iee.org>2012-10-21 21:34:08 (GMT)
committerJeff King <peff@peff.net>2012-10-26 14:31:38 (GMT)
commitd84cef1817be9615729b26e3965e8cb8da926dc5 (patch)
treebfda5743d1e648769ff82b2b232efe8b03de9810 /Documentation/user-manual.txt
parent6454d9f166236965c84650f72ecdd17e309394d6 (diff)
downloadgit-d84cef1817be9615729b26e3965e8cb8da926dc5.zip
git-d84cef1817be9615729b26e3965e8cb8da926dc5.tar.gz
git-d84cef1817be9615729b26e3965e8cb8da926dc5.tar.bz2
Doc User-Manual: Patch cover letter, three dashes, and --notes
Show that git format-patch can have a cover letter, include patch commentary below the three dashes, and notes can also be included. Signed-off-by: Philip Oakley <philipoakley@iee.org> Signed-off-by: Jeff King <peff@peff.net>
Diffstat (limited to 'Documentation/user-manual.txt')
-rw-r--r--Documentation/user-manual.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 85651b5..1b377dc 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1787,6 +1787,13 @@ $ git format-patch origin
will produce a numbered series of files in the current directory, one
for each patch in the current branch but not in origin/HEAD.
+`git format-patch` can include an initial "cover letter". You can insert
+commentary on individual patches after the three dash line which
+`format-patch` places after the commit message but before the patch
+itself. If you use `git notes` to track your cover letter material,
+`git format-patch --notes` will include the commit's notes in a similar
+manner.
+
You can then import these into your mail client and send them by
hand. However, if you have a lot to send at once, you may prefer to
use the linkgit:git-send-email[1] script to automate the process.