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

Filename for bash completions should match existing conventions #567

Closed
joshtriplett opened this issue Jul 4, 2016 · 1 comment
Closed
Labels
A-completion Area: completion generator A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations
Milestone

Comments

@joshtriplett
Copy link
Contributor

joshtriplett commented Jul 4, 2016

bash-completion expects files installed in /usr/share/bash-completion/completions/$binname, named exactly like the binary they provide completions for. (This enables bash-completion's dynamic script loading, so it doesn't need to load all completion scripts at shell startup.) At packaging time, to avoid conflict with binaries or directories of the same name, packaging systems (like Debian's) typically expect files named ${binname}.bash-completion, which they then install to the appropriate directory with the appropriate name. Please consider changing the default name of clap's generated completion scripts to match that pattern.

Also, as #566 suggests, consider separating the generation of completions from the writing of files, and expose a function for the former too.

@kbknapp
Copy link
Member

kbknapp commented Jul 4, 2016

This should be a quick easy fix. The docs will need to be updated as well. Thanks!

@kbknapp kbknapp added C-enhancement Category: Raise on the bar on expectations A-docs Area: documentation, including docs.rs, readme, examples, etc... D: easy A-completion Area: completion generator labels Jul 4, 2016
@kbknapp kbknapp added this to the 2.10.5 milestone Aug 26, 2016
kbknapp added a commit that referenced this issue Aug 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-completion Area: completion generator A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations
Projects
None yet
Development

No branches or pull requests

2 participants