[PATCH] Update documentation to add further information about using Thunderbird with git-imap-send.

[PATCH] Update documentation to add further information about using Thunderbird with git-imap-send.

[Jeremy White]

Signed-off-by: Jeremy White <jwhite@codeweavers.com>
---
 Documentation/SubmittingPatches |   27 +++++++++++++++++++++++++++
 Documentation/git-imap-send.txt |   14 ++++++++++++++
 2 files changed, 41 insertions(+), 0 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index ba07c8c..add055e 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -376,9 +376,36 @@ Thunderbird
 
 (A Large Angry SCM)
 
+By default, Thunderbird will both wrap emails as well as flag them as
+being 'format=flowed', both of which will make the resulting email unusable
+by git.
+
 Here are some hints on how to successfully submit patches inline using
 Thunderbird.
 
+There are two different approaches.  One approach is to configure
+Thunderbird to not mangle patches.  The second approach is to use
+an external editor to keep Thunderbird from mangling the patches.
+
+Approach #1 (configuration):
+
+This recipe is current as of Thunderbird 2.0.0.19.  Three steps:
+  1.  Configure your mail server composition as plain text
+      Edit...Account Settings...Composition & Addressing,
+        uncheck 'Compose Messages in HTML'.
+  2.  Configure your general composition window to not wrap
+      Edit..Preferences..Composition, wrap plain text messages at 0
+  3.  Disable the use of format=flowed
+      Edit..Preferences..Advanced..Config Editor.  Search for:
+        mailnews.send_plaintext_flowed
+      toggle it to make sure it is set to 'true'.
+
+After that is done, you should be able to compose email as you
+otherwise would (cut + paste, git-format-patch | git-imap-send, etc),
+and the patches should not be mangled.
+
+Approach #2 (external editor):
+
 This recipe appears to work with the current [*1*] Thunderbird from Suse.
 
 The following Thunderbird extensions are needed:
diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index bd49a0a..1685f04 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -98,6 +98,20 @@ Using direct mode with SSL:
 ..........................
 
 
+CAUTION
+-------
+It is still your responsibility to make sure that the email message
+sent by your email program meets the standards of your project.
+Many projects do not like patches to be attached.  Some mail
+agents will transform patches (e.g. wrap lines, send them as
+format=flowed) in ways that make them fail.  You will get angry
+flames ridiculing you if you don't check this.
+
+Thunderbird in particular is known to be problematic.  Thunderbird
+users may wish to visit this web page for more information:
+  http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
+
+
 BUGS
 ----
 Doesn't handle lines starting with "From " in the message body.
-- 
1.6.2.rc0.dirty

[PATCH] Update documentation to add further information about using Thunderbird with git-imap-send.

[Jeremy White]

Signed-off-by: Jeremy White <jwhite@codeweavers.com>
---
 Documentation/SubmittingPatches |   27 +++++++++++++++++++++++++++
 Documentation/git-imap-send.txt |   14 ++++++++++++++
 2 files changed, 41 insertions(+), 0 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index ba07c8c..add055e 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -376,9 +376,36 @@ Thunderbird
 
 (A Large Angry SCM)
 
+By default, Thunderbird will both wrap emails as well as flag them as
+being 'format=flowed', both of which will make the resulting email unusable
+by git.
+
 Here are some hints on how to successfully submit patches inline using
 Thunderbird.
 
+There are two different approaches.  One approach is to configure
+Thunderbird to not mangle patches.  The second approach is to use
+an external editor to keep Thunderbird from mangling the patches.
+
+Approach #1 (configuration):
+
+This recipe is current as of Thunderbird 2.0.0.19.  Three steps:
+  1.  Configure your mail server composition as plain text
+      Edit...Account Settings...Composition & Addressing,
+        uncheck 'Compose Messages in HTML'.
+  2.  Configure your general composition window to not wrap
+      Edit..Preferences..Composition, wrap plain text messages at 0
+  3.  Disable the use of format=flowed
+      Edit..Preferences..Advanced..Config Editor.  Search for:
+        mailnews.send_plaintext_flowed
+      toggle it to make sure it is set to 'true'.
+
+After that is done, you should be able to compose email as you
+otherwise would (cut + paste, git-format-patch | git-imap-send, etc),
+and the patches should not be mangled.
+
+Approach #2 (external editor):
+
 This recipe appears to work with the current [*1*] Thunderbird from Suse.
 
 The following Thunderbird extensions are needed:
diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index bd49a0a..1685f04 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -98,6 +98,20 @@ Using direct mode with SSL:
 ..........................
 
 
+CAUTION
+-------
+It is still your responsibility to make sure that the email message
+sent by your email program meets the standards of your project.
+Many projects do not like patches to be attached.  Some mail
+agents will transform patches (e.g. wrap lines, send them as
+format=flowed) in ways that make them fail.  You will get angry
+flames ridiculing you if you don't check this.
+
+Thunderbird in particular is known to be problematic.  Thunderbird
+users may wish to visit this web page for more information:
+  http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
+
+
 BUGS
 ----
 Doesn't handle lines starting with "From " in the message body.

Re: [PATCH] Update documentation to add further information about using Thunderbird with git-imap-send.

[Jakub Narebski]

<opublikowany i wysłany>

Jeremy White wrote:

> +  3.  Disable the use of format=flowed
> +      Edit..Preferences..Advanced..Config Editor.  Search for:
> +        mailnews.send_plaintext_flowed
> +      toggle it to make sure it is set to 'true'.

Errr... you are sure that it should be 'true' and not 'false' here?

-- 
Jakub Narebski
Warsaw, Poland
ShadeHawk on #git

Re: [PATCH] Update documentation to add further information about using Thunderbird with git-imap-send.

[Junio C Hamano]

Jeremy White <jwhite@codeweavers.com> writes:

> +  3.  Disable the use of format=flowed
> +      Edit..Preferences..Advanced..Config Editor.  Search for:
> +        mailnews.send_plaintext_flowed
> +      toggle it to make sure it is set to 'true'.

True???

Re: [PATCH] Update documentation to add further information about using Thunderbird with git-imap-send.

[Randy Dunlap]

Junio C Hamano wrote:
> Jeremy White <jwhite@codeweavers.com> writes:
> 
>> +  3.  Disable the use of format=flowed
>> +      Edit..Preferences..Advanced..Config Editor.  Search for:
>> +        mailnews.send_plaintext_flowed
>> +      toggle it to make sure it is set to 'true'.
> 
> True???

Hi,

Someone else questioned (corrected) that as well.  It also
conflicts with the Linux kernel file:Documentation/email-clients.txt (extract):

- Edit your Thunderbird config settings so that it won't use format=flowed:
      user_pref("mailnews.send_plaintext_flowed", false);


~Randy

Re: [PATCH] Update documentation to add further information about using Thunderbird with git-imap-send.

[Jeremy White]

> True???

Yeah, TB got me.  They have two options; one is 'disable...flowed', and you
set that one to true.  The other (relevant here) is 'send...flowed', and that's
supposed to be false.  Jakub Narebski had caught that for me earlier; correct patch
sent.

Cheers,

Jeremy