From e3154148ff59c33b80418ac2c69f3e20e87bb86b Mon Sep 17 00:00:00 2001 From: Dan Buch Date: Sun, 18 Jun 2023 22:46:50 -0400 Subject: [PATCH] Bash completion nits --- autocomplete/bash_autocomplete | 0 docs/v2/examples/bash-completions.md | 4 ++++ 2 files changed, 4 insertions(+) mode change 100755 => 100644 autocomplete/bash_autocomplete diff --git a/autocomplete/bash_autocomplete b/autocomplete/bash_autocomplete old mode 100755 new mode 100644 diff --git a/docs/v2/examples/bash-completions.md b/docs/v2/examples/bash-completions.md index e9265f4c2d..aaa7dc35ef 100644 --- 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.