Skip to content

docs(README): elaborate why prefer .bash suffixed completion files #1610

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.

Sign up for GitHub

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

Open
scop wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −2
Open

docs(README): elaborate why prefer .bash suffixed completion files #1610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,12 @@ A. [ Disclaimer: Here, how to make the completion code visible to
commands' names, so be sure to name your completion file accordingly, and
to include (for example) symbolic links in case the file provides
completions for more than one command. The completion filename for command
`foo` in this directory should be `foo.bash`. Unsuffixed `foo` also
works, but it is deprecated in >= 2.18.
`foo` in this directory should be `foo.bash` to avoid conflicts with
completions possibly shipped for the same command by the installed < 2.18
version of bash-completion (which did not use the `.bash` suffix for any
of its completion files), and because the `.bash` suffixed version has
higher load order precedence. Unsuffixed `foo` also works,
but is deprecated in >= 2.18 for these reasons.
- Helper scripts used by completions may be placed in the directory
`<helpersdir>`, which can be retrieved with `pkg-config
--variable=helpersdir bash-completion`. The completion files in
Expand Down
Loading