[PATCH] Documentation/SubmittingPatches: Clarify Gmail section

From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: John Tapsell <johnflux@gmail.com>,
	Junio C Hamano <gitster@pobox.com>,
	A Large Angry SCM <gitzilla@gmail.com>,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: [PATCH] Documentation/SubmittingPatches: Clarify Gmail section
Date: Wed, 7 Apr 2010 23:22:28 +0530	[thread overview]
Message-ID: <s2kf3271551004071052o58656534z80de5068b207bdb2@mail.gmail.com> (raw)

Clarify the Gmail section: the user should not touch the message body
after using "git imap-send", otherwise the patch will get mangled.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
 Documentation/SubmittingPatches |   36 ++++++++++++++++++------------------
 1 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index c686f86..ff0e1b6 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -517,15 +517,20 @@ message, complete the addressing and subject
fields, and press send.
 Gmail
 -----

-GMail does not appear to have any way to turn off line wrapping in the web
-interface, so this will mangle any emails that you send.  You can however
-use any IMAP email client to connect to the google imap server, and forward
-the emails through that.  Just make sure to disable line wrapping in that
-email client.  Alternatively, use "git send-email" instead.
+GMail does not have any way to turn off line wrapping in the web
+interface, so this will mangle any emails that you send.  You have a
+couple of options here:

-Submitting properly formatted patches via Gmail is simple now that
-IMAP support is available. First, edit your ~/.gitconfig to specify your
-account settings:
+1. Use an email client that doesn't automatically wrap lines to send
+emails through the Google SMTP server, or use "git send-email" to
+achieve the same effect.
+
+2. Use "git imap-send" to push an email to the GMail Drafts folder via
+IMAP. Then use the GMail web interface to fill out the To: and CC:
+fields, taking care not to touch the message body, and send away!
+
+To get it working, edit your ~/.gitconfig to specify your account
+settings:

 [imap]
 	folder = "[Gmail]/Drafts"
@@ -536,16 +541,11 @@ account settings:
 	sslverify = false

 You might need to instead use: folder = "[Google Mail]/Drafts" if you
get an error
-that the "Folder doesn't exist".
-
-Next, ensure that your Gmail settings are correct. In "Settings" the
-"Use Unicode (UTF-8) encoding for outgoing messages" should be checked.
+that the "Folder doesn't exist". Also ensure that under the GMail
+"Settings", the "Use Unicode (UTF-8) encoding for outgoing messages"
+is checked.

-Once your commits are ready to send to the mailing list, run the following
-command to send the patch emails to your Gmail Drafts folder.
+Once your commits are ready to send to the mailing list, run the
+following command.

 	$ git format-patch -M --stdout origin/master | git imap-send
-
-Go to your Gmail account, open the Drafts folder, find the patch email, fill
-in the To: and CC: fields and send away!
-
-- 
1.7.0.3
