[PATCH 1/4] doc: convert git-imap-send synopsis and options to new style
"Jean-Noël Avila via GitGitGadget" <[email protected]>
| Newsgroups | org.kernel.vger.git |
|---|---|
| Message-ID | <798c06439015b3f5056574be4eaf09ef71f66494.1784490878.git.gitgitgadget@gmail.com> |
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]> 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 <[email protected]> --- Documentation/config/imap.adoc | 2 +- Documentation/git-imap-send.adoc | 7 +++++-- 2 files changed, 6 insertions(+), 3 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..dd1e0a3718 100644 --- a/Documentation/git-imap-send.adoc +++ b/Documentation/git-imap-send.adoc @@ -192,7 +192,10 @@ supports only `XOAUTH2` as the mechanism. 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 +220,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