Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update manpage and completions. #15439

Merged
merged 1 commit into from
May 16, 2023
Merged

Update manpage and completions. #15439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions completions/bash/brew
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1014,6 +1014,7 @@ _brew_generate_cask_api() {
-*)
__brewcomp "
--debug
--dry-run
--help
--quiet
--verbose
Expand All @@ -1030,6 +1031,7 @@ _brew_generate_formula_api() {
-*)
__brewcomp "
--debug
--dry-run
--help
--quiet
--verbose
Expand Down
2 changes: 2 additions & 0 deletions completions/fish/brew.fish
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,13 +727,15 @@ __fish_brew_complete_arg 'formula' -a '(__fish_brew_suggest_formulae_all)'

__fish_brew_complete_cmd 'generate-cask-api' 'Generates Cask API data files for formulae.brew.sh'
__fish_brew_complete_arg 'generate-cask-api' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'generate-cask-api' -l dry-run -d 'Generate API data without writing it to files'
__fish_brew_complete_arg 'generate-cask-api' -l help -d 'Show this message'
__fish_brew_complete_arg 'generate-cask-api' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'generate-cask-api' -l verbose -d 'Make some output more verbose'


__fish_brew_complete_cmd 'generate-formula-api' 'Generates Formula API data files for formulae.brew.sh'
__fish_brew_complete_arg 'generate-formula-api' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'generate-formula-api' -l dry-run -d 'Generate API data without writing it to files'
__fish_brew_complete_arg 'generate-formula-api' -l help -d 'Show this message'
__fish_brew_complete_arg 'generate-formula-api' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'generate-formula-api' -l verbose -d 'Make some output more verbose'
Expand Down
2 changes: 2 additions & 0 deletions completions/zsh/_brew
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -915,6 +915,7 @@ _brew_formula() {
_brew_generate_cask_api() {
_arguments \
'--debug[Display any debugging information]' \
'--dry-run[Generate API data without writing it to files]' \
'--help[Show this message]' \
'--quiet[Make some output more quiet]' \
'--verbose[Make some output more verbose]'
Expand All @@ -924,6 +925,7 @@ _brew_generate_cask_api() {
_brew_generate_formula_api() {
_arguments \
'--debug[Display any debugging information]' \
'--dry-run[Generate API data without writing it to files]' \
'--help[Show this message]' \
'--quiet[Make some output more quiet]' \
'--verbose[Make some output more verbose]'
Expand Down
10 changes: 8 additions & 2 deletions docs/Manpage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1243,18 +1243,24 @@ a formula from a tap that is not `homebrew/core` use its fully-qualified form of

Display the path where *`formula`* is located.

### `generate-cask-api`
### `generate-cask-api` [`--dry-run`]

Generates Cask API data files for formulae.brew.sh.

The generated files are written to the current directory.

### `generate-formula-api`
* `-n`, `--dry-run`:
Generate API data without writing it to files.

### `generate-formula-api` [`--dry-run`]

Generates Formula API data files for formulae.brew.sh.

The generated files are written to the current directory.

* `-n`, `--dry-run`:
Generate API data without writing it to files.

### `generate-man-completions`

Generate Homebrew's manpages and shell completions.
Expand Down
12 changes: 10 additions & 2 deletions manpages/brew.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1782,18 +1782,26 @@ Overwrite the destination formula if it already exists\.
.SS "\fBformula\fR \fIformula\fR [\.\.\.]"
Display the path where \fIformula\fR is located\.
.
.SS "\fBgenerate\-cask\-api\fR"
.SS "\fBgenerate\-cask\-api\fR [\fB\-\-dry\-run\fR]"
Generates Cask API data files for formulae\.brew\.sh\.
.
.P
The generated files are written to the current directory\.
.
.SS "\fBgenerate\-formula\-api\fR"
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Generate API data without writing it to files\.
.
.SS "\fBgenerate\-formula\-api\fR [\fB\-\-dry\-run\fR]"
Generates Formula API data files for formulae\.brew\.sh\.
.
.P
The generated files are written to the current directory\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Generate API data without writing it to files\.
.
.SS "\fBgenerate\-man\-completions\fR"
Generate Homebrew\'s manpages and shell completions\.
.
Expand Down