git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Felipe Contreras <felipe.contreras@gmail.com>
To: "René Scharfe" <l.s.r@web.de>,
	"Felipe Contreras" <felipe.contreras@gmail.com>,
	git@vger.kernel.org
Cc: "SZEDER Gábor" <szeder.dev@gmail.com>,
	"Junio C Hamano" <gitster@pobox.com>,
	"Jonathan Nieder" <jrnieder@gmail.com>,
	"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
Subject: Re: [PATCH v2 1/3] completion: bash: add __git_have_func helper
Date: Wed, 30 Dec 2020 11:39:55 -0600	[thread overview]
Message-ID: <5fecbb6b2f9a_871cb208f6@natae.notmuch> (raw)
In-Reply-To: <1402dabd-089d-616a-ef79-ff1ae3fcb438@web.de>

René Scharfe wrote:
> Am 29.12.20 um 18:08 schrieb Felipe Contreras:
> > This makes the code more readable, and also will help when new code
> > wants to do similar checks.
> >
> > Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
> > ---
> >  contrib/completion/git-completion.bash | 10 +++++++---
> >  1 file changed, 7 insertions(+), 3 deletions(-)
> >
> > diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
> > index 463a3124da..869c73ee2c 100644
> > --- a/contrib/completion/git-completion.bash
> > +++ b/contrib/completion/git-completion.bash
> > @@ -3358,15 +3358,19 @@ __git_support_parseopt_helper () {
> >  	esac
> >  }
> >
> > +__git_have_func () {
> > +	declare -f $1 >/dev/null 2>/dev/null
> 
> I stumbled slightly over the lack of quoting.  It doesn't matter for
> the callers below, but new callers passing arbitrary strings could
> cause strange effects:
> 
> 	x() { echo x; }
> 	y() { echo y; }
> 	__git_have_func "x y" # succeeds
> 
> 	__git_have_func -a # succeeds
> 
> I just skimmed patch 3, but it seems to call __git_have_func with
> user-supplied strings, so this might become relevant.

Yes. I just just copied the code to minimize the changes, but this is a
valid concern.

> And then I wondered why use declare -f, which prints the function's
> body, when there is -F, which just prints the function's name.  And why
> repeat /dev/null when redirecting stderr when the more shorter 2>&1
> would do the same?  None of hat was introduced by you patch, of course.
> Anyway, this seems to work for me:
> 
> 	__git_have_func () {
> 		case "$1" in
> 		-*) return 1 ;;
> 		esac
> 		declare -F "$1" >/dev/null 2>&1
> 	}

I wondered some of those things too, but opted for the minimal approach.

Your change seems good to me, however I prefer this to the case
statement:

  [[ "$1" == -* ]] && return 1

But doesn't seem to be too welcomed in git's bash style.

Looks like this would be prefered:

  if [[ "$1" == -* ]]; then
    return 1
  fi

I would prefer either one of those to the case statement.

But the other change is good. I'll include that as a separate patch on
the next version.

Cheers.

-- 
Felipe Contreras

  reply	other threads:[~2020-12-30 17:40 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-29 17:08 [PATCH v2 0/3] completion: make __git_complete public Felipe Contreras
2020-12-29 17:08 ` [PATCH v2 1/3] completion: bash: add __git_have_func helper Felipe Contreras
2020-12-30 17:17   ` René Scharfe
2020-12-30 17:39     ` Felipe Contreras [this message]
2020-12-30 17:58       ` Felipe Contreras
2021-01-06  8:30       ` Junio C Hamano
2020-12-30 18:00     ` SZEDER Gábor
2020-12-30 18:09       ` Felipe Contreras
2020-12-29 17:08 ` [PATCH v2 2/3] test: completion: add tests for __git_complete Felipe Contreras
2020-12-29 17:08 ` [PATCH v2 3/3] completion: add proper public __git_complete Felipe Contreras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5fecbb6b2f9a_871cb208f6@natae.notmuch \
    --to=felipe.contreras@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    --cc=l.s.r@web.de \
    --cc=pclouds@gmail.com \
    --cc=szeder.dev@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).