Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
razvanazamfirei committed Mar 20, 2024
1 parent 2106559 commit c42ff0f
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 16 deletions.
4 changes: 2 additions & 2 deletions completions/bash/brew
Expand Up @@ -1336,6 +1336,7 @@ _brew_lc() {
--installed
--json
--newer-only
--no-extract-plist
--quiet
--resources
--tap
Expand Down Expand Up @@ -1451,6 +1452,7 @@ _brew_livecheck() {
--installed
--json
--newer-only
--no-extract-plist
--quiet
--resources
--tap
Expand Down Expand Up @@ -2105,9 +2107,7 @@ _brew_tap() {
--debug
--eval-all
--force
--force-auto-update
--help
--no-force-auto-update
--quiet
--repair
--verbose
Expand Down
4 changes: 2 additions & 2 deletions completions/fish/brew.fish
Expand Up @@ -947,6 +947,7 @@ __fish_brew_complete_arg 'lc' -l help -d 'Show this message'
__fish_brew_complete_arg 'lc' -l installed -d 'Check formulae and casks that are currently installed'
__fish_brew_complete_arg 'lc' -l json -d 'Output information in JSON format'
__fish_brew_complete_arg 'lc' -l newer-only -d 'Show the latest version only if it\'s newer than the formula/cask'
__fish_brew_complete_arg 'lc' -l no-extract-plist -d 'Exclude casks using the ExtractPlist livecheck strategy'
__fish_brew_complete_arg 'lc' -l quiet -d 'Suppress warnings, don\'t print a progress bar for JSON output'
__fish_brew_complete_arg 'lc' -l resources -d 'Also check resources for formulae'
__fish_brew_complete_arg 'lc' -l tap -d 'Check formulae and casks within the given tap, specified as user`/`repo'
Expand Down Expand Up @@ -1017,6 +1018,7 @@ __fish_brew_complete_arg 'livecheck' -l help -d 'Show this message'
__fish_brew_complete_arg 'livecheck' -l installed -d 'Check formulae and casks that are currently installed'
__fish_brew_complete_arg 'livecheck' -l json -d 'Output information in JSON format'
__fish_brew_complete_arg 'livecheck' -l newer-only -d 'Show the latest version only if it\'s newer than the formula/cask'
__fish_brew_complete_arg 'livecheck' -l no-extract-plist -d 'Exclude casks using the ExtractPlist livecheck strategy'
__fish_brew_complete_arg 'livecheck' -l quiet -d 'Suppress warnings, don\'t print a progress bar for JSON output'
__fish_brew_complete_arg 'livecheck' -l resources -d 'Also check resources for formulae'
__fish_brew_complete_arg 'livecheck' -l tap -d 'Check formulae and casks within the given tap, specified as user`/`repo'
Expand Down Expand Up @@ -1407,9 +1409,7 @@ __fish_brew_complete_arg 'tap' -l custom-remote -d 'Install or change a tap with
__fish_brew_complete_arg 'tap' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'tap' -l eval-all -d 'Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'tap' -l force -d 'Force install core taps even under API mode'
__fish_brew_complete_arg 'tap' -l force-auto-update -d 'Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons)'
__fish_brew_complete_arg 'tap' -l help -d 'Show this message'
__fish_brew_complete_arg 'tap' -l no-force-auto-update -d 'Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons)'
__fish_brew_complete_arg 'tap' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'tap' -l repair -d 'Migrate tapped formulae from symlink-based to directory-based structure'
__fish_brew_complete_arg 'tap' -l verbose -d 'Make some output more verbose'
Expand Down
8 changes: 4 additions & 4 deletions completions/zsh/_brew
Expand Up @@ -1173,12 +1173,13 @@ _brew_lc() {
'(--tap --eval-all)--installed[Check formulae and casks that are currently installed]' \
'(--debug)--json[Output information in JSON format]' \
'--newer-only[Show the latest version only if it'\''s newer than the formula/cask]' \
'(--formula)--no-extract-plist[Exclude casks using the ExtractPlist livecheck strategy]' \
'--quiet[Suppress warnings, don'\''t print a progress bar for JSON output]' \
'--resources[Also check resources for formulae]' \
'(--eval-all --installed)--tap[Check formulae and casks within the given tap, specified as user`/`repo]' \
'--verbose[Make some output more verbose]' \
- formula \
'(--cask)--formula[Only check formulae]' \
'(--cask --no-extract-plist)--formula[Only check formulae]' \
'*::formula:__brew_formulae' \
- cask \
'(--formula)--cask[Only check casks]' \
Expand Down Expand Up @@ -1259,12 +1260,13 @@ _brew_livecheck() {
'(--tap --eval-all)--installed[Check formulae and casks that are currently installed]' \
'(--debug)--json[Output information in JSON format]' \
'--newer-only[Show the latest version only if it'\''s newer than the formula/cask]' \
'(--formula)--no-extract-plist[Exclude casks using the ExtractPlist livecheck strategy]' \
'--quiet[Suppress warnings, don'\''t print a progress bar for JSON output]' \
'--resources[Also check resources for formulae]' \
'(--eval-all --installed)--tap[Check formulae and casks within the given tap, specified as user`/`repo]' \
'--verbose[Make some output more verbose]' \
- formula \
'(--cask)--formula[Only check formulae]' \
'(--cask --no-extract-plist)--formula[Only check formulae]' \
'*::formula:__brew_formulae' \
- cask \
'(--formula)--cask[Only check casks]' \
Expand Down Expand Up @@ -1742,9 +1744,7 @@ _brew_tap() {
'--debug[Display any debugging information]' \
'--eval-all[Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'--force[Force install core taps even under API mode]' \
'--force-auto-update[Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons)]' \
'--help[Show this message]' \
'--no-force-auto-update[Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons)]' \
'--quiet[Make some output more quiet]' \
'--repair[Migrate tapped formulae from symlink-based to directory-based structure]' \
'--verbose[Make some output more verbose]' \
Expand Down
9 changes: 4 additions & 5 deletions docs/Manpage.md
Expand Up @@ -1150,11 +1150,6 @@ simplifies but also limits. This two-argument command makes no assumptions, so
taps can be cloned from places other than GitHub and using protocols other than
HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.

`--[no-]force-auto-update`

: Auto-update tap even if it is not hosted on GitHub. By default, only taps
hosted on GitHub are auto-updated (for performance reasons).

`--custom-remote`

: Install or change a tap with a custom remote. Useful for mirrors.
Expand Down Expand Up @@ -2288,6 +2283,10 @@ from `HOMEBREW_LIVECHECK_WATCHLIST` or `~/.homebrew/livecheck_watchlist.txt`.

: Only check casks.

`--no-extract-plist`

: Exclude casks using the ExtractPlist livecheck strategy.

### `pr-automerge` \[*`options`*\]

Find pull requests that can be automatically merged using `brew pr-publish`.
Expand Down
6 changes: 3 additions & 3 deletions manpages/brew.1
Expand Up @@ -718,9 +718,6 @@ With \fIURL\fP unspecified, tap a formula repository from GitHub using HTTPS\. S
.P
With \fIURL\fP specified, tap a formula repository from anywhere, using any transport protocol that \fBgit\fP(1) handles\. The one\-argument form of \fBtap\fP simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\. SSH, git, HTTP, FTP(S), rsync\.
.TP
\fB\-\-[no\-]force\-auto\-update\fP
Auto\-update tap even if it is not hosted on GitHub\. By default, only taps hosted on GitHub are auto\-updated (for performance reasons)\.
.TP
\fB\-\-custom\-remote\fP
Install or change a tap with a custom remote\. Useful for mirrors\.
.TP
Expand Down Expand Up @@ -1453,6 +1450,9 @@ Only check formulae\.
.TP
\fB\-\-cask\fP
Only check casks\.
.TP
\fB\-\-no\-extract\-plist\fP
Exclude casks using the ExtractPlist livecheck strategy\.
.SS "\fBpr\-automerge\fP \fR[\fIoptions\fP]"
Find pull requests that can be automatically merged using \fBbrew pr\-publish\fP\&\.
.TP
Expand Down

0 comments on commit c42ff0f

Please sign in to comment.