git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/3] completion: bash: add __git_have_func helper

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Dec 30, 2020, 17:39 UTC
Message-ID
<5fecbb6b2f9a_871cb208f6@natae.notmuch>
In-Reply-To
<1402dabd-089d-616a-ef79-ff1ae3fcb438@web.de>
René Scharfe wrote:
Show 32 quoted lines
> 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.

Show 12 quoted lines
> 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
Previous: René ScharfeNext: Felipe Contreras
Message 5 of 10 in “completion: make __git_complete public”
  1. 0/3 completion: make __git_complete publicFelipe Contreras, Dec 29, 2020
  2. 2/3 test: completion: add tests for __git_completeFelipe Contreras, Dec 29, 2020
  3. 1/3 completion: bash: add __git_have_func helperFelipe Contreras, Dec 29, 2020
  4. René ScharfeDec 30, 2020
  5. Felipe ContrerasDec 30, 2020
  6. Felipe ContrerasDec 30, 2020
  7. Junio C HamanoJan 6, 2021
  8. SZEDER GáborDec 30, 2020
  9. Felipe ContrerasDec 30, 2020
  10. 3/3 completion: add proper public __git_completeFelipe Contreras, Dec 29, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.