diff mbox series

[v2,1/3] git-send-email(1): improve smtp-encryption docs

Message ID 20210411125431.28971-2-sir@cmpwn.com (mailing list archive)
State New
Headers show
Series git-send-email: improve SSL configuration | expand

Commit Message

Drew DeVault April 11, 2021, 12:54 p.m. UTC
This clarifies the meaning of the 'ssl' and 'tls' values for this
option, which respectively enable SSL/TLS, i.e. a standard "modern" SSL
approach; and STARTTLS, i.e. opportunistic in-band TLS.

Signed-off-by: Drew DeVault <sir@cmpwn.com>
---
 Documentation/git-send-email.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

Ævar Arnfjörð Bjarmason April 11, 2021, 2:11 p.m. UTC | #1
On Sun, Apr 11 2021, Drew DeVault wrote:

Subject nit: 1/3 is "git-send-email(1):", the rest
"git-send-email:". I'd suggest just "send-email:", we usually omit
"git-" from the subcommand, and don't use man sections to refer to our
own software.

> This clarifies the meaning of the 'ssl' and 'tls' values for this
> option, which respectively enable SSL/TLS, i.e. a standard "modern" SSL
> approach; and STARTTLS, i.e. opportunistic in-band TLS.
>
> Signed-off-by: Drew DeVault <sir@cmpwn.com>
> ---
>  Documentation/git-send-email.txt | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
> index 93708aefea..c17c3b400a 100644
> --- a/Documentation/git-send-email.txt
> +++ b/Documentation/git-send-email.txt
> @@ -168,8 +168,11 @@ Sending
>  	unspecified, choosing the envelope sender is left to your MTA.
>  
>  --smtp-encryption=<encryption>::
> -	Specify the encryption to use, either 'ssl' or 'tls'.  Any other
> -	value reverts to plain SMTP.  Default is the value of
> +	Specify the encryption to use, either 'ssl' or 'tls'. 'ssl' enables

Starting a sentance with a quoted lower-case word makes for hard
reading. Maybe:

    When set to 'ssl' ...

Or something? 

> +	generic SSL/TLS support and is typically used on port 465.  'tls'
> +	enables in-band STARTTLS support and is typically used on port 25 or
> +	587.  Use whichever option is recommended by your mail provider.  Any
> +	other value reverts to plain SMTP.  Default is the value of
>  	`sendemail.smtpEncryption`.
>  
>  --smtp-domain=<FQDN>::
diff mbox series

Patch

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 93708aefea..c17c3b400a 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -168,8 +168,11 @@  Sending
 	unspecified, choosing the envelope sender is left to your MTA.
 
 --smtp-encryption=<encryption>::
-	Specify the encryption to use, either 'ssl' or 'tls'.  Any other
-	value reverts to plain SMTP.  Default is the value of
+	Specify the encryption to use, either 'ssl' or 'tls'. 'ssl' enables
+	generic SSL/TLS support and is typically used on port 465.  'tls'
+	enables in-band STARTTLS support and is typically used on port 25 or
+	587.  Use whichever option is recommended by your mail provider.  Any
+	other value reverts to plain SMTP.  Default is the value of
 	`sendemail.smtpEncryption`.
 
 --smtp-domain=<FQDN>::