Skip to content

Commit 5b124e7

Browse files
committed
Merge branch 'ag/send-email-docs'
Documentation for "git send-email" has been updated with a bit more credential helper and OAuth information. * ag/send-email-docs: docs: make the purpose of using app password for Gmail more clear in send-email docs: remove credential helper links for emails from gitcredentials docs: improve formatting in git-send-email documentation docs: add credential helper for yahoo and link Google's sendgmail tool
2 parents 01148ca + 9e68aab commit 5b124e7

File tree

3 files changed

+147
-134
lines changed

3 files changed

+147
-134
lines changed

Documentation/config/sendemail.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
sendemail.identity::
22
A configuration identity. When given, causes values in the
3-
'sendemail.<identity>' subsection to take precedence over
4-
values in the 'sendemail' section. The default identity is
3+
`sendemail.<identity>` subsection to take precedence over
4+
values in the `sendemail` section. The default identity is
55
the value of `sendemail.identity`.
66

77
sendemail.smtpEncryption::
88
See linkgit:git-send-email[1] for description. Note that this
9-
setting is not subject to the 'identity' mechanism.
9+
setting is not subject to the `identity` mechanism.
1010

1111
sendemail.smtpSSLCertPath::
1212
Path to ca-certificates (either a directory or a single file).
1313
Set it to an empty string to disable certificate verification.
1414

1515
sendemail.<identity>.*::
16-
Identity-specific versions of the 'sendemail.*' parameters
16+
Identity-specific versions of the `sendemail.*` parameters
1717
found below, taking precedence over those when this
1818
identity is selected, through either the command-line or
1919
`sendemail.identity`.
2020

2121
sendemail.multiEdit::
22-
If true (default), a single editor instance will be spawned to edit
22+
If `true` (default), a single editor instance will be spawned to edit
2323
files you have to edit (patches when `--annotate` is used, and the
24-
summary when `--compose` is used). If false, files will be edited one
24+
summary when `--compose` is used). If `false`, files will be edited one
2525
after the other, spawning a new editor each time.
2626

2727
sendemail.confirm::
2828
Sets the default for whether to confirm before sending. Must be
29-
one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
29+
one of `always`, `never`, `cc`, `compose`, or `auto`. See `--confirm`
3030
in the linkgit:git-send-email[1] documentation for the meaning of these
3131
values.
3232

@@ -51,7 +51,7 @@ sendemail.aliasesFile::
5151

5252
sendemail.aliasFileType::
5353
Format of the file(s) specified in sendemail.aliasesFile. Must be
54-
one of 'mutt', 'mailrc', 'pine', 'elm', 'gnus', or 'sendmail'.
54+
one of `mutt`, `mailrc`, `pine`, `elm`, `gnus`, or `sendmail`.
5555
+
5656
What an alias file in each format looks like can be found in
5757
the documentation of the email program of the same name. The
@@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
101101

102102
sendemail.smtpBatchSize::
103103
Number of messages to be sent per connection, after that a relogin
104-
will happen. If the value is 0 or undefined, send all messages in
104+
will happen. If the value is `0` or undefined, send all messages in
105105
one connection.
106106
See also the `--batch-size` option of linkgit:git-send-email[1].
107107

@@ -111,5 +111,5 @@ sendemail.smtpReloginDelay::
111111

112112
sendemail.forbidSendmailVariables::
113113
To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
114-
will abort with a warning if any configuration options for "sendmail"
114+
will abort with a warning if any configuration options for `sendmail`
115115
exist. Set this variable to bypass the check.

0 commit comments

Comments
 (0)