Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bash completion: add support for git 2.30 and on #3342

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eli-schwartz
Copy link
Contributor

The _git backwards compat wrapper was dropped upstream: git/git@441ecda

Instead, we rely on __git_complete to detect loaded bash completions, since we will use it later on to set up completions -- it is now public API.

There is a gap between git 2.30 and 2.31 where _git does not exist, but there is no public API to create completions. Starting 2.31, we are formally permitted to copy/imitate the upstream completions with:

__git_complete mycmd git_cmd

For 2.30 specifically, we have to pass the internal completion function used instead of "git_cmd", but it's difficult to detect this necessity in a forwards-compatible way. Try it that way first, in the assumption that if the internal completion function still exists it does the same thing.

Closes #2684
Closes #2948

Copy link

@ches ches left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Three years since #2684 (comment) I finally wanted to look into what the proper backward-compatible and API-stable patch should be, and @eli-schwartz has already done the homework.

Thanks and 👍🏼, verified this patch works for me.

# git < 2.30
complete -o bashdefault -o default -o nospace -F _git hub 2>/dev/null \
|| complete -o default -o nospace -F _git hub
elif declare -F __git_main; then
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
elif declare -F __git_main; then
elif declare -F __git_main >/dev/null; then

Consistent with the preceding conditional branch, this fixes __git_main being echoed during shell session initialization.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, yes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, in my local git clone it turns out I had already made this change!! and used it locally. The problem is, that I forgot to git add it...

The _git backwards compat wrapper was dropped upstream:
git/git@441ecda

Instead, we rely on __git_complete to detect loaded bash completions,
since we will use it later on to set up completions -- it is now public
API.

There is a gap between git 2.30 and 2.31 where _git does not exist, but
there is no public API to create completions. Starting 2.31, we are
formally permitted to copy/imitate the upstream completions with:

```
__git_complete mycmd git_cmd
```

For 2.30 specifically, we have to pass the internal completion function
used instead of "git_cmd", but it's difficult to detect this necessity
in a forwards-compatible way. Try it that way first, in the assumption
that if the internal completion function still exists it does the same
thing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bash completion incompatibility with git 2.30.0
2 participants