diff options
| author |  Philip Oakley <philipoakley@iee.org> | 2012-10-21 22:34:08 +0100 |
|---|---|---|
| committer |  Jeff King <peff@peff.net> | 2012-10-26 10:31:38 -0400 |
| commit | d84cef1817be9615729b26e3965e8cb8da926dc5 (patch) | |
| tree | bfda5743d1e648769ff82b2b232efe8b03de9810 | |
| parent | Doc format-patch: clarify --notes use case (diff) | |
| download | tgif-d84cef1817be9615729b26e3965e8cb8da926dc5.tar.xz | |
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>
| -rw-r--r-- | Documentation/user-manual.txt | 7 |
1 files changed, 7 insertions, 0 deletions
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. |