secret-tool completion file conflicting with upstream file

[rffontenelle]

Describe the bug

Since libsecret 0.21.6, the completion file secret-tool is include and installed in the very same directory as bash-completion. For downstream distros this may cause file conflicts blocking both packages to be installed at the same time. For instance, see this issue this issue in Arch Linux for libsecret bash-completion package.

EDIT: issue moved from libsecret to bash-completion

Should the secret-tool completion file be removed from bash-completion, since the upstream now ships it?

To reproduce

On Arch Linux:

1. Install bash-completion (right now, version 2.15.0-1)
2. Enable testing repositories
3. Try to install libsecret 0.21.6-1
4. Arch's package manager (pacman) fails with message:

libsecret: /usr/share/bash-completion/completions/secret-tool exists in filesystem (owned by bash-completion)

Expected behavior

No conflict between libsecret and bash-completion, allowing both to be installed.

Versions (please complete the following information)

• Operating system name/distribution and version: Arch Linux (x86_64, rolling release)
• bash version, echo "$BASH_VERSION": 5.2.37(1)-release
• bash-completion version, (IFS=.; echo "${BASH_COMPLETION_VERSINFO[*]}"): 2.15.0

Additional context

Debug trace

[david-geiger]

Same issue here on Mageia Cauldron!

[scop]

Interesting. Per https://github.com/GNOME/libsecret/tree/0.20.5/bash-completion it looks like upstream completion has been available since 0.20.5, so about 3 years, but this is the first time I've heard of the conflict.

Our standard action in cases like this is to deprecate our completion, which in this case is a bit of a shame as it seems much more featureful than the upstream one. Perhaps someone would be interested in submitting our goodies for inclusion there?

[scop]

Anyway in the meantime, I suggest asking for a fix from your distro packagers, either the libsecret or bash-completion one, so that only one of them ships the completion in the package.

[nielsdg]

Hi @scop, this is the libsecret upstream maintainer here. I actually didn't know there was a completion file already here until someone pointed it out to me.

looks like upstream completion has been available since 0.20.5, so about 3 years, but this is the first time I've heard of the conflict.

Yeah, we found out very recently it wasn't included in our build scripts, which is somewhat of a shame 😅

Our standard action in cases like this is to deprecate our completion, which in this case is a bit of a shame as it seems much more featureful than the upstream one. Perhaps someone would be interested in submitting our goodies for inclusion there?

FWIW, I'm willing to take what you have here indeed. I'd like to make sure you and @akinomyoga are properly attributed through as a Co-authored-by: line in the commit message, would you like to mention your preferred (nick)name and email for that to me?

[akinomyoga]

FWIW, I'm willing to take what you have here indeed. I'd like to make sure you and @akinomyoga are properly attributed through as a Co-authored-by: line in the commit message, would you like to mention your preferred (nick)name and email for that to me?

Thanks! You can pick them up from existing commit messages, e.g. the one in 521d829.

[nielsdg]

Thanks! I've subbmitted this at https://gitlab.gnome.org/GNOME/libsecret/-/merge_requests/161 and merged it :-)

[scop]

Nice, thanks!

I just wanted to drop a note that merging the completion from bash-completion as is means it is using the latest features we have. For example, it is using the _comp_initialize and _comp_compgen functions, both of which were introduced not that long ago, in bash-completion 2.12 (February 2024). Consequently, it will produce errors for users having an older bash-completion. For an overview where various distributions stand, see https://repology.org/project/bash-completion/versions

It is possible to rework it to use the now deprecated (with no slated removal date, if ever) functions like _init_completion etc; that would make it work with much older bash-completion versions as well as the current ones.