From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "SZEDER Gábor" <szeder.dev@gmail.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH 46/47] completion: add proper public __git_complete
Date: Thu, 31 Dec 2020 20:16:21 -0600 [thread overview]
Message-ID: <20210101021622.798041-47-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210101021622.798041-1-felipe.contreras@gmail.com>
When __git_complete was introduced, it was meant to be temporarily, while
a proper guideline for public shell functions was established
(tentatively _GIT_complete), but since that never happened, people
in the wild started to use __git_complete, even though it was marked as
not public.
Eight years is more than enough wait, let's mark this function as
public, and make it a bit more user-friendly.
So that instead of doing:
__git_complete gk __gitk_main
The user can do:
__git_complete gk gitk
And instead of:
__git_complete gf _git_fetch
Do:
__git_complete gf git_fetch
Backwards compatibility is maintained.
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
contrib/completion/git-completion.bash | 40 +++++++++++++++++++++-----
t/t9902-completion.sh | 14 ++++++++-
2 files changed, 46 insertions(+), 8 deletions(-)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 11a9433363..a0e5752217 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -29,6 +29,15 @@
# tell the completion to use commit completion. This also works with aliases
# of form "!sh -c '...'". For example, "!sh -c ': git commit ; ... '".
#
+# If you have a command that is not part of git, but you would still
+# like completion, you can use __git_complete:
+#
+# __git_complete gl git_log
+#
+# Or if it's a main command (i.e. git or gitk):
+#
+# __git_complete gk gitk
+#
# Compatible with bash 3.2.57.
#
# You can set the following environment variables to influence the behavior of
@@ -3429,10 +3438,7 @@ __git_func_wrap ()
$1
}
-# Setup completion for certain functions defined above by setting common
-# variables and workarounds.
-# This is NOT a public function; use at your own risk.
-__git_complete ()
+___git_complete ()
{
local wrapper="__git_wrap${2}"
eval "$wrapper () { __git_func_wrap $2 ; }"
@@ -3440,13 +3446,33 @@ __git_complete ()
|| complete -o default -o nospace -F $wrapper $1
}
-__git_complete git __git_main
-__git_complete gitk __gitk_main
+# Setup the completion for git commands
+# 1: command or alias
+# 2: function to call (e.g. `git`, `gitk`, `git_fetch`)
+__git_complete ()
+{
+ local func
+
+ if __git_have_func $2; then
+ func=$2
+ elif __git_have_func __$2_main; then
+ func=__$2_main
+ elif __git_have_func _$2; then
+ func=_$2
+ else
+ echo "ERROR: could not find function '$2'" 1>&2
+ return 1
+ fi
+ ___git_complete $1 $func
+}
+
+___git_complete git __git_main
+___git_complete gitk __gitk_main
# The following are necessary only for Cygwin, and only are needed
# when the user has tab-completed the executable name and consequently
# included the '.exe' suffix.
#
if [ "$OSTYPE" = cygwin ]; then
- __git_complete git.exe __git_main
+ ___git_complete git.exe __git_main
fi
diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
index 01984692bb..b9490637f9 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -2381,10 +2381,22 @@ test_expect_success 'sourcing the completion script clears cached --options' '
test_expect_success '__git_complete' '
unset -f __git_wrap__git_main &&
+
__git_complete foo __git_main &&
__git_have_func __git_wrap__git_main &&
+ unset -f __git_wrap__git_main &&
+
__git_complete gf _git_fetch &&
- __git_have_func __git_wrap_git_fetch
+ __git_have_func __git_wrap_git_fetch &&
+
+ __git_complete foo git &&
+ __git_have_func __git_wrap__git_main &&
+ unset -f __git_wrap__git_main &&
+
+ __git_complete gd git_diff &&
+ __git_have_func __git_wrap_git_diff &&
+
+ test_must_fail __git_complete ga missing
'
test_done
--
2.30.0
next prev parent reply other threads:[~2021-01-01 2:18 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-01 2:15 [PATCH 00/47] completion: git-completion 1.3 patches Felipe Contreras
2021-01-01 2:15 ` [PATCH 01/47] completion: bash: fix prefix detection in branch.* Felipe Contreras
2021-01-01 2:15 ` [PATCH 02/47] completion: fix for suboptions with value Felipe Contreras
2021-01-01 2:15 ` [PATCH 03/47] completion: bash: fix for multiple dash commands Felipe Contreras
2021-01-01 2:15 ` [PATCH 04/47] completion: bash: add correct suffix in variables Felipe Contreras
2021-01-01 2:15 ` [PATCH 05/47] completion: bash: do not modify COMP_WORDBREAKS Felipe Contreras
2021-01-01 2:15 ` [PATCH 06/47] test: completion: fix currently typed words Felipe Contreras
2021-01-01 2:15 ` [PATCH 07/47] test: completion: switch __gitcomp_nl prefix test Felipe Contreras
2021-01-01 2:15 ` [PATCH 08/47] test: completion: add run_func() helper Felipe Contreras
2021-01-01 2:15 ` [PATCH 09/47] completion: bash: remove non-append functionality Felipe Contreras
2021-01-01 2:15 ` [PATCH 10/47] completion: bash: get rid of _append() functions Felipe Contreras
2021-01-01 2:15 ` [PATCH 11/47] completion: bash: get rid of any non-append code Felipe Contreras
2021-01-01 2:15 ` [PATCH 12/47] completion: zsh: fix options with arguments Felipe Contreras
2021-01-01 2:15 ` [PATCH 13/47] completion: zsh: expand --git-dir file argument Felipe Contreras
2021-01-01 2:15 ` [PATCH 14/47] completion: zsh: add support for general -C opts Felipe Contreras
2021-01-01 2:15 ` [PATCH 15/47] completion: zsh: fix for undefined completions Felipe Contreras
2021-01-01 2:15 ` [PATCH 16/47] completion: zsh: add support for general -c opts Felipe Contreras
2021-01-01 2:15 ` [PATCH 17/47] completion: zsh: fix extra space on foo= Felipe Contreras
2021-01-01 2:15 ` [PATCH 18/47] completion: zsh: add excluded options Felipe Contreras
2021-01-01 2:15 ` [PATCH 19/47] completion: zsh: always set compset Felipe Contreras
2021-01-01 2:15 ` [PATCH 20/47] completion: factor out check in __gitcomp Felipe Contreras
2021-01-01 2:15 ` [PATCH 21/47] completion: simplify equal suffix check Felipe Contreras
2021-01-01 2:15 ` [PATCH 22/47] completion: refactor __gitcomp Felipe Contreras
2021-01-01 2:15 ` [PATCH 23/47] completion: simplify __gitcomp Felipe Contreras
2021-01-01 2:15 ` [PATCH 24/47] completion: bash: change suffix check in __gitcomp Felipe Contreras
2021-01-01 2:16 ` [PATCH 25/47] completion: improve __gitcomp suffix code Felipe Contreras
2021-01-01 2:16 ` [PATCH 26/47] completion: bash: simplify config_variable_name Felipe Contreras
2021-01-01 2:16 ` [PATCH 27/47] test: completion: add missing test Felipe Contreras
2021-01-01 2:16 ` [PATCH 28/47] completion: bash: improve __gitcomp description Felipe Contreras
2021-01-01 2:16 ` [PATCH 29/47] completion: add __gitcomp_opts Felipe Contreras
2021-01-01 2:16 ` [PATCH 30/47] completion: bash: cleanup __gitcomp* invocations Felipe Contreras
2021-01-01 2:16 ` [PATCH 31/47] completion: bash: shuffle __gitcomp functions Felipe Contreras
2021-01-01 2:16 ` [PATCH 32/47] completion: zsh: simplify __gitcomp_direct Felipe Contreras
2021-01-01 2:16 ` [PATCH 33/47] completion: zsh: shuffle __gitcomp* functions Felipe Contreras
2021-01-01 2:16 ` [PATCH 34/47] completion: zsh: fix direct quoting Felipe Contreras
2021-01-01 2:16 ` [PATCH 35/47] completion: zsh: add elements individually in __gitcomp_opts Felipe Contreras
2021-01-01 2:16 ` [PATCH 36/47] completion: zsh: add __gitcompadd helper Felipe Contreras
2021-01-01 2:16 ` [PATCH 37/47] completion: zsh: add correct removable suffix Felipe Contreras
2021-01-01 2:16 ` [PATCH 38/47] completion: bash: simplify _get_comp_words_by_ref() Felipe Contreras
2021-01-01 2:16 ` [PATCH 39/47] completion: bash: refactor _get_comp_words_by_ref() Felipe Contreras
2021-01-01 2:16 ` [PATCH 40/47] completion: bash: cleanup _get_comp_words_by_ref() Felipe Contreras
2021-01-01 2:16 ` [PATCH 41/47] completion: bash: trivial cleanup Felipe Contreras
2021-01-01 2:16 ` [PATCH 42/47] completion: bash: rename _get_comp_words_by_ref() Felipe Contreras
2021-01-01 2:16 ` [PATCH 43/47] completion: bash: add __git_have_func helper Felipe Contreras
2021-01-01 2:16 ` [PATCH 44/47] completion: bash: improve function detection Felipe Contreras
2021-01-01 2:16 ` [PATCH 45/47] test: completion: add tests for __git_complete Felipe Contreras
2021-01-01 2:16 ` Felipe Contreras [this message]
2021-01-01 2:16 ` [PATCH 47/47] completion: zsh: add higher-priority location Felipe Contreras
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210101021622.798041-47-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=pclouds@gmail.com \
--cc=szeder.dev@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).