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>
Jean-Noël Avila committed
Jul 23, 2026 at 21:19 UTC
b71b9d79cf2217cb55d050c231c2a0bbaf2882be
2 files changed
+13
-11
Documentation/config/imap.adoc
+1
-1
@@ -41,7 +41,7 @@
41
`imap.authMethod`::
42
Specify the authentication method for authenticating with the IMAP server.
43
If Git was built with the NO_CURL option, or if your curl version is older
44
- than 7.34.0, or if you're running git-imap-send with the `--no-curl`
44
+ than 7.34.0, or if you're running `git-imap-send` with the `--no-curl`
45
option, the only supported methods are `PLAIN`, `CRAM-MD5`, `OAUTHBEARER`
46
and `XOAUTH2`. If this is not set then `git imap-send` uses the basic IMAP
47
plaintext `LOGIN` command.
Documentation/git-imap-send.adoc
+12
-10
@@ -24,9 +24,9 @@ that order.
24
25
Typical usage is something like:
26
27
-------
27
+----
28
$ git format-patch --signoff --stdout --attach origin | git imap-send
29
-------
29
+----
30
31
32
OPTIONS
@@ -138,13 +138,13 @@ have set up) may not be verified correctly.
138
139
Using Gmail's IMAP interface:
140
141
----------
141
+----
142
[imap]
143
folder = "[Gmail]/Drafts"
144
host = imaps://imap.gmail.com
145
user = user@gmail.com
146
port = 993
147
----------
147
+----
148
149
Gmail does not allow using your regular password for `git imap-send`.
150
If you have multi-factor authentication set up on your Gmail account, you
@@ -167,32 +167,34 @@ than using app-specific passwords, and also does not enforce the need of
167
having multi-factor authentication. You will have to use an OAuth2.0
168
access token in place of your password when using this authentication.
169
170
----------
170
+----
171
[imap]
172
folder = "[Gmail]/Drafts"
173
host = imaps://imap.gmail.com
174
user = user@gmail.com
175
port = 993
176
authmethod = OAUTHBEARER
177
----------
177
+----
178
179
Using Outlook's IMAP interface:
180
181
Unlike Gmail, Outlook only supports OAuth2.0 based authentication. Also, it
182
supports only `XOAUTH2` as the mechanism.
183
184
----------
184
+----
185
[imap]
186
folder = "Drafts"
187
host = imaps://outlook.office365.com
188
user = user@outlook.com
189
port = 993
190
authmethod = XOAUTH2
191
----------
191
+----
192
193
Once the commits are ready to be sent, run the following command:
194
195
- $ git format-patch --cover-letter -M --stdout origin/master | git imap-send
195
+----
196
+$ git format-patch --cover-letter -M --stdout origin/master | git imap-send
197
+----
198
199
Just make sure to disable line wrapping in the email client (Gmail's web
200
interface will wrap lines no matter what, so you need to use a real
@@ -217,7 +219,7 @@ users may wish to visit this web page for more information:
219
220
SEE ALSO
221
--------
220
-linkgit:git-format-patch[1], linkgit:git-send-email[1], mbox(5)
222
+linkgit:git-format-patch[1], linkgit:git-send-email[1], `mbox`(5)
223
224
GIT
225
---