From 4c07685258f0c700d9d5696e6fee8261a01f7703 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Fri, 30 Mar 2018 14:57:38 +0100 Subject: [PATCH] cmd/help: usability tweaks. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Don’t mention `brew home` or `brew options` as their output is in `brew info` (and the `(…|…)` is weird. - Use full length flags for `-v` and `-d` to make more obvious what they are doing - Don’t use `Developers`; instead point out it’s how you contribute - Mention `brew commands` for `COMMAND` output (like we do with `FORMULA` and `brew search`) - Point towards `docs.brew.sh` --- Library/Homebrew/cmd/help.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Library/Homebrew/cmd/help.rb b/Library/Homebrew/cmd/help.rb index 2b1e7c5049..fa5727816e 100644 --- a/Library/Homebrew/cmd/help.rb +++ b/Library/Homebrew/cmd/help.rb @@ -1,7 +1,7 @@ HOMEBREW_HELP = <<~EOS.freeze Example usage: brew search [TEXT|/REGEX/] - brew (info|home|options) [FORMULA...] + brew info [FORMULA...] brew install FORMULA... brew update brew upgrade [FORMULA...] @@ -11,17 +11,17 @@ HOMEBREW_HELP = <<~EOS.freeze Troubleshooting: brew config brew doctor - brew install -vd FORMULA + brew install --verbose --debug FORMULA - Developers: + Contributing: brew create [URL [--no-fetch]] brew edit [FORMULA...] - https://docs.brew.sh/Formula-Cookbook Further help: - man brew + brew commands brew help [COMMAND] - brew home + man brew + https://docs.brew.sh EOS # NOTE Keep the lenth of vanilla --help less than 25 lines!