[2/3] git-imap-send.txt: do verify SSL certificate for gmail.com

Commit Message

Derrick Stolee via GitGitGadget Aug. 30, 2020, 10:01 p.m. UTC

From: Philippe Blain <[e-mail]>

As a public service, it is unlikely that the Gmail server is configured
to throw a certificate that does not verify at the user.

Remove the `sslVerify=false` config from the Gmail example.

Also, comment it in the `example.com` example, and add a note to the
user explaining that they might want to uncomment it if they are having
trouble connecting. While at it, use an Asciidoc 'Note' section in the
Gmail example also.

Based-on-patch-by: Barbu Paul - Gheorghe <[e-mail]>
Helped-by: Junio C Hamano <[e-mail]>
Signed-off-by: Philippe Blain <[e-mail]>
---
 Documentation/git-imap-send.txt | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

Patch

diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index 0a00a1236b..5e4d4d43b9 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -85,10 +85,17 @@  Using direct mode with SSL:
     user = bob
     pass = p4ssw0rd
     port = 123
-    sslverify = false
+    ; sslVerify = false
 .........................
 
 
+[NOTE]
+You may want to use `sslVerify=false`
+while troubleshooting, if you suspect that the reason you are
+having trouble connecting is because the certificate you use at
+the private server `example.com` you are trying to set up (or
+have set up) may not be verified correctly.
+
 Using Gmail's IMAP interface:
 
 ---------
@@ -97,9 +104,9 @@  Using Gmail's IMAP interface:
 	host = imaps://imap.gmail.com
 	user = [e-mail]
 	port = 993
-	sslverify = false
 ---------
 
+[NOTE]
 You might need to instead use: `folder = "[Google Mail]/Drafts"` if you get an error
 that the "Folder doesn't exist".