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

Re: [PATCH 3/4] completion: reflog with implicit "show"

From
Rubén Justo <rjusto@gmail.com>
Date
Jan 26, 2024, 20:20 UTC
Message-ID
<dd106d87-3363-426a-90a2-16e1f2d04661@gmail.com>
In-Reply-To
<xmqq8r4cnfju.fsf@gitster.g>
On 26-ene-2024 09:57:25, Junio C Hamano wrote:
Show 85 quoted lines
> Rubén Justo <rjusto@gmail.com> writes:
> 
> > When no subcommand is specified to "reflog", we assume "show" [1]:
> >
> >     $ git reflog -h
> >     usage: git reflog [show] [<log-options>] [<ref>]
> >     ...
> >
> > We are not completing correctly this implicit uses of "show":
> >
> > With ...
> >
> >     $ git checkout -b default
> >
> > ... we are not completing "default":
> >
> >     $ git reflog def<TAB><TAB>
> >
> > And we are incorrectly returning the "subcommands" when:
> >
> >     $ git reflog default <TAB><TAB>
> >     delete expire show
> >
> > Let's use __gitcomp_subcommand to correctly handle implicit
> > subcommands.
> 
> As with a good bug report, if you are showing an "incorrect"
> behaviour, you should also illustrate what you think is the
> "correct" behaviour (see below).
> 
> >   1. cf39f54efc (git reflog show, 2007-02-08)
> >
> > Signed-off-by: Rubén Justo <rjusto@gmail.com>
> > ---
> >  contrib/completion/git-completion.bash | 9 ++++-----
> >  t/t9902-completion.sh                  | 8 ++++++++
> >  2 files changed, 12 insertions(+), 5 deletions(-)
> >
> > diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
> > index 5f2e904b56..c41f25aa80 100644
> > --- a/contrib/completion/git-completion.bash
> > +++ b/contrib/completion/git-completion.bash
> > @@ -2448,13 +2448,12 @@ _git_rebase ()
> >  _git_reflog ()
> >  {
> >  	local subcommands="show delete expire"
> > -	local subcommand="$(__git_find_on_cmdline "$subcommands")"
> >  
> > -	if [ -z "$subcommand" ]; then
> > -		__gitcomp "$subcommands"
> > -	else
> > -		__git_complete_refs
> > +	if __gitcomp_subcommand "$subcommands"; then
> > +		return
> >  	fi
> > +
> > +	__git_complete_refs
> >  }
> 
> So, when we see something that could be a subcommand we complete it
> as a subcommand and return.  In your example, how should
> 
>     $ git reflog def<TAB>
> 
> work?  We try to see if there is a subcommand that begins with
> "def", we see nothing matching, and then run __git_complete_refs?
> What if the branch you created earlier were not named "default" but,
> say, "delmonte", and you did "git reflog del<TAB>"?  Shouldn't the
> user be offered "delete" and "delmonte" as potential completions?
> 
> >  __git_send_email_confirm_options="always never auto cc compose"
> > diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
> > index aa9a614de3..231e17f378 100755
> > --- a/t/t9902-completion.sh
> > +++ b/t/t9902-completion.sh
> > @@ -2618,6 +2618,14 @@ test_expect_success 'git clone --config= - value' '
> >  	EOF
> >  '
> >  
> > +test_expect_success 'git reflog show' '
> > +	test_when_finished "git checkout -" &&
> > +	git checkout -b shown &&
> > +	test_completion "git reflog sho" "show " &&
> 
> IOW, shouldn't this offer both show and shown?
What should we do?
When the user have a branch "show":
   $ git checkout -b show
   $ git reflog sho<TAB><TAB>
And with:
   $ git reflog <TAB><TAB>
Should we suggest the subcommands alongside the branches?

I thought about this, and it's a can of worms. I concluded that a sane an instructive for the user approach is to first try the subcommands and if no option is found, then try the implicit "show".

Maybe I'm overthinking it ...
Show 7 quoted lines
> 
> > +	test_completion "git reflog show sho" "shown " &&
> > +	test_completion "git reflog shown sho" "shown "
> > +'
> > +
> >  test_expect_success 'options with value' '
> >  	test_completion "git merge -X diff-algorithm=" <<-\EOF
Thanks.
Previous: Junio C HamanoNext: Junio C Hamano
Message 11 of 22 in “completion for git-reflog show”
  1. 0/4 completion for git-reflog showRubén Justo, Jan 26, 2024
  2. 1/4 completion: introduce __gitcomp_subcommandRubén Justo, Jan 26, 2024
  3. Junio C HamanoJan 26, 2024
  4. Rubén JustoJan 26, 2024
  5. Junio C HamanoJan 26, 2024
  6. 2/4 completion: introduce __git_find_subcommandRubén Justo, Jan 26, 2024
  7. Junio C HamanoJan 26, 2024
  8. Rubén JustoJan 27, 2024
  9. 3/4 completion: reflog with implicit "show"Rubén Justo, Jan 26, 2024
  10. Junio C HamanoJan 26, 2024
  11. Rubén JustoJan 26, 2024
  12. Junio C HamanoFeb 21, 2024
  13. Rubén JustoFeb 21, 2024
  14. Rubén JustoFeb 29, 2024
  15. Junio C HamanoFeb 29, 2024
  16. 4/4 completion: reflog show <log-options>Rubén Justo, Jan 26, 2024
  17. 0/5 completion for git-reflog showRubén Justo, Mar 2, 2024
  18. 1/5 completion: reflog with implicit "show"Rubén Justo, Mar 2, 2024
  19. 3/5 completion: reflog show <log-options>Rubén Justo, Mar 2, 2024
  20. 2/5 completion: introduce __git_find_subcommandRubén Justo, Mar 2, 2024
  21. 4/5 completion: factor out __git_resolve_builtinsRubén Justo, Mar 2, 2024
  22. 5/5 completion: reflog subcommands and optionsRubén Justo, Mar 2, 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.