[PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Michael Opdenacker]

Applies to 2.6.24-rc8-git2

I was struggling to get my email-client no to mangle my patch files,
and I didn't find enough information in the SubmittingPatches file.
By looking for more information on the web, I eventually found the
email-clients.txt file, and it answered all my needs

This patch adds a reference to email-clients.txt in SubmittingPatches,
and Mozilla related information which is no longer accurate
(as opposed to the details found in email-clients.txt).

This should be helpful for people sending their first patches,
or not sending patches on a frequent basis.

Michael.

--
Signed-off-by: Michael Opdenacker <michael@free-electrons.com>

diff -Naur linux-2.6.24-rc8-git2/Documentation/SubmittingPatches linux-2.6.24-rc8-git2-sp/Documentation/SubmittingPatches
--- linux-2.6.24-rc8-git2/Documentation/SubmittingPatches	2008-01-17 09:48:56.000000000 +0100
+++ linux-2.6.24-rc8-git2-sp/Documentation/SubmittingPatches	2008-01-18 10:29:46.000000000 +0100
@@ -220,20 +220,8 @@
 Exception:  If your mailer is mangling patches then someone may ask
 you to re-send them using MIME.
 
-
-WARNING: Some mailers like Mozilla send your messages with
----- message header ----
-Content-Type: text/plain; charset=us-ascii; format=flowed
----- message header ----
-The problem is that "format=flowed" makes some of the mailers
-on receiving side to replace TABs with spaces and do similar
-changes. Thus the patches from you can look corrupted.
-
-To fix this just make your mozilla defaults/pref/mailnews.js file to look like:
-pref("mailnews.send_plaintext_flowed", false); // RFC 2646=======
-pref("mailnews.display.disable_format_flowed_support", true);
-
-
+See Documentation/email-clients.txt for hints about configuring
+your e-mail client so that it sends your patches untouched.
 
 8) E-mail size.
 

-- 
Michael Opdenacker, Free Electrons
Free Embedded Linux Training Materials
on http://free-electrons.com/training
(More than 1500 pages!)

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Randy Dunlap]

On Fri, 18 Jan 2008 11:20:02 +0100 Michael Opdenacker wrote:

> Applies to 2.6.24-rc8-git2
> 
> I was struggling to get my email-client no to mangle my patch files,
> and I didn't find enough information in the SubmittingPatches file.
> By looking for more information on the web, I eventually found the
> email-clients.txt file, and it answered all my needs
> 
> This patch adds a reference to email-clients.txt in SubmittingPatches,
> and Mozilla related information which is no longer accurate
> (as opposed to the details found in email-clients.txt).
> 
> This should be helpful for people sending their first patches,
> or not sending patches on a frequent basis.
> 
> Michael.
> 
> --
> Signed-off-by: Michael Opdenacker <michael@free-electrons.com>

Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

Thanks.

> diff -Naur linux-2.6.24-rc8-git2/Documentation/SubmittingPatches linux-2.6.24-rc8-git2-sp/Documentation/SubmittingPatches
> --- linux-2.6.24-rc8-git2/Documentation/SubmittingPatches	2008-01-17 09:48:56.000000000 +0100
> +++ linux-2.6.24-rc8-git2-sp/Documentation/SubmittingPatches	2008-01-18 10:29:46.000000000 +0100
> @@ -220,20 +220,8 @@
>  Exception:  If your mailer is mangling patches then someone may ask
>  you to re-send them using MIME.
>  
> -
> -WARNING: Some mailers like Mozilla send your messages with
> ----- message header ----
> -Content-Type: text/plain; charset=us-ascii; format=flowed
> ----- message header ----
> -The problem is that "format=flowed" makes some of the mailers
> -on receiving side to replace TABs with spaces and do similar
> -changes. Thus the patches from you can look corrupted.
> -
> -To fix this just make your mozilla defaults/pref/mailnews.js file to look like:
> -pref("mailnews.send_plaintext_flowed", false); // RFC 2646=======
> -pref("mailnews.display.disable_format_flowed_support", true);
> -
> -
> +See Documentation/email-clients.txt for hints about configuring
> +your e-mail client so that it sends your patches untouched.
>  
>  8) E-mail size.
>  
> 
> -- 

---
~Randy

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Paul Jackson]

Randy -- any idea why the Documentation/email-clients.txt file states:

    Sylpheed (GUI)
     ...
    - Not good for IMAP.                                                                                                              

I've been happily using Sylpheed with IMAP ... I wonder what I'm missing ;)

-- 
                  I won't rest till it's the best ...
                  Programmer, Linux Scalability
                  Paul Jackson <pj@sgi.com> 1.940.382.4214

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Randy Dunlap]

On Mon, 28 Jan 2008 09:52:45 -0600 Paul Jackson wrote:

> Randy -- any idea why the Documentation/email-clients.txt file states:
> 
>     Sylpheed (GUI)
>      ...
>     - Not good for IMAP.                                                                                                              
> 
> I've been happily using Sylpheed with IMAP ... I wonder what I'm missing ;)

Hi Paul,

I think that this is based on filtering to folders.
Does Sylpheed IMAP do filtering for you?

It does not according to the Sylpheed FAQ, but the FAQ is
extremely out of date.

The doc file can also be amended with whatever we decide here.

Thanks,
---
~Randy

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Paul Jackson]

Randy wrote:
> Does Sylpheed IMAP do filtering for you?
> 
> It does not according to the Sylpheed FAQ, but the FAQ is
> extremely out of date.

You are correct that the Sylpheed FAQ, such as at:

    http://sylpheeddoc.sourceforge.net/en/faq/faq-1.html

states:

    1.8 Q08 Does Sylpheed have mail filtering?
    A. Yes. You can find it in Configuration -> filtering tab.
    Please note that filtering is not yet implemented for IMAP accounts. 

And you are correct -- that FAQ is out of date.  It seems to be
dated 2002.

To answer your question, yes filtering now works fine on IMAP folders
using Sylpheed.  I make heavy use of it.  I'm using Sylpheed version
2.2.4 at the moment.

===

Be that as it may, whether Sylpheed IMAP folder filters worked or not,
I'd suggest that the Documentation/email-clients.txt file not engage
in evaluation of the general purpose feature sets of various email
clients, but rather confine itself to what matters to the kernel
mailing list, such as how to get patches formatted correctly.

-- 
                  I won't rest till it's the best ...
                  Programmer, Linux Scalability
                  Paul Jackson <pj@sgi.com> 1.940.382.4214

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Randy Dunlap]

Paul Jackson wrote:
> Randy wrote:
>> Does Sylpheed IMAP do filtering for you?
>>
>> It does not according to the Sylpheed FAQ, but the FAQ is
>> extremely out of date.
> 
> You are correct that the Sylpheed FAQ, such as at:
> 
>     http://sylpheeddoc.sourceforge.net/en/faq/faq-1.html
> 
> states:
> 
>     1.8 Q08 Does Sylpheed have mail filtering?
>     A. Yes. You can find it in Configuration -> filtering tab.
>     Please note that filtering is not yet implemented for IMAP accounts. 
> 
> And you are correct -- that FAQ is out of date.  It seems to be
> dated 2002.
> 
> To answer your question, yes filtering now works fine on IMAP folders
> using Sylpheed.  I make heavy use of it.  I'm using Sylpheed version
> 2.2.4 at the moment.
> 
> ===
> 
> Be that as it may, whether Sylpheed IMAP folder filters worked or not,
> I'd suggest that the Documentation/email-clients.txt file not engage
> in evaluation of the general purpose feature sets of various email
> clients, but rather confine itself to what matters to the kernel
> mailing list, such as how to get patches formatted correctly.

Agreed.  I'll modify it.

-- 
~Randy

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

cc: Paul Jackson <pj@sgi.com>

This comment is not helpful (no reason given) and is incorrect.
Just stick to facts that are useful regarding working on Linux.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/email-clients.txt |    1 -
 1 file changed, 1 deletion(-)

--- linux-2.6.24-git4.orig/Documentation/email-clients.txt
+++ linux-2.6.24-git4/Documentation/email-clients.txt
@@ -170,7 +170,6 @@ Sylpheed (GUI)
 
 - Works well for inlining text (or using attachments).
 - Allows use of an external editor.
-- Not good for IMAP.
 - Is slow on large folders.
 - Won't do TLS SMTP auth over a non-SSL connection.
 - Has a helpful ruler bar in the compose window.

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Paul Jackson]

Regarding Randy's patch:
+++ linux-2.6.24-git4/Documentation/email-clients.txt
@@ -170,7 +170,6 @@ Sylpheed (GUI)

Acked-by: Paul Jackson <pj@sgi.com>

-- 
                  I won't rest till it's the best ...
                  Programmer, Linux Scalability
                  Paul Jackson <pj@sgi.com> 1.940.382.4214

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Paul Jackson]

> Agreed.  I'll modify it.

Ok.  Thanks.

No hurry; I probably shouldn't even
have worried about this in the first
place.

-- 
                  I won't rest till it's the best ...
                  Programmer, Linux Scalability
                  Paul Jackson <pj@sgi.com> 1.940.382.4214

Re: [PATCH] Documentation: mention email-clients.txt in SubmittingPatches

[Jeff Garzik]

Michael Opdenacker wrote:
> Applies to 2.6.24-rc8-git2
> 
> I was struggling to get my email-client no to mangle my patch files,
> and I didn't find enough information in the SubmittingPatches file.
> By looking for more information on the web, I eventually found the
> email-clients.txt file, and it answered all my needs
> 
> This patch adds a reference to email-clients.txt in SubmittingPatches,
> and Mozilla related information which is no longer accurate
> (as opposed to the details found in email-clients.txt).
> 
> This should be helpful for people sending their first patches,
> or not sending patches on a frequent basis.
> 
> Michael.
> 
> --
> Signed-off-by: Michael Opdenacker <michael@free-electrons.com>

ACK