[PATCH v2 1/4] doc: convert git-imap-send synopsis and options to new style
From: Jean-Noël Avila via GitGitGadget <hidden>
Date: 2026-07-23 21:19:34
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <redacted> 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 <redacted> --- Documentation/config/imap.adoc | 2 +- Documentation/git-imap-send.adoc | 22 ++++++++++++---------- 2 files changed, 13 insertions(+), 11 deletions(-)
diff --git a/Documentation/config/imap.adoc b/Documentation/config/imap.adoc
index cb8f5e2700..6b97776bc3 100644
--- a/Documentation/config/imap.adoc
+++ b/Documentation/config/imap.adoc@@ -41,7 +41,7 @@ `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` + than 7.34.0, or if you're running `git-imap-send` with the `--no-curl` option, the only supported methods are `PLAIN`, `CRAM-MD5`, `OAUTHBEARER` and `XOAUTH2`. If this is not set then `git imap-send` uses the basic IMAP plaintext `LOGIN` command.
diff --git a/Documentation/git-imap-send.adoc b/Documentation/git-imap-send.adoc
index 538b91afc0..1814d94491 100644
--- a/Documentation/git-imap-send.adoc
+++ b/Documentation/git-imap-send.adoc@@ -24,9 +24,9 @@ that order. Typical usage is something like: ------- +---- $ git format-patch --signoff --stdout --attach origin | git imap-send ------- +---- OPTIONS
@@ -138,13 +138,13 @@ have set up) may not be verified correctly. Using Gmail's IMAP interface: ---------- +---- [imap] folder = "[Gmail]/Drafts" host = imaps://imap.gmail.com user = user@gmail.com port = 993 ---------- +---- Gmail does not allow using your regular password for `git imap-send`. 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 having multi-factor authentication. You will have to use an OAuth2.0 access token in place of your password when using this authentication. ---------- +---- [imap] folder = "[Gmail]/Drafts" host = imaps://imap.gmail.com user = user@gmail.com port = 993 authmethod = OAUTHBEARER ---------- +---- Using Outlook's IMAP interface: Unlike Gmail, Outlook only supports OAuth2.0 based authentication. Also, it supports only `XOAUTH2` as the mechanism. ---------- +---- [imap] folder = "Drafts" host = imaps://outlook.office365.com user = user@outlook.com port = 993 authmethod = XOAUTH2 ---------- +---- Once the commits are ready to be sent, run the following command: - $ git format-patch --cover-letter -M --stdout origin/master | git imap-send +---- +$ 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 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: SEE ALSO -------- -linkgit:git-format-patch[1], linkgit:git-send-email[1], mbox(5) +linkgit:git-format-patch[1], linkgit:git-send-email[1], `mbox`(5) GIT ---
--
gitgitgadget