summaryrefslogtreecommitdiff
path: root/Documentation/git-format-patch.txt
diff options
context:
space:
mode:
authorYann Dirson <ydirson@altern.org>2009-07-22 21:39:31 (GMT)
committerJunio C Hamano <gitster@pobox.com>2009-07-23 04:57:41 (GMT)
commitf693b7e9a5b7b009e71389310322fe864cd16046 (patch)
tree228e28804653cf940ee52832ed6d7c0e7a762c87 /Documentation/git-format-patch.txt
parent65180c6618653acf7642fc2f2d4a93afacb489d8 (diff)
downloadgit-f693b7e9a5b7b009e71389310322fe864cd16046.zip
git-f693b7e9a5b7b009e71389310322fe864cd16046.tar.gz
git-f693b7e9a5b7b009e71389310322fe864cd16046.tar.bz2
Improve doc for format-patch threading options.
This hopefully makes the relationship between threading options of format-patch and send-email easier to grasp. Signed-off-by: Yann Dirson <ydirson@altern.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-format-patch.txt')
-rw-r--r--Documentation/git-format-patch.txt22
1 files changed, 15 insertions, 7 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 6f1fc80..687e667 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -10,7 +10,7 @@ SYNOPSIS
--------
[verse]
'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]
- [--thread[=<style>]]
+ [--no-thread | --thread[=<style>]]
[(--attach|--inline)[=<boundary>] | --no-attach]
[-s | --signoff]
[-n | --numbered | -N | --no-numbered]
@@ -124,17 +124,25 @@ include::diff-options.txt[]
second part, with "Content-Disposition: inline".
--thread[=<style>]::
- 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.
+--no-thread::
+ Controls addition of In-Reply-To and References headers to
+ make the second and subsequent mails appear as replies to the
+ first. Also controls generation of the Message-Id header to
+ reference.
+
The optional <style> argument can be either `shallow` or `deep`.
'shallow' threading makes every mail a reply to the head of the
series, where the head is chosen from the cover letter, the
`\--in-reply-to`, and the first patch mail, in this order. 'deep'
-threading makes every mail a reply to the previous one. If not
-specified, defaults to the 'format.thread' configuration, or `shallow`
-if that is not set.
+threading makes every mail a reply to the previous one.
++
+The default is --no-thread, unless the 'format.thread' configuration
+is set. If --thread is specified without a style, it defaults to the
+style specified by 'format.thread' if any, or else `shallow`.
++
+Beware that the default for 'git send-email' is to thread emails
+itself. If you want 'git format-patch' to take care of hreading, you
+will want to ensure that threading is disabled for 'git send-email'.
--in-reply-to=Message-Id::
Make the first mail (or all the mails with --no-thread) appear as a