[PATCH] Documentation/SubmittingPatches: Clarify Gmail section

Ramkumar Ramachandra· Apr 7, 2010, 17:52 UTC · lore

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(-)

Show changes to Documentation/SubmittingPatches +18 −18

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

Ramkumar Ramachandra· Apr 7, 2010, 18:08 UTC · re: Ramkumar Ramachandra · lore

Re: [PATCH] Documentation/SubmittingPatches: Clarify Gmail section

Hi,

I can't be sure that I'm right about this. Could someone please confirm? Ironically, this patch seems to be broken. I think it has something to do with the auto-save (for drafts) in the web interface.

-- Ram

Junio C Hamano· Apr 7, 2010, 19:09 UTC · re: Ramkumar Ramachandra · lore

Re: [PATCH] Documentation/SubmittingPatches: Clarify Gmail section

Ramkumar Ramachandra <artagnon@gmail.com> writes:

> I can't be sure that I'm right about this. Could someone please confirm?
> Ironically, this patch seems to be broken. I think it has something to
> do with the auto-save (for drafts) in the web interface.

Didn't I already say that it is _known_ not to work?

As you earlier said that the documentation of imap-send states GMail web works, perhaps that description is incorrect and needs fixing.

See the thread that begins with this message in the archive:

    Message-ID: <1265555642-40204-1-git-send-email-git@aaroncrane.co.uk>
    From: Aaron Crane <git@aaroncrane.co.uk>
    Subject: [PATCH] Documentation/SubmittingPatches: fix Gmail workaround advice
    Date: Sun,  7 Feb 2010 15:14:02 +0000

e.g.

    http://thread.gmane.org/gmane.comp.version-control.git/139240

Ramkumar Ramachandra· Apr 7, 2010, 20:00 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documentation/SubmittingPatches: Clarify Gmail section

> Didn't I already say that it is _known_ not to work?

Right. Sorry about that. While testing, I must have made the mistake of using a patch that didn't not have long enough lines to be linewrapped.

> As you earlier said that the documentation of imap-send states GMail web
> works, perhaps that description is incorrect and needs fixing.

Thanks for the pointer. I've prepared another revision.

-- Ram

patchDocumentation/SubmittingPatches: Clarify Gmail section