From 587e69b57383c03e35aecc365812d68798ef0ae7 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Sun, 30 Aug 2020 22:01:18 +0000 Subject: git-imap-send.txt: don't duplicate 'Examples' sections Remove the 'Examples' subsection in the 'Configuration' section and move these examples to the 'Examples' section. Also remove the 'Variables' title since it is now useless. Also, use appropriate Asciidoc syntax for configuration values, and capitalize 'Gmail' properly. Suggested-by: Junio C Hamano Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano --- Documentation/git-imap-send.txt | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) (limited to 'Documentation/git-imap-send.txt') diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt index 65b53fcc47..0a00a1236b 100644 --- a/Documentation/git-imap-send.txt +++ b/Documentation/git-imap-send.txt @@ -51,17 +51,13 @@ OPTIONS CONFIGURATION ------------- -To use the tool, imap.folder and either imap.tunnel or imap.host must be set +To use the tool, `imap.folder` and either `imap.tunnel` or `imap.host` must be set to appropriate values. -Variables -~~~~~~~~~ - include::config/imap.txt[] -Examples -~~~~~~~~ - +EXAMPLES +-------- Using tunnel mode: .......................... @@ -93,10 +89,7 @@ Using direct mode with SSL: ......................... -EXAMPLES --------- -To submit patches using GMail's IMAP interface, first, edit your ~/.gitconfig -to specify your account settings: +Using Gmail's IMAP interface: --------- [imap] @@ -107,14 +100,14 @@ to specify your account settings: sslverify = false --------- -You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error +You might need to instead use: `folder = "[Google Mail]/Drafts"` if you get an error that the "Folder doesn't exist". Once the commits are ready to be sent, run the following command: $ git format-patch --cover-letter -M --stdout origin/master | git imap-send -Just make sure to disable line wrapping in the email client (GMail's web +Just make sure to disable line wrapping in the email client (Gmail's web interface will wrap lines no matter what, so you need to use a real IMAP client). -- cgit v1.2.3 From 08a694bb4b5da6310dde63b0d95838d28e6be820 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Sun, 30 Aug 2020 22:01:19 +0000 Subject: git-imap-send.txt: do verify SSL certificate for gmail.com 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 Helped-by: Junio C Hamano Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano --- Documentation/git-imap-send.txt | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'Documentation/git-imap-send.txt') 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 = user@gmail.com 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". -- cgit v1.2.3 From 1bbac2a8c3dbe38e8b701fafb24dea419fc0d95a Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Sun, 30 Aug 2020 22:01:20 +0000 Subject: git-imap-send.txt: add note about localized Gmail folders The name of the "Special-Use Mailboxes" in Gmail are localized using the user's localization settings. Add a note to that effect in `git imap-send`'s documentation, to make it easier for users to configure their account. Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano --- Documentation/git-imap-send.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Documentation/git-imap-send.txt') diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt index 5e4d4d43b9..63cf498ce9 100644 --- a/Documentation/git-imap-send.txt +++ b/Documentation/git-imap-send.txt @@ -110,6 +110,10 @@ Using Gmail's IMAP interface: You might need to instead use: `folder = "[Google Mail]/Drafts"` if you get an error that the "Folder doesn't exist". +[NOTE] +If your Gmail account is set to another language than English, the name of the "Drafts" +folder will be localized. + Once the commits are ready to be sent, run the following command: $ git format-patch --cover-letter -M --stdout origin/master | git imap-send -- cgit v1.2.3