[PATCH 1/3] git-imap-send.txt: don't duplicate 'Examples' sections
- From
Philippe Blain via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Aug 30, 2020, 22:01 UTC
- Message-ID
- <3a9b82839e47d974a1a37e77dd10a19daeed5d94.1598824880.git.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.715.git.1598824880.gitgitgadget@gmail.com>
From: Philippe Blain <levraiphilippeblain@gmail.com>
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 <gitster@pobox.com> Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com> --- Documentation/git-imap-send.txt | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-)
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).
-- gitgitgadget