From 74787ca0eeb3a1d4c19420dced32c9f5965175b0 Mon Sep 17 00:00:00 2001 From: Rylan Polster Date: Fri, 8 Jan 2021 11:26:33 -0500 Subject: [PATCH] docs: update shell completions instructions --- docs/Shell-Completion.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Shell-Completion.md b/docs/Shell-Completion.md index bb5aa592f5..6dd1785bca 100644 --- a/docs/Shell-Completion.md +++ b/docs/Shell-Completion.md @@ -4,7 +4,9 @@ Homebrew comes with completion definitions for the `brew` command. Some packages `zsh`, `bash` and `fish` are currently supported. -You must configure your shell to enable its completion support. This is because the Homebrew-managed completions are stored under `HOMEBREW_PREFIX` which your system shell may not be aware of, and since it is difficult to automatically configure `bash` and `zsh` completions in a robust manner, the Homebrew installer does not do it for you. +Shell completions for built-in Homebrew commands are not automatically installed. To opt-in to using our completions, they need to be linked to `HOMEBREW_PREFIX` by running `brew completions link`. + +You must then configure your shell to enable its completion support. This is because the Homebrew-managed completions are stored under `HOMEBREW_PREFIX` which your system shell may not be aware of, and since it is difficult to automatically configure `bash` and `zsh` completions in a robust manner, the Homebrew installer does not do it for you. ## Configuring Completions in `bash`