From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Jean-Noël Avila" <jn.avila@free.fr>,
"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH 5/5] doc: convert git-imap-send synopsis and options to new style
Date: Sun, 17 May 2026 20:26:55 +0000 [thread overview]
Message-ID: <dbe4d20b4ba1af6b9c874522787634bc4e0baa19.1779049615.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.2117.git.1779049615.gitgitgadget@gmail.com>
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
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>
---
Documentation/config/imap.adoc | 30 +++++++++++++++---------------
Documentation/git-imap-send.adoc | 24 ++++++++++++------------
2 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/Documentation/config/imap.adoc b/Documentation/config/imap.adoc
index 4682a6bd03..cb8f5e2700 100644
--- 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 278e5ccd36..538b91afc0 100644
--- 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
--
gitgitgadget
prev parent reply other threads:[~2026-05-17 20:27 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-17 20:26 [PATCH 0/5] doc: convert another batch of files to synopsis style Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` [PATCH 1/5] doc: convert git-bisect " Jean-Noël Avila via GitGitGadget
2026-05-18 0:26 ` Junio C Hamano
2026-05-18 2:10 ` Junio C Hamano
2026-05-17 20:26 ` [PATCH 2/5] doc: convert git-grep synopsis and options to new style Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` [PATCH 3/5] doc: convert git-am " Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` [PATCH 4/5] doc: convert git-apply " Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` Jean-Noël Avila via GitGitGadget [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=dbe4d20b4ba1af6b9c874522787634bc4e0baa19.1779049615.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=jn.avila@free.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox