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

Re: [PATCH v3 3/7] completion: add new __gitcompadd helper

From
Junio C Hamano <gitster@pobox.com>
Date
Apr 12, 2013, 17:55 UTC
Message-ID
<7vli8neiqi.fsf@alter.siamese.dyndns.org>
In-Reply-To
<1365577077-12648-4-git-send-email-felipe.contreras@gmail.com>
Felipe Contreras <felipe.contreras@gmail.com> writes:
Show 25 quoted lines
> The idea is to never touch the COMPREPLY variable directly.
>
> This allows other completion systems (i.e. zsh) to override
> __gitcompadd, and do something different instead.
>
> Also, this allows further optimizations down the line.
>
> There should be no functional changes.
>
> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
> ---
>  contrib/completion/git-completion.bash | 13 ++++++++-----
>  1 file changed, 8 insertions(+), 5 deletions(-)
>
> diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
> index 2c87fd8..90b54ab 100644
> --- a/contrib/completion/git-completion.bash
> +++ b/contrib/completion/git-completion.bash
> @@ -195,6 +195,11 @@ _get_comp_words_by_ref ()
>  }
>  fi
>  
> +__gitcompadd ()
> +{
> +	COMPREPLY=($(compgen -W "$1" -P "$2" -S "$4" -- "$3"))

Making a mental note that this takes prefix ($2), suffix ($4) and the actual word ($3) are given in addition to the list of expansions ($1)...

Show 13 quoted lines
> +}
> +
>  # Generates completion reply with compgen, appending a space to possible
>  # completion words, if necessary.
>  # It accepts 1 to 4 arguments:
> @@ -211,9 +216,7 @@ __gitcomp ()
>  		;;
>  	*)
>  		local IFS=$'\n'
> -		COMPREPLY=($(compgen -P "${2-}" \
> -			-W "$(__gitcomp_1 "${1-}" "${4-}")" \
> -			-- "$cur_"))
> +		__gitcompadd "$(__gitcomp_1 "${1-}" "${4-}")" "${2-}" "$cur_" ""

This did not use to use suffix, but we pass an empty string as $4, so it is an equivalent rewrite.

Show 9 quoted lines
>  		;;
>  	esac
>  }
> @@ -230,7 +233,7 @@ __gitcomp ()
>  __gitcomp_nl ()
>  {
>  	local IFS=$'\n'
> -	COMPREPLY=($(compgen -P "${2-}" -S "${4- }" -W "$1" -- "${3-$cur}"))
> +	__gitcompadd "$1" "${2-}" "${3-$cur}" "${4- }"
This also is a straight-forward rewrite.
Show 9 quoted lines
>  }
>  
>  # Generates completion reply with compgen from newline-separated possible
> @@ -1820,7 +1823,7 @@ _git_config ()
>  		local remote="${prev#remote.}"
>  		remote="${remote%.fetch}"
>  		if [ -z "$cur" ]; then
> -			COMPREPLY=("refs/heads/")
> +			__gitcompadd "refs/heads/"
I am not sure about this one, though.

Other callers took pains to protet against triggering unset variable references by using ${1-} instead of ${1}. Shouldn't this caller be passing three empty strings?

>  			return
>  		fi
>  		__gitcomp_nl "$(__git_refs_remotes "$remote")"
Previous: Felipe ContrerasNext: Felipe Contreras
Message 6 of 20 in “completion: reorg and performance improvements”
  1. 0/7 completion: reorg and performance improvementsFelipe Contreras, Apr 10, 2013
  2. 1/7 completion: trivial test improvementFelipe Contreras, Apr 10, 2013
  3. 2/7 completion: get rid of empty COMPREPLY assignmentsFelipe Contreras, Apr 10, 2013
  4. Eric SunshineApr 10, 2013
  5. 3/7 completion: add new __gitcompadd helperFelipe Contreras, Apr 10, 2013
  6. Junio C HamanoApr 12, 2013
  7. Felipe ContrerasApr 12, 2013
  8. Junio C HamanoApr 12, 2013
  9. 4/7 completion: add __gitcomp_nl testsFelipe Contreras, Apr 10, 2013
  10. 5/7 completion: get rid of compgenFelipe Contreras, Apr 10, 2013
  11. Eric SunshineApr 10, 2013
  12. Felipe ContrerasApr 10, 2013
  13. John KeepingApr 10, 2013
  14. Junio C HamanoApr 12, 2013
  15. 6/7 completion: get rid of __gitcomp_1Felipe Contreras, Apr 10, 2013
  16. Eric SunshineApr 10, 2013
  17. John KeepingApr 10, 2013
  18. Eric SunshineApr 10, 2013
  19. 7/7 completion: small optimizationFelipe Contreras, Apr 10, 2013
  20. Junio C HamanoApr 12, 2013

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.