From d84cef1817be9615729b26e3965e8cb8da926dc5 Mon Sep 17 00:00:00 2001 From: Philip Oakley Date: Sun, 21 Oct 2012 22:34:08 +0100 Subject: [PATCH] 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 Signed-off-by: Jeff King --- Documentation/user-manual.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 85651b57ae..1b377dc207 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.