From: Yann Dirson <ydirson@altern.org>
To: git@vger.kernel.org
Cc: Yann Dirson <ydirson@altern.org>
Subject: [PATCH 2/2] Improve doc for format-patch threading options.
Date: Wed, 22 Jul 2009 23:39:31 +0200 [thread overview]
Message-ID: <1248298771-21075-3-git-send-email-ydirson@altern.org> (raw)
In-Reply-To: <1248298771-21075-2-git-send-email-ydirson@altern.org>
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>
---
Documentation/git-format-patch.txt | 22 +++++++++++++++-------
Documentation/git-send-email.txt | 21 ++++++++++++++++-----
2 files changed, 31 insertions(+), 12 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
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index fbde2d3..d6b192b 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -212,11 +212,22 @@ specified, as well as 'body' if --no-signed-off-cc is specified.
value; if that is unspecified, default to --no-suppress-from.
--[no-]thread::
- If this is set, the In-Reply-To header will be set on each email sent.
- If disabled with "--no-thread", no emails will have the In-Reply-To
- header set, unless specified with --in-reply-to.
- Default is the value of the 'sendemail.thread' configuration
- value; if that is unspecified, default to --thread.
+ If this is set, the In-Reply-To and References headers will be
+ added to each email sent. Whether each mail refers to the
+ previous email (`deep` threading per 'git format-patch'
+ wording) or to the first email (`shallow` threading) is
+ governed by "--[no-]chain-reply-to".
++
+If disabled with "--no-thread", those headers will not be added
+(unless specified with --in-reply-to). Default is the value of the
+'sendemail.thread' configuration value; if that is unspecified,
+default to --thread.
++
+It is up to the user to ensure that no In-Reply-To header already
+exists when 'git send-email' is asked to add it (especially note that
+'git format-patch' can be configured to do the threading itself).
+Failure to do so may not produce the expected result in the
+recipient's MUA.
Administering
--
1.6.4.rc1.12.g05859c
next prev parent reply other threads:[~2009-07-22 21:39 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-07-05 23:05 [WIP PATCH 0/2] format-patch / send-mail thrading documentation Yann Dirson
2009-07-05 23:05 ` [PATCH 1/2] List send-email config options in config.txt Yann Dirson
2009-07-05 23:05 ` [PATCH 2/2] Improve doc for format-patch threading options Yann Dirson
2009-07-06 8:36 ` Markus Heidelberg
2009-07-06 8:49 ` Markus Heidelberg
2009-07-16 22:23 ` Yann Dirson
2009-07-16 22:58 ` Markus Heidelberg
2009-07-17 6:52 ` Yann Dirson
2009-07-17 23:23 ` Markus Heidelberg
2009-07-22 20:57 ` Yann Dirson
2009-07-06 6:58 ` [PATCH 1/2] List send-email config options in config.txt Junio C Hamano
2009-07-16 21:20 ` Yann Dirson
2009-07-22 21:39 ` [PATCHv2 0/2] format-patch / send-mail threading documentation Yann Dirson
2009-07-22 21:39 ` [PATCH 1/2] List send-email config options in config.txt Yann Dirson
2009-07-22 21:39 ` Yann Dirson [this message]
2009-07-23 5:31 ` [PATCH 2/2] Improve doc for format-patch threading options Markus Heidelberg
2009-07-22 22:10 ` [PATCHv2 0/2] format-patch / send-mail threading documentation Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1248298771-21075-3-git-send-email-ydirson@altern.org \
--to=ydirson@altern.org \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).