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

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

[Roland Hieber]

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
+		;;
+	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
+'
+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

[PATCH v2 2/2] completion: add docs on how to add subcommand completions

[Roland Hieber]

It took me more than a few tries and a good lecture of __git_main to
understand that the two paragraphs above really only refer to adding
completion functions for executables that are not called through git's
subcommand magic. Add a few sentences for that case.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
PATCH v2:
 - fix typo and superfluous "-my"

PATCH v1: https://lore.kernel.org/git/20240424210549.256256-2-rhi@pengutronix.de/
---
 contrib/completion/git-completion.bash | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index ffcc55484bcd..603181d53a90 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -40,6 +40,13 @@
 #
 #   __git_complete gk gitk
 #
+# To add completion for git subcommands that live in external scripts,
+# define a function of the form '_git_${subcommand}' while replacing all dashes
+# with underscores, and the main git completion will make use of it.
+# For example, to add completion after 'git do-stuff' (which could e.g. live
+# in /usr/bin/git-do-stuff), name the completion function '_git_do_stuff'.
+# See _git_show, _git_bisect etc. below for more examples.
+#
 # Compatible with bash 3.2.57.
 #
 # You can set the following environment variables to influence the behavior of
-- 
2.39.2

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

[Patrick Steinhardt]

[-- Attachment #1: Type: text/plain, Size: 2290 bytes --]

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.

> +	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
> 
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Roland Hieber]

On Thu, Apr 25, 2024 at 08:18:04AM +0200, Patrick Steinhardt wrote:
> 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

> > +	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 |