Documentation/SubmittingPatches: clarify GMail section and SMTP
We keep getting mangled submissions from GMail's web interface. Try to be more proactive in SubmittingPatches by - pointing to MUA specific instructions early on, - structuring the GMail section more clearly, - putting send-email/SMTP before imap-send/IMAP. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael J Gruber committed
May 25, 2010 at 10:30 UTC
e498257d650529812ffe1872b3cd62e2bd604287
1 file changed
+21
-19
Documentation/SubmittingPatches
+21
-19
@@ -41,6 +41,7 @@ Checklist (and a short version for the impatient):
41
maintainer (gitster@pobox.com) if (and only if) the patch
42
is ready for inclusion. If you use git-send-email(1),
43
please test it first by sending email to yourself.
44
+ - see below for instructions specific to your mailer
45
46
Long version:
47
@@ -519,9 +520,27 @@ Gmail
520
521
GMail does not appear to have any way to turn off line wrapping in the web
522
interface, so this will mangle any emails that you send. You can however
522
-use any IMAP email client to connect to the google imap server, and forward
523
+use "git send e-mail" and send your patches through the GMail SMTP server, or
524
+use any IMAP email client to connect to the google IMAP server and forward
525
the emails through that.
526
527
+To use "git send-email" and send your patches through the GMail SMTP server,
528
+edit ~/.gitconfig to specify your account settings:
529
+
530
+[sendemail]
531
+ smtpencryption = tls
532
+ smtpserver = smtp.gmail.com
533
+ smtpuser = user@gmail.com
534
+ smtppass = p4ssw0rd
535
+ smtpserverport = 587
536
+
537
+Once your commits are ready to be sent to the mailing list, run the
538
+following commands:
539
+
540
+ $ git format-patch --cover-letter -M origin/master -o outgoing/
541
+ $ edit outgoing/0000-*
542
+ $ git send-email outgoing/*
543
+
544
To submit using the IMAP interface, first, edit your ~/.gitconfig to specify your
545
account settings:
546
@@ -537,8 +556,7 @@ You might need to instead use: folder = "[Google Mail]/Drafts" if you get an err
556
that the "Folder doesn't exist".
557
558
Once your commits are ready to be sent to the mailing list, run the
540
-following command to send the patch emails to your Gmail Drafts
541
-folder.
559
+following commands:
560
561
$ git format-patch --cover-letter -M --stdout origin/master | git imap-send
562
@@ -546,19 +564,3 @@ Just make sure to disable line wrapping in the email client (GMail web
564
interface will line wrap no matter what, so you need to use a real
565
IMAP client).
566
549
-Alternatively, you can use "git send-email" and send your patches
550
-through the GMail SMTP server. edit ~/.gitconfig to specify your
551
-account settings:
552
-
553
-[sendemail]
554
- smtpencryption = tls
555
- smtpserver = smtp.gmail.com
556
- smtpuser = user@gmail.com
557
- smtppass = p4ssw0rd
558
- smtpserverport = 587
559
-
560
-Once your commits are ready to be sent to the mailing list, run the
561
-following commands:
562
-
563
- $ git format-patch --cover-letter -M origin/master -o outgoing/
564
- $ git send-email outgoing/*