Merge branch 'jc/skip-count'

[git.git] / Documentation / git-format-patch.txt

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 493cac22dbe16dd5bdb9eed8f91f93ea184fa622..67425dc0359ee9774200e1a2e12913d570117e7c 100644 (file)
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -9,8 +9,9 @@ git-format-patch - Prepare patches for e-mail submission
 SYNOPSIS
 --------
 [verse]
-'git-format-patch' [-n | -k] [-o <dir> | --stdout] [--attach]
+'git-format-patch' [-n | -k] [-o <dir> | --stdout] [--attach] [--thread]
                   [-s | --signoff] [--diff-options] [--start-number <n>]
+                  [--in-reply-to=Message-Id]
                   <since>[..<until>]
 
 DESCRIPTION
@@ -35,13 +36,16 @@ they are created in the current working directory.
 If -n is specified, instead of "[PATCH] Subject", the first line
 is formatted as "[PATCH n/m] Subject".
 
+If given --thread, git-format-patch will generate In-Reply-To and
+References headers to make the second and subsequent patch mails appear
+as replies to the first mail; this also generates a Message-Id header to
+reference.
 
 OPTIONS
 -------
 -o|--output-directory <dir>::
        Use <dir> to store the resulting files, instead of the
-       current working directory. This option is ignored if
-       --stdout is specified.
+       current working directory.
 
 -n|--numbered::
        Name output in '[PATCH n/m]' format.
@@ -64,6 +68,15 @@ OPTIONS
 --attach::
        Create attachments instead of inlining patches.
 
+--thread::
+       Add In-Reply-To and References headers to make the second and
+       subsequent mails appear as replies to the first.  Also generates
+       the Message-Id header to reference.
+
+--in-reply-to=Message-Id::
+       Make the first mail (or all the mails with --no-thread) appear as a
+       reply to the given Message-Id, which avoids breaking threads to
+       provide a new patch series.
 
 CONFIGURATION
 -------------