| Message ID | 20240425101845.708554-1-rhi@pengutronix.de (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | cb85fdf4a4445fd201133dfc8d1e43c7e2e68bf5 |
| Headers | show |
| Series | [v3,1/3] completion: add 'symbolic-ref' | expand |
On Thu, Apr 25, 2024, at 12:18, Roland Hieber wrote: > Signed-off-by: Roland Hieber <rhi@pengutronix.de> > --- > PATCH v3: > - make use of __gitcomp_builtin instead of hard-coded options, and add > a test for it (thanks to Patrick Steinhardt) > - add empty line between test cases (thanks to Patrick Steinhardt) > > PATCH v2: https://lore.kernel.org/git/20240424215019.268208-1-rhi@pengutronix.de > - no changes > > PATCH v1: > https://lore.kernel.org/git/20240424210549.256256-1-rhi@pengutronix.de/ You can use `git format-patch --in-reply-to='20240424215019.268208-1-rhi@pengutronix.de'` in order to link v3 to v2 (or rather: you can use that for a possible v4 (points to v3)). (I was going to link to SubmittingPatches here but I didn’t find a mention of it there. Apparently I misremembered.)
On 24/04/25 12:45PM, Kristoffer Haugsbakk wrote: > On Thu, Apr 25, 2024, at 12:18, Roland Hieber wrote: > > Signed-off-by: Roland Hieber <rhi@pengutronix.de> > > --- > > PATCH v3: > > - make use of __gitcomp_builtin instead of hard-coded options, and add > > a test for it (thanks to Patrick Steinhardt) > > - add empty line between test cases (thanks to Patrick Steinhardt) > > > > PATCH v2: https://lore.kernel.org/git/20240424215019.268208-1-rhi@pengutronix.de > > - no changes > > > > PATCH v1: > > https://lore.kernel.org/git/20240424210549.256256-1-rhi@pengutronix.de/ > > You can use `git format-patch > --in-reply-to='20240424215019.268208-1-rhi@pengutronix.de'` in order to > link v3 to v2 (or rather: you can use that for a possible v4 (points to > v3)). > > (I was going to link to SubmittingPatches here but I didn’t find a > mention of it there. Apparently I misremembered.) There is a section in the MyFirstContribution docs that mentions it briefly: https://git-scm.com/docs/MyFirstContribution#v2-git-send-email -Justin
Justin Tobler <jltobler@gmail.com> writes: >> (I was going to link to SubmittingPatches here but I didn’t find a >> mention of it there. Apparently I misremembered.) > > There is a section in the MyFirstContribution docs that mentions it > briefly: > > https://git-scm.com/docs/MyFirstContribution#v2-git-send-email Thanks for noticing. We should improve the situation by probably moving[*] more from the latter to SubmittingPatches so that people do not need to refer to both just to find out the essentials. [*] If it is small, just copy; if it is large, move and then replace the original with a reference into SubmittingPatches.
Roland Hieber <rhi@pengutronix.de> writes: > 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 v3: > - make use of __gitcomp_builtin instead of hard-coded options, and add > a test for it (thanks to Patrick Steinhardt) Nice. > - add empty line between test cases (thanks to Patrick Steinhardt) > > PATCH v2: https://lore.kernel.org/git/20240424215019.268208-1-rhi@pengutronix.de > - 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 | 23 +++++++++++++++++++++++ > 2 files changed, 34 insertions(+) > > diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash > index 75193ded4bde..4d63fb6eeaf7 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_builtin symbolic-ref > + 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..963f865f27ed 100755 > --- a/t/t9902-completion.sh > +++ b/t/t9902-completion.sh > @@ -2518,6 +2518,29 @@ test_expect_success 'complete tree filename with metacharacters' ' > EOF > ' > > +test_expect_success 'symbolic-ref completes builtin options' ' > + test_completion "git symbolic-ref --d" <<-\EOF > + --delete Z > + 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
On 24/04/25 09:42AM, Junio C Hamano wrote: > Justin Tobler <jltobler@gmail.com> writes: > > >> (I was going to link to SubmittingPatches here but I didn’t find a > >> mention of it there. Apparently I misremembered.) > > > > There is a section in the MyFirstContribution docs that mentions it > > briefly: > > > > https://git-scm.com/docs/MyFirstContribution#v2-git-send-email > > Thanks for noticing. > > We should improve the situation by probably moving[*] more from the > latter to SubmittingPatches so that people do not need to refer to > both just to find out the essentials. > > > [*] If it is small, just copy; if it is large, move and then replace > the original with a reference into SubmittingPatches. > I think this is a good idea. Submitted a patch that attempts to improve this. https://lore.kernel.org/git/20240425213404.133660-1-jltobler@gmail.com/ -Justin
Justin Tobler <jltobler@gmail.com> writes: >> We should improve the situation by probably moving[*] more from the >> latter to SubmittingPatches so that people do not need to refer to >> both just to find out the essentials. >> >> >> [*] If it is small, just copy; if it is large, move and then replace >> the original with a reference into SubmittingPatches. >> > > I think this is a good idea. Submitted a patch that attempts to improve > this. Thanks. Its details are a bit different from what I expected, but this will work just fine in practice, I would think. Will queue.
On Thu, Apr 25, 2024 at 12:18:42PM +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> Thanks, this version looks good to me. Patrick
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash index 75193ded4bde..4d63fb6eeaf7 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_builtin symbolic-ref + 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..963f865f27ed 100755 --- a/t/t9902-completion.sh +++ b/t/t9902-completion.sh @@ -2518,6 +2518,29 @@ test_expect_success 'complete tree filename with metacharacters' ' EOF ' +test_expect_success 'symbolic-ref completes builtin options' ' + test_completion "git symbolic-ref --d" <<-\EOF + --delete Z + 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
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 v3: - make use of __gitcomp_builtin instead of hard-coded options, and add a test for it (thanks to Patrick Steinhardt) - add empty line between test cases (thanks to Patrick Steinhardt) PATCH v2: https://lore.kernel.org/git/20240424215019.268208-1-rhi@pengutronix.de - 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 | 23 +++++++++++++++++++++++ 2 files changed, 34 insertions(+)