[PATCH v2] doc: about email clients for Linux patches

Previous thread: [PATCH -mm] ssb: Make pcmciahost depend on PCMCIA=y by Paul Mundt on Tuesday, September 11, 2007 - 10:11 pm. (7 messages)

Next thread: [PATCH] bfin_twi: Remove useless twi_lock mutex by Bryan Wu on Tuesday, September 11, 2007 - 11:48 pm. (1 message)
To: lkml <linux-kernel@...>
Cc: akpm <akpm@...>, jgarzik <jgarzik@...>
Date: Tuesday, September 11, 2007 - 11:42 pm

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

Requested by Jeff Garzik.
v2, updated from lkml comments.

Add info about various email clients and their applicability
in being used to send Linux kernel patches.

Some notes takes from http://mbligh.org/linuxdocs/Email/Clients
Portions used with permission.

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

--- /dev/null
+++ linux-2.6.23-rc5-git1/Documentation/email-clients.txt
@@ -0,0 +1,210 @@
+Email clients info for Linux
+======================================================================
+
+General Preferences
+----------------------------------------------------------------------
+Patches for the Linux kernel are submitted via email, preferably as
+inline text in the body of the email. Some maintainers accept
+attachments, but then the attachments should have content-type
+"text/plain". However, attachments are generally frowned upon because
+it makes quoting portions of the patch more difficult in the patch
+review process.
+
+Email clients that are used for Linux kernel patches should send the
+patch text untouched. For example, they should not modify or delete tabs
+or spaces, even at the beginning or end of lines.
+
+Don't send patches with "format=flowed". This can cause unexpected
+and unwanted line breaks.
+
+Don't let your email client do automatic word wrapping for you.
+This can also corrupt your patch.
+
+<Question about character set encoding/code pages:>
+They also should not modify the character set encoding of the text.
+
+Email clients should generate and maintain References: or In-Reply-To:
+headers so that mail threading is not broken.
+
+Copy-and-paste (or cut-and-paste) usually does not work for patches
+because tabs are converted to spaces. I have seen comments that
+xclipboard, xclip, and/or xcutsel do work, but I cannot confirm this.
+
+Do...

Previous thread: [PATCH -mm] ssb: Make pcmciahost depend on PCMCIA=y by Paul Mundt on Tuesday, September 11, 2007 - 10:11 pm. (7 messages)

Next thread: [PATCH] bfin_twi: Remove useless twi_lock mutex by Bryan Wu on Tuesday, September 11, 2007 - 11:48 pm. (1 message)