Skip to content

Commit b4b88d4

Browse files
committed
docs(README): elaborate why prefer .bash suffixed completion files
1 parent 73a3c3c commit b4b88d4

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,12 @@ A. [ Disclaimer: Here, how to make the completion code visible to
182182
commands' names, so be sure to name your completion file accordingly, and
183183
to include (for example) symbolic links in case the file provides
184184
completions for more than one command. The completion filename for command
185-
`foo` in this directory should be `foo.bash`. Unsuffixed `foo` also
186-
works, but it is deprecated in >= 2.18.
185+
`foo` in this directory should be `foo.bash` to avoid conflicts with
186+
completions possibly shipped for the same command by the installed < 2.18
187+
version of bash-completion (which did not use the `.bash` suffix for any
188+
of its completion files), and because the `.bash` suffixed version has
189+
higher load order precedence. Unsuffixed `foo` also works,
190+
but is deprecated in >= 2.18 for these reasons.
187191
- Helper scripts used by completions may be placed in the directory
188192
`<helpersdir>`, which can be retrieved with `pkg-config
189193
--variable=helpersdir bash-completion`. The completion files in

0 commit comments

Comments
 (0)