Skip to content

Commit deedcdc

Browse files
jnavilagitster
authored andcommitted
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>
1 parent f083ccc commit deedcdc

2 files changed

Lines changed: 27 additions & 27 deletions

File tree

Documentation/config/imap.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
1-
imap.folder::
1+
`imap.folder`::
22
The folder to drop the mails into, which is typically the Drafts
33
folder. For example: `INBOX.Drafts`, `INBOX/Drafts` or
44
`[Gmail]/Drafts`. The IMAP folder to interact with MUST be specified;
55
the value of this configuration variable is used as the fallback
66
default value when the `--folder` option is not given.
77

8-
imap.tunnel::
8+
`imap.tunnel`::
99
Command used to set up a tunnel to the IMAP server through which
1010
commands will be piped instead of using a direct network connection
11-
to the server. Required when imap.host is not set.
11+
to the server. Required when `imap.host` is not set.
1212

13-
imap.host::
13+
`imap.host`::
1414
A URL identifying the server. Use an `imap://` prefix for non-secure
1515
connections and an `imaps://` prefix for secure connections.
16-
Ignored when imap.tunnel is set, but required otherwise.
16+
Ignored when `imap.tunnel` is set, but required otherwise.
1717

18-
imap.user::
18+
`imap.user`::
1919
The username to use when logging in to the server.
2020

21-
imap.pass::
21+
`imap.pass`::
2222
The password to use when logging in to the server.
2323

24-
imap.port::
24+
`imap.port`::
2525
An integer port number to connect to on the server.
26-
Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
27-
Ignored when imap.tunnel is set.
26+
Defaults to 143 for `imap://` hosts and 993 for `imaps://` hosts.
27+
Ignored when `imap.tunnel` is set.
2828

29-
imap.sslverify::
29+
`imap.sslverify`::
3030
A boolean to enable/disable verification of the server certificate
3131
used by the SSL/TLS connection. Default is `true`. Ignored when
32-
imap.tunnel is set.
32+
`imap.tunnel` is set.
3333

34-
imap.preformattedHTML::
34+
`imap.preformattedHTML`::
3535
A boolean to enable/disable the use of html encoding when sending
36-
a patch. An html encoded patch will be bracketed with <pre>
36+
a patch. An html encoded patch will be bracketed with `<pre>`
3737
and have a content type of text/html. Ironically, enabling this
3838
option causes Thunderbird to send the patch as a plain/text,
3939
format=fixed email. Default is `false`.
4040

41-
imap.authMethod::
41+
`imap.authMethod`::
4242
Specify the authentication method for authenticating with the IMAP server.
4343
If Git was built with the NO_CURL option, or if your curl version is older
4444
than 7.34.0, or if you're running git-imap-send with the `--no-curl`

Documentation/git-imap-send.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder
88

99
SYNOPSIS
1010
--------
11-
[verse]
12-
'git imap-send' [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>]
13-
'git imap-send' --list
11+
[synopsis]
12+
git imap-send [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>]
13+
git imap-send --list
1414

1515

1616
DESCRIPTION
@@ -32,30 +32,30 @@ $ git format-patch --signoff --stdout --attach origin | git imap-send
3232
OPTIONS
3333
-------
3434

35-
-v::
36-
--verbose::
35+
`-v`::
36+
`--verbose`::
3737
Be verbose.
3838

39-
-q::
40-
--quiet::
39+
`-q`::
40+
`--quiet`::
4141
Be quiet.
4242

43-
-f <folder>::
44-
--folder=<folder>::
43+
`-f <folder>`::
44+
`--folder=<folder>`::
4545
Specify the folder in which the emails have to saved.
4646
For example: `--folder=[Gmail]/Drafts` or `-f INBOX/Drafts`.
4747

48-
--curl::
48+
`--curl`::
4949
Use libcurl to communicate with the IMAP server, unless tunneling
5050
into it. Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
5151
option set.
5252

53-
--no-curl::
53+
`--no-curl`::
5454
Talk to the IMAP server using git's own IMAP routines instead of
5555
using libcurl. Ignored if Git was built with the NO_OPENSSL option
5656
set.
5757

58-
--list::
58+
`--list`::
5959
Run the IMAP LIST command to output a list of all the folders present.
6060

6161
CONFIGURATION

0 commit comments

Comments
 (0)