Re: [PATCH 2/2] git-credential-netrc: accept gpg option

From: Junio C Hamano <gitster@pobox.com>
Date: May 10, 2018, 09:57 UTC
Message-ID: <xmqq36yzkf3v.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20180509213634.5198-3-luis.marsano@gmail.com>

Luis Marsano <luis.marsano@gmail.com> writes:

> git-credential-netrc was hardcoded to decrypt with 'gpg' regardless of the gpg.program option
> this now uses the gpg command option if set, else, the gpg.program option set in the git repository or global configuration, else defaults to 'gpg'
> for git-credential-netrc

These lines are way overlong. Wrap at around 72-78 cols, perhaps. Complete each sentence with a full-stop.

> - use Git.pm for repository and global option queries
> - add -g|--gpg command option & document it in command usage
> - test repository & command options
> - support unicode

There are other changes that are not explained/justified here, I think.

 - Instead of ALLCAPS as a placeholder for a command line argument in
   the help text, use <placeholder>, because doing so is better due
   to such and such reasons.

I think it is good to consistently do so, but it is unclear why ALLCAPS is bad and <placeholder> is better. That needs to be explained.

 - Replace three-dots in the help text with U+2026 to punish those
   who are still using unicode-inapable terminal in this century.

I do not think this part of the patch is a good idea at all, but perhaps I misunderstood the reason behind this change you had in mind (as you did not explain it in the proposed log message).

Show 6 quoted lines

> @@ -62,27 +69,31 @@ if ($options{help}) {
>  
>  	print <<EOHIPPUS;
>  
> -$0 [-f AUTHFILE1] [-f AUTHFILEN] [-d] [-v] [-k] get
> +$0 [(-f <authfile>)…] [-g <program>] [-d] [-v] [-k] get

Is this a desired change, or unwanted change left in the patch by accident?

> -...and if you want lots of debugging info:
> +…and if you want lots of debugging info:

Is this a desired change, or unwanted change left in the patch by accident?

Show 6 quoted lines

>  
>    git config credential.helper '$shortname -f AUTHFILE -d'
>  
> -...or to see the files opened and data found:
> +…or to see the files opened and data found:
>

Ditto.

Show 22 quoted lines

>    git config credential.helper '$shortname -f AUTHFILE -v'
>  
> -Only "get" mode is supported by this credential helper.  It opens every AUTHFILE
> +Only "get" mode is supported by this credential helper.  It opens every <authfile>
>  and looks for the first entry that matches the requested search criteria:
>  
>   'port|protocol':
> @@ -120,7 +131,7 @@ host=github.com
>  protocol=https
>  username=tzz
>  
> -this credential helper will look for the first entry in every AUTHFILE that
> +this credential helper will look for the first entry in every <authfile> that
>  matches
>  
>  machine github.com port https login tzz
> @@ -129,7 +140,7 @@ OR
>  
>  machine github.com protocol https login tzz
>  
> -OR... etc. acceptable tokens as listed above.  Any unknown tokens are
> +OR… etc. acceptable tokens as listed above.  Any unknown tokens are

Ditto.

>  # Credentials must get a parameter, so die if it's missing.
> -die "Syntax: $0 [-f AUTHFILE1] [-f AUTHFILEN] [-d] get" unless defined $mode;
> +die "Syntax: $0 [(-f <authfile>)…] [-d] get" unless defined $mode;

Ditto.