Merge pull request #1762 from urfave/bash-compl-nits

Bash completion nits
urfave · Jun 19, 2023 · a97a5d7 · a97a5d7
2 parents c023d9b + e315414
commit a97a5d7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/autocomplete/bash_autocomplete b/autocomplete/bash_autocomplete
diff --git a/docs/v2/examples/bash-completions.md b/docs/v2/examples/bash-completions.md
@@ -133,6 +133,10 @@ func main() {
 To enable auto-completion for the current shell session, a bash script,
 `autocomplete/bash_autocomplete` is included in this repo.
 
+> :warning: The `bash-completion` package or equivalent that provides the
+> `_get_comp_words_by_ref` function for the target platform must be installed and
+> initialized for this completion script to work correctly.
+
 To use `autocomplete/bash_autocomplete` set an environment variable named `PROG`
 to the name of your program and then `source` the
 `autocomplete/bash_autocomplete` file.