From be040f9c6640569db366cc07a1078803819a049e Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Mon, 11 Mar 2019 12:59:39 -0400 Subject: [PATCH] info: update help text --- Library/Homebrew/cmd/info.rb | 29 +++++++++++++++++------------ docs/Manpage.md | 18 ++++++++++-------- manpages/brew.1 | 21 ++++++++++++--------- 3 files changed, 39 insertions(+), 29 deletions(-) diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb index c2145919e0..b615d08cff 100644 --- a/Library/Homebrew/cmd/info.rb +++ b/Library/Homebrew/cmd/info.rb @@ -13,37 +13,42 @@ module Homebrew def info_args Homebrew::CLI::Parser.new do usage_banner <<~EOS - `info` [] + `info` [] [] Display brief statistics for your Homebrew installation. + + If is specified, show summary of information about . EOS switch "--analytics", - description: "Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS` "\ - "or `HOMEBREW_NO_GITHUB_API` are set)." + description: "Display global Homebrew analytics data or, if specified, installation and "\ + "build error data for (provided neither `HOMEBREW_NO_ANALYTICS` "\ + "nor `HOMEBREW_NO_GITHUB_API` are set)." flag "--days", depends_on: "--analytics", - description: "The value for `days` must be `30`, `90` or `365`. The default is `30`." + description: "How many days of global analytics data to retrieve. "\ + "The value for must be `30`, `90` or `365`. The default is `30`." flag "--category", depends_on: "--analytics", - description: "The value for `category` must be `install`, `install-on-request`, "\ + description: "Which type of global analytics data to retrieve. "\ + "The value for must be `install`, `install-on-request`, "\ "`cask-install`, `build-error` or `os-version`. The default is `install`." switch "--github", - description: "Open a browser to the GitHub History page for provided . "\ + description: "Open a browser to the GitHub source page for . "\ "To view formula history locally: `brew log -p` " flag "--json", description: "Print a JSON representation of . Currently the default and only accepted "\ "value for is `v1`. See the docs for examples of using the JSON "\ "output: " - switch "--all", - depends_on: "--json", - description: "Get information on all formulae." switch "--installed", depends_on: "--json", - description: "Get information on all installed formulae." + description: "Print JSON of formulae that are currently installed." + switch "--all", + depends_on: "--json", + description: "Print JSON of all available formulae." switch :verbose, - description: "See more verbose analytics data." + description: "Show more verbose analytics data for ." switch :debug - conflicts "--all", "--installed" + conflicts "--installed", "--all" end end diff --git a/docs/Manpage.md b/docs/Manpage.md index 49e37761e0..1f6c9de108 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -194,24 +194,26 @@ If no logs are found, an error message is presented. Open *`formula`*'s homepage in a browser. If no formula is provided, open Homebrew's own homepage in a browser. -### `info` [*`formula`*] +### `info` [*`options`*] [*`formula`*] Display brief statistics for your Homebrew installation. +If *`formula`* is specified, show summary of information about *`formula`*. + * `--analytics`: - Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` are set). + Display global Homebrew analytics data or, if specified, installation and build error data for *`formula`* (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set). * `--days`: - The value for `days` must be `30`, `90` or `365`. The default is `30`. + How many days of global analytics data to retrieve. The value for *`days`* must be `30`, `90` or `365`. The default is `30`. * `--category`: - The value for `category` must be `install`, `install-on-request`, `cask-install`, `build-error` or `os-version`. The default is `install`. + Which type of global analytics data to retrieve. The value for *`category`* must be `install`, `install-on-request`, `cask-install`, `build-error` or `os-version`. The default is `install`. * `--github`: - Open a browser to the GitHub History page for provided *`formula`*. To view formula history locally: `brew log -p` *`formula`* + Open a browser to the GitHub source page for *`formula`*. To view formula history locally: `brew log -p` *`formula`* * `--json`: Print a JSON representation of *`formula`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: -* `--all`: - Get information on all formulae. * `--installed`: - Get information on all installed formulae. + Print JSON of formulae that are currently installed. +* `--all`: + Print JSON of all available formulae. ### `install` [*`options`*] *`formula`* diff --git a/manpages/brew.1 b/manpages/brew.1 index a0f257f496..4dd6e9a912 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -230,36 +230,39 @@ The Gist will be marked private and will not appear in listings but will be acce .SS "\fBhome\fR [\fIformula\fR]" Open \fIformula\fR\'s homepage in a browser\. If no formula is provided, open Homebrew\'s own homepage in a browser\. . -.SS "\fBinfo\fR [\fIformula\fR]" +.SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR]" Display brief statistics for your Homebrew installation\. . +.P +If \fIformula\fR is specified, show summary of information about \fIformula\fR\. +. .TP \fB\-\-analytics\fR -Display Homebrew analytics data (provided neither \fBHOMEBREW_NO_ANALYTICS\fR or \fBHOMEBREW_NO_GITHUB_API\fR are set)\. +Display global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fR (provided neither \fBHOMEBREW_NO_ANALYTICS\fR nor \fBHOMEBREW_NO_GITHUB_API\fR are set)\. . .TP \fB\-\-days\fR -The value for \fBdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\. +How many days of global analytics data to retrieve\. The value for \fIdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\. . .TP \fB\-\-category\fR -The value for \fBcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBcask\-install\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\. +Which type of global analytics data to retrieve\. The value for \fIcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBcask\-install\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\. . .TP \fB\-\-github\fR -Open a browser to the GitHub History page for provided \fIformula\fR\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR +Open a browser to the GitHub source page for \fIformula\fR\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR . .TP \fB\-\-json\fR Print a JSON representation of \fIformula\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR . .TP -\fB\-\-all\fR -Get information on all formulae\. +\fB\-\-installed\fR +Print JSON of formulae that are currently installed\. . .TP -\fB\-\-installed\fR -Get information on all installed formulae\. +\fB\-\-all\fR +Print JSON of all available formulae\. . .SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR" Install \fIformula\fR\.