completions: clarify that only external tap completions are affected

Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
This commit is contained in:
Rylan Polster 2021-01-12 16:30:29 -05:00
parent f1f3fdc315
commit eb3a662841
4 changed files with 4 additions and 4 deletions

View File

@ -15,7 +15,7 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`completions` [<subcommand>] `completions` [<subcommand>]
Control whether Homebrew automatically links shell completion files. Control whether Homebrew automatically links external tap shell completion files.
Read more at <https://docs.brew.sh/Shell-Completion>. Read more at <https://docs.brew.sh/Shell-Completion>.
`brew completions` [`state`]: `brew completions` [`state`]:

View File

@ -56,7 +56,7 @@ module Completions
T.unsafe(self).ohai "Homebrew completions for external commands are unlinked by default!" T.unsafe(self).ohai "Homebrew completions for external commands are unlinked by default!"
T.unsafe(self).puts <<~EOS T.unsafe(self).puts <<~EOS
To opt-in to automatically linking Homebrew shell competion files, run: To opt-in to automatically linking external tap shell competion files, run:
brew completions link brew completions link
Then, follow the directions at #{Formatter.url("https://docs.brew.sh/Shell-Completion")} Then, follow the directions at #{Formatter.url("https://docs.brew.sh/Shell-Completion")}
EOS EOS

View File

@ -96,7 +96,7 @@ Show lists of built-in and external commands.
### `completions` [*`subcommand`*] ### `completions` [*`subcommand`*]
Control whether Homebrew automatically links shell completion files. Control whether Homebrew automatically links external tap shell completion files.
Read more at <https://docs.brew.sh/Shell-Completion>. Read more at <https://docs.brew.sh/Shell-Completion>.
`brew completions` [`state`] `brew completions` [`state`]

View File

@ -94,7 +94,7 @@ List only the names of commands without category headers\.
Include aliases of internal commands\. Include aliases of internal commands\.
. .
.SS "\fBcompletions\fR [\fIsubcommand\fR]" .SS "\fBcompletions\fR [\fIsubcommand\fR]"
Control whether Homebrew automatically links shell completion files\. Read more at \fIhttps://docs\.brew\.sh/Shell\-Completion\fR\. Control whether Homebrew automatically links external tap shell completion files\. Read more at \fIhttps://docs\.brew\.sh/Shell\-Completion\fR\.
. .
.P .P
\fBbrew completions\fR [\fBstate\fR] \fBbrew completions\fR [\fBstate\fR]