Revert back changes in doc and completions
This commit is contained in:
parent
2ae583c836
commit
beb4f02ae3
@ -1349,7 +1349,6 @@ _brew_livecheck() {
|
|||||||
--cask
|
--cask
|
||||||
--debug
|
--debug
|
||||||
--formula
|
--formula
|
||||||
--resources
|
|
||||||
--full-name
|
--full-name
|
||||||
--help
|
--help
|
||||||
--installed
|
--installed
|
||||||
|
|||||||
@ -958,12 +958,11 @@ __fish_brew_complete_arg 'list; and not __fish_seen_argument -l cask -l casks' -
|
|||||||
__fish_brew_complete_arg 'list; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_installed)'
|
__fish_brew_complete_arg 'list; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_installed)'
|
||||||
|
|
||||||
|
|
||||||
__fish_brew_complete_cmd 'livecheck' 'Check for newer versions of formulae, resources and/or casks from upstream'
|
__fish_brew_complete_cmd 'livecheck' 'Check for newer versions of formulae and/or casks from upstream'
|
||||||
__fish_brew_complete_arg 'livecheck' -l all -d 'Check all available formulae/casks'
|
__fish_brew_complete_arg 'livecheck' -l all -d 'Check all available formulae/casks'
|
||||||
__fish_brew_complete_arg 'livecheck' -l cask -d 'Only check casks'
|
__fish_brew_complete_arg 'livecheck' -l cask -d 'Only check casks'
|
||||||
__fish_brew_complete_arg 'livecheck' -l debug -d 'Display any debugging information'
|
__fish_brew_complete_arg 'livecheck' -l debug -d 'Display any debugging information'
|
||||||
__fish_brew_complete_arg 'livecheck' -l formula -d 'Only check formulae'
|
__fish_brew_complete_arg 'livecheck' -l formula -d 'Only check formulae'
|
||||||
__fish_brew_complete_arg 'livecheck' -l resources -d 'Also check resources for formulae'
|
|
||||||
__fish_brew_complete_arg 'livecheck' -l full-name -d 'Print formulae/casks with fully-qualified names'
|
__fish_brew_complete_arg 'livecheck' -l full-name -d 'Print formulae/casks with fully-qualified names'
|
||||||
__fish_brew_complete_arg 'livecheck' -l help -d 'Show this message'
|
__fish_brew_complete_arg 'livecheck' -l help -d 'Show this message'
|
||||||
__fish_brew_complete_arg 'livecheck' -l installed -d 'Check formulae/casks that are currently installed'
|
__fish_brew_complete_arg 'livecheck' -l installed -d 'Check formulae/casks that are currently installed'
|
||||||
|
|||||||
@ -175,7 +175,7 @@ __brew_internal_commands() {
|
|||||||
'link:Symlink all of formula'\''s installed files into Homebrew'\''s prefix'
|
'link:Symlink all of formula'\''s installed files into Homebrew'\''s prefix'
|
||||||
'linkage:Check the library links from the given formula kegs'
|
'linkage:Check the library links from the given formula kegs'
|
||||||
'list:List all installed formulae and casks'
|
'list:List all installed formulae and casks'
|
||||||
'livecheck:Check for newer versions of formulae, resources and/or casks from upstream'
|
'livecheck:Check for newer versions of formulae and/or casks from upstream'
|
||||||
'log:Show the `git log` for formula or cask, or show the log for the Homebrew repository if no formula or cask is provided'
|
'log:Show the `git log` for formula or cask, or show the log for the Homebrew repository if no formula or cask is provided'
|
||||||
'migrate:Migrate renamed packages to new names, where formula are old names of packages'
|
'migrate:Migrate renamed packages to new names, where formula are old names of packages'
|
||||||
'missing:Check the given formula kegs for missing dependencies'
|
'missing:Check the given formula kegs for missing dependencies'
|
||||||
@ -1180,7 +1180,6 @@ _brew_livecheck() {
|
|||||||
'--quiet[Suppress warnings, don'\''t print a progress bar for JSON output]' \
|
'--quiet[Suppress warnings, don'\''t print a progress bar for JSON output]' \
|
||||||
'(--all --installed)--tap[Check formulae/casks within the given tap, specified as user`/`repo]' \
|
'(--all --installed)--tap[Check formulae/casks within the given tap, specified as user`/`repo]' \
|
||||||
'--verbose[Make some output more verbose]' \
|
'--verbose[Make some output more verbose]' \
|
||||||
'--resources[Also check resources for formulae]' \
|
|
||||||
- formula \
|
- formula \
|
||||||
'(--cask)--formula[Only check formulae]' \
|
'(--cask)--formula[Only check formulae]' \
|
||||||
'*::formula:__brew_formulae' \
|
'*::formula:__brew_formulae' \
|
||||||
|
|||||||
@ -1,29 +1,27 @@
|
|||||||
# `brew livecheck`
|
# `brew livecheck`
|
||||||
|
|
||||||
The `brew livecheck` command finds the newest version of a formula, resource or cask's software by checking upstream. Livecheck has [strategies](https://rubydoc.brew.sh/Homebrew/Livecheck/Strategy.html) to identify versions from various sources, such as Git repositories, websites, etc.
|
The `brew livecheck` command finds the newest version of a formula or cask's software by checking upstream. Livecheck has [strategies](https://rubydoc.brew.sh/Homebrew/Livecheck/Strategy.html) to identify versions from various sources, such as Git repositories, websites, etc.
|
||||||
|
|
||||||
## Behavior
|
## Behavior
|
||||||
|
|
||||||
When livecheck isn't given instructions for how to check for upstream versions, it does the following by default:
|
When livecheck isn't given instructions for how to check for upstream versions, it does the following by default:
|
||||||
|
|
||||||
1. For __formulae__: Collect the `stable`, `head` and `homepage` URLs, in that order. For __casks__: Collect the `appcast`, `url` and `homepage` URLs, in that order. For __resource__: Collect the `url` (since resource's url is considered `stable` by default)
|
1. For formulae: Collect the `head`, `stable`, and `homepage` URLs, in that order. For casks: Collect the `url` and `homepage` URLs, in that order.
|
||||||
2. Determine if any strategies apply to the first URL. If not, try the next URL.
|
1. Determine if any strategies apply to the first URL. If not, try the next URL.
|
||||||
3. If a strategy can be applied, use it to check for new versions.
|
1. If a strategy can be applied, use it to check for new versions.
|
||||||
4. Return the newest version (or an error if versions could not be found at any available URLs).
|
1. Return the newest version (or an error if versions could not be found at any available URLs).
|
||||||
|
|
||||||
It's sometimes necessary to override this default behavior to create a working check. If a source doesn't provide the newest version, we need to check a different one. If livecheck doesn't correctly match version text, we need to provide an appropriate regex or `strategy` block.
|
It's sometimes necessary to override this default behavior to create a working check. If a source doesn't provide the newest version, we need to check a different one. If livecheck doesn't correctly match version text, we need to provide an appropriate regex or `strategy` block.
|
||||||
|
|
||||||
This can be accomplished by adding a `livecheck` block to the formula/resource/cask. For more information on the available methods, please refer to the [`Livecheck` class documentation](https://rubydoc.brew.sh/Livecheck.html).
|
This can be accomplished by adding a `livecheck` block to the formula/cask. For more information on the available methods, please refer to the [`Livecheck` class documentation](https://rubydoc.brew.sh/Livecheck.html).
|
||||||
|
|
||||||
## Creating a check
|
## Creating a check
|
||||||
|
|
||||||
1. **Use the debug output to understand the situation**. `brew livecheck --debug <formula>|<cask>` provides information about which URLs livecheck tries, any strategies that apply, matched versions, etc. `brew livecheck --debug --resources <formula>` will provides livecheck's debug information about the resources as well.
|
1. **Use the debug output to understand the situation**. `brew livecheck --debug <formula>|<cask>` provides information about which URLs livecheck tries, any strategies that apply, matched versions, etc.
|
||||||
|
|
||||||
> Note: `--resources` flag only works with Formulae.
|
1. **Research available sources to select a URL**. Try removing the file name from `stable`/`url`, to see if this is a directory listing page. If that doesn't work, try to find a page that links to the file (e.g. a download page). If it's not possible to find the newest version on the website, try checking other sources from the formula/cask. When necessary, search for other sources outside of the formula/cask.
|
||||||
|
|
||||||
2. **Research available sources to select a URL**. Try removing the file name from `stable`/`url`, to see if this is a directory listing page. If that doesn't work, try to find a page that links to the file (e.g. a download page). If it's not possible to find the newest version on the website, try checking other sources from the formula/cask. When necessary, search for other sources outside of the formula/cask.
|
1. **Create a regex, if necessary**. If the check works without a regex and wouldn't benefit from having one, it's usually fine to omit it. More information on creating regexes can be found in the [regex guidelines](#regex-guidelines) section.
|
||||||
|
|
||||||
3. **Create a regex, if necessary**. If the check works without a regex and wouldn't benefit from having one, it's usually fine to omit it. More information on creating regexes can be found in the [regex guidelines](#regex-guidelines) section.
|
|
||||||
|
|
||||||
### General guidelines
|
### General guidelines
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user