doc: convert git-imap-send synopsis and options to new style

Convert git-imap-send from [verse]/single-quote style to the modern
synopsis-block style:

- Replace [verse] with [synopsis] in SYNOPSIS block
- Backtick-quote all OPTIONS terms
- Backtick-quote all config keys in config/imap.adoc
- Backtick-quote bare config key references in prose

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config/imap.adoc b/Documentation/config/imap.adoc
index 4682a6bd039755ae86fe398d540ec4874e983d79..cb8f5e2700ae1333efef9f9463a2a081320fa45d 100644 (file)
--- a/Documentation/config/imap.adoc
+++ b/Documentation/config/imap.adoc
@@ -1,44 +1,44 @@
-imap.folder::
+`imap.folder`::
        The folder to drop the mails into, which is typically the Drafts
        folder. For example: `INBOX.Drafts`, `INBOX/Drafts` or
        `[Gmail]/Drafts`. The IMAP folder to interact with MUST be specified;
        the value of this configuration variable is used as the fallback
        default value when the `--folder` option is not given.
 
-imap.tunnel::
+`imap.tunnel`::
        Command used to set up a tunnel to the IMAP server through which
        commands will be piped instead of using a direct network connection
-       to the server. Required when imap.host is not set.
+       to the server. Required when `imap.host` is not set.
 
-imap.host::
+`imap.host`::
        A URL identifying the server. Use an `imap://` prefix for non-secure
        connections and an `imaps://` prefix for secure connections.
-       Ignored when imap.tunnel is set, but required otherwise.
+       Ignored when `imap.tunnel` is set, but required otherwise.
 
-imap.user::
+`imap.user`::
        The username to use when logging in to the server.
 
-imap.pass::
+`imap.pass`::
        The password to use when logging in to the server.
 
-imap.port::
+`imap.port`::
        An integer port number to connect to on the server.
-       Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
-       Ignored when imap.tunnel is set.
+       Defaults to 143 for `imap://` hosts and 993 for `imaps://` hosts.
+       Ignored when `imap.tunnel` is set.
 
-imap.sslverify::
+`imap.sslverify`::
        A boolean to enable/disable verification of the server certificate
        used by the SSL/TLS connection. Default is `true`. Ignored when
-       imap.tunnel is set.
+       `imap.tunnel` is set.
 
-imap.preformattedHTML::
+`imap.preformattedHTML`::
        A boolean to enable/disable the use of html encoding when sending
-       a patch.  An html encoded patch will be bracketed with <pre>
+       a patch.  An html encoded patch will be bracketed with `<pre>`
        and have a content type of text/html.  Ironically, enabling this
        option causes Thunderbird to send the patch as a plain/text,
        format=fixed email.  Default is `false`.
 
-imap.authMethod::
+`imap.authMethod`::
        Specify the authentication method for authenticating with the IMAP server.
        If Git was built with the NO_CURL option, or if your curl version is older
        than 7.34.0, or if you're running git-imap-send with the `--no-curl`

diff --git a/Documentation/git-imap-send.adoc b/Documentation/git-imap-send.adoc
index 278e5ccd36b9fa4ce853a46eabfa2a32b240bbf4..538b91afc06dde5ab206f8a41b193cf525154650 100644 (file)
--- a/Documentation/git-imap-send.adoc
+++ b/Documentation/git-imap-send.adoc
@@ -8,9 +8,9 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder
 
 SYNOPSIS
 --------
-[verse]
-'git imap-send' [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>]
-'git imap-send' --list
+[synopsis]
+git imap-send [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>]
+git imap-send --list
 
 
 DESCRIPTION
@@ -32,30 +32,30 @@ $ git format-patch --signoff --stdout --attach origin | git imap-send
 OPTIONS
 -------
 
--v::
---verbose::
+`-v`::
+`--verbose`::
        Be verbose.
 
--q::
---quiet::
+`-q`::
+`--quiet`::
        Be quiet.
 
--f <folder>::
---folder=<folder>::
+`-f <folder>`::
+`--folder=<folder>`::
        Specify the folder in which the emails have to saved.
        For example: `--folder=[Gmail]/Drafts` or `-f INBOX/Drafts`.
 
---curl::
+`--curl`::
        Use libcurl to communicate with the IMAP server, unless tunneling
        into it.  Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
        option set.
 
---no-curl::
+`--no-curl`::
        Talk to the IMAP server using git's own IMAP routines instead of
        using libcurl.  Ignored if Git was built with the NO_OPENSSL option
        set.
 
---list::
+`--list`::
        Run the IMAP LIST command to output a list of all the folders present.
 
 CONFIGURATION