[PATCH] send-email: document the --smtp-debug option

Zbigniew Jędrzejewski-Szmek· Feb 27, 2012, 16:22 UTC · lore

The option was already shown in -h output, so it should be documented in the man page.

Signed-off-by: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Suggested-by: David A. Greene <greened@obbligato.org>
---
David Greene wrote:

> I don't think --smtp-debug is documented in the man pages.  Was that a
> deliberate decision or an oversight?

 Documentation/git-send-email.txt |    4 ++++
 1 file changed, 4 insertions(+)

Show changes to Documentation/git-send-email.txt +4 −0

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 327233c..3241170 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -198,6 +198,10 @@ must be used for each option.
 	if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
 	then authentication is not attempted.
 
+--smtp-debug=0|1::
+	Enable (1) or disable (0) debug output. If enabled, SMTP
+	commands and replies will be printed. Useful to debug TLS
+	connection and authentication problems.
 
 Automating
 ~~~~~~~~~~

-- 
1.7.9.2.378.g4d260

Junio C Hamano· Feb 27, 2012, 20:19 UTC · re: Zbigniew Jędrzejewski-Szmek · lore

Re: [PATCH] send-email: document the --smtp-debug option

Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> writes:

Show 9 quoted lines

> The option was already shown in -h output, so it should be documented
> in the man page.
>
> Signed-off-by: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
> Suggested-by: David A. Greene <greened@obbligato.org>
> ---
> David Greene wrote:
>> I don't think --smtp-debug is documented in the man pages.  Was that a
>> deliberate decision or an oversight?

Probably halfway in between "Meh"; anybody who is willing to look into the issue will notice when he opens the script and reads it for the first time anyway, so why bother.

But now "A patch already exists, and it does not seem to have any funny letters that may screw up asciidoc, so why bother rejecting" ;-)

Will apply; thanks.

Show 18 quoted lines

>  Documentation/git-send-email.txt |    4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
> index 327233c..3241170 100644
> --- a/Documentation/git-send-email.txt
> +++ b/Documentation/git-send-email.txt
> @@ -198,6 +198,10 @@ must be used for each option.
>  	if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
>  	then authentication is not attempted.
>  
> +--smtp-debug=0|1::
> +	Enable (1) or disable (0) debug output. If enabled, SMTP
> +	commands and replies will be printed. Useful to debug TLS
> +	connection and authentication problems.
>  
>  Automating
>  ~~~~~~~~~~

patchsend-email: document the --smtp-debug option