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

Re: [PATCH v2 1/2] completion: add 'symbolic-ref'

From
Roland Hieber <rhi@pengutronix.de>
Date
Apr 25, 2024, 10:21 UTC
Message-ID
<20240425102116.fgis3qqhi7y5uh3q@pengutronix.de>
In-Reply-To
<Zin1nOSfckSt-H0J@tanuki>
On Thu, Apr 25, 2024 at 08:18:04AM +0200, Patrick Steinhardt wrote:
Show 35 quoted lines
> On Wed, Apr 24, 2024 at 11:50:17PM +0200, Roland Hieber wrote:
> > Even 'symbolic-ref' is only completed when
> > GIT_COMPLETION_SHOW_ALL_COMMANDS=1 is set, it currently defaults to
> > completing file names, which is not very helpful. Add a simple
> > completion function which completes options and refs.
> > 
> > Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> > ---
> > PATCH v2:
> >  - no changes
> > 
> > PATCH v1: https://lore.kernel.org/git/20240424210549.256256-1-rhi@pengutronix.de/
> > ---
> >  contrib/completion/git-completion.bash | 11 +++++++++++
> >  t/t9902-completion.sh                  | 16 ++++++++++++++++
> >  2 files changed, 27 insertions(+)
> > 
> > diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
> > index 75193ded4bde..ffcc55484bcd 100644
> > --- a/contrib/completion/git-completion.bash
> > +++ b/contrib/completion/git-completion.bash
> > @@ -3581,6 +3581,17 @@ _git_svn ()
> >  	fi
> >  }
> >  
> > +_git_symbolic_ref () {
> > +	case "$cur" in
> > +	--*)
> > +		__gitcomp "--delete --quiet --short --recurse --no-recurse"
> > +		return
> > +		;;
> 
> Instead of hardcoding these we may use the `--git-completion-helper`
> option, which outputs the options for us. We have `__gitcomp_builtin ()`
> to do this.

Ahh thanks, I didn't know there was automagic for it! Fixed in v3: <https://lore.kernel.org/git/20240425101845.708554-1-rhi@pengutronix.de/>

 - Roland
Show 44 quoted lines
> > +	esac
> > +	
> > +	__git_complete_refs
> > +}
> > +
> >  _git_tag ()
> >  {
> >  	local i c="$__git_cmd_idx" f=0
> > diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
> > index 569cf2310434..a34953da6c96 100755
> > --- a/t/t9902-completion.sh
> > +++ b/t/t9902-completion.sh
> > @@ -2518,6 +2518,22 @@ test_expect_success 'complete tree filename with metacharacters' '
> >  	EOF
> >  '
> >  
> > +test_expect_success 'symbolic-ref completes short ref names ' '
> > +	test_completion "git symbolic-ref foo m" <<-\EOF
> > +	main Z
> > +	mybranch Z
> > +	mytag Z
> > +	EOF
> > +'
> 
> Nit: let's add a newline between those two test cases.
> 
> Patrick
> 
> > +test_expect_success 'symbolic-ref completes full ref names' '
> > +	test_completion "git symbolic-ref foo refs/" <<-\EOF
> > +	refs/heads/main Z
> > +	refs/heads/mybranch Z
> > +	refs/tags/mytag Z
> > +	refs/tags/A Z
> > +	EOF
> > +'
> > +
> >  test_expect_success PERL 'send-email' '
> >  	test_completion "git send-email --cov" <<-\EOF &&
> >  	--cover-from-description=Z
> > -- 
> > 2.39.2
> > 
> > 
-- 
Roland Hieber, Pengutronix e.K.          | r.hieber@pengutronix.de     |
Steuerwalder Str. 21                     | https://www.pengutronix.de/ |
31137 Hildesheim, Germany                | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686         | Fax:   +49-5121-206917-5555 |
Previous: Patrick Steinhardt
Message 4 of 4 in “completion: add 'symbolic-ref'”
  1. 1/2 completion: add 'symbolic-ref'Roland Hieber, Apr 24, 2024
  2. 2/2 completion: add docs on how to add subcommand completionsRoland Hieber, Apr 24, 2024
  3. Patrick SteinhardtApr 25, 2024
  4. Roland HieberApr 25, 2024

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.