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>
Philip Oakley committed
Oct 21, 2012 at 22:34 UTC
d84cef1817be9615729b26e3965e8cb8da926dc5
1 file changed
+7
Documentation/user-manual.txt
+7
@@ -1787,6 +1787,13 @@ $ git format-patch origin
1787
will produce a numbered series of files in the current directory, one
1788
for each patch in the current branch but not in origin/HEAD.
1789
1790
+`git format-patch` can include an initial "cover letter". You can insert
1791
+commentary on individual patches after the three dash line which
1792
+`format-patch` places after the commit message but before the patch
1793
+itself. If you use `git notes` to track your cover letter material,
1794
+`git format-patch --notes` will include the commit's notes in a similar
1795
+manner.
1796
+
1797
You can then import these into your mail client and send them by
1798
hand. However, if you have a lot to send at once, you may prefer to
1799
use the linkgit:git-send-email[1] script to automate the process.