admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

outdated: Update documentation about json versions

Browse Source
This commit is contained in:
William Ma 2020-07-17 10:28:09 -04:00
parent 8c5140f6e6
commit 03857319c9
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Library/Homebrew/cmd/outdated.rb
View File

@ -22,11 +22,9 @@ module Homebrew
switch :verbose, switch :verbose,
description: "Include detailed version information." description: "Include detailed version information."
flag "--json", flag "--json",
description: "Print output in JSON format. Currently the default and only accepted "\ description: "Print output in JSON format. There are two versions: v1 and v2. " \
"value for <version> is `v1`. See the docs for examples of using the JSON "\ "v1 is deprecated and is currently the default if no version is specified. " \
"output: <https://docs.brew.sh/Querying-Brew>. "\ "v2 prints outdated formulae and casks. "
"By default, this option treats all arguments as formulae. "\
"To treat arguments as casks, use the --cask option."
switch "--fetch-HEAD", switch "--fetch-HEAD",
description: "Fetch the upstream repository to detect if the HEAD installation of the "\ description: "Fetch the upstream repository to detect if the HEAD installation of the "\
"formula is outdated. Otherwise, the repository's HEAD will only be checked for "\ "formula is outdated. Otherwise, the repository's HEAD will only be checked for "\
@ -48,6 +46,8 @@ module Homebrew
case json_version case json_version
when :v1 when :v1
opoo "JSON v1 has been deprecated. Please use --json=v2"
outdated = if args.formula? || !args.cask? outdated = if args.formula? || !args.cask?
outdated_formulae outdated_formulae
else else

2
docs/Manpage.md
View File

@ -356,7 +356,7 @@ otherwise.
* `-v`, `--verbose`: * `-v`, `--verbose`:
Include detailed version information. Include detailed version information.
* `--json`: * `--json`:
Print output in JSON format. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>. By default, this option treats all arguments as formulae. To treat arguments as casks, use the --cask option. Print output in JSON format. There are two versions: v1 and v2. v1 is deprecated and is currently the default if no version is specified. v2 prints outdated formulae and casks.
* `--fetch-HEAD`: * `--fetch-HEAD`:
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will only be checked for updates when a new stable or development version has been released. Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will only be checked for updates when a new stable or development version has been released.
* `--greedy`: * `--greedy`:

2
manpages/brew.1
View File

@ -477,7 +477,7 @@ Include detailed version information\.
. .
.TP .TP
\fB\-\-json\fR \fB\-\-json\fR
Print output in JSON format\. 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\. By default, this option treats all arguments as formulae\. To treat arguments as casks, use the \-\-cask option\. Print output in JSON format\. There are two versions: v1 and v2\. v1 is deprecated and is currently the default if no version is specified\. v2 prints outdated formulae and casks\.
. .
.TP .TP
\fB\-\-fetch\-HEAD\fR \fB\-\-fetch\-HEAD\fR