From 787b44fecf3f7989068c196b0af62e6754918ebd Mon Sep 17 00:00:00 2001 From: BrewTestBot <1589480+BrewTestBot@users.noreply.github.com> Date: Thu, 15 Aug 2024 14:29:45 +0000 Subject: [PATCH] Update manpage and completions. Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow. --- completions/bash/brew | 20 ++++++++++++++++++++ completions/fish/brew.fish | 10 ++++++++++ completions/internal_commands_list.txt | 1 + completions/zsh/_brew | 14 ++++++++++++++ docs/Manpage.md | 15 +++++++++++++++ manpages/brew.1 | 10 ++++++++++ 6 files changed, 70 insertions(+) diff --git a/completions/bash/brew b/completions/bash/brew index 9402f26144..5014637cb3 100644 --- a/completions/bash/brew +++ b/completions/bash/brew @@ -783,6 +783,25 @@ _brew_create() { esac } +_brew_debugger() { + local cur="${COMP_WORDS[COMP_CWORD]}" + case "${cur}" in + -*) + __brewcomp " + --debug + --help + --open + --quiet + --stop + --verbose + " + return + ;; + *) ;; + esac + __brew_complete_commands +} + _brew_deps() { local cur="${COMP_WORDS[COMP_CWORD]}" case "${cur}" in @@ -2881,6 +2900,7 @@ _brew() { config) _brew_config ;; contributions) _brew_contributions ;; create) _brew_create ;; + debugger) _brew_debugger ;; deps) _brew_deps ;; desc) _brew_desc ;; determine-test-runners) _brew_determine_test_runners ;; diff --git a/completions/fish/brew.fish b/completions/fish/brew.fish index 48ac7e41e7..c54c44cea9 100644 --- a/completions/fish/brew.fish +++ b/completions/fish/brew.fish @@ -585,6 +585,16 @@ __fish_brew_complete_arg 'create' -l tap -d 'Generate the new formula within the __fish_brew_complete_arg 'create' -l verbose -d 'Make some output more verbose' +__fish_brew_complete_cmd 'debugger' 'Run the specified Homebrew command in debug mode' +__fish_brew_complete_arg 'debugger' -l debug -d 'Display any debugging information' +__fish_brew_complete_arg 'debugger' -l help -d 'Show this message' +__fish_brew_complete_arg 'debugger' -l open -d 'Start remote debugging over a Unix socket' +__fish_brew_complete_arg 'debugger' -l quiet -d 'Make some output more quiet' +__fish_brew_complete_arg 'debugger' -l stop -d 'Stop at the beginning of the script' +__fish_brew_complete_arg 'debugger' -l verbose -d 'Make some output more verbose' +__fish_brew_complete_arg 'debugger' -a '(__fish_brew_suggest_commands)' + + __fish_brew_complete_cmd 'deps' 'Show dependencies for formula' __fish_brew_complete_arg 'deps' -l HEAD -d 'Show dependencies for HEAD version instead of stable version' __fish_brew_complete_arg 'deps' -l annotate -d 'Mark any build, test, implicit, optional, or recommended dependencies as such in the output' diff --git a/completions/internal_commands_list.txt b/completions/internal_commands_list.txt index 58ca1ea8c5..a9d6f8ef19 100644 --- a/completions/internal_commands_list.txt +++ b/completions/internal_commands_list.txt @@ -28,6 +28,7 @@ completions config contributions create +debugger deps desc determine-test-runners diff --git a/completions/zsh/_brew b/completions/zsh/_brew index 8869a50497..ef7a98ef22 100644 --- a/completions/zsh/_brew +++ b/completions/zsh/_brew @@ -157,6 +157,7 @@ __brew_internal_commands() { 'config:Show Homebrew and system configuration info useful for debugging' 'contributions:Summarise contributions to Homebrew repositories' 'create:Generate a formula or, with `--cask`, a cask for the downloadable file at URL and open it in the editor' + 'debugger:Run the specified Homebrew command in debug mode' 'deps:Show dependencies for formula' 'desc:Display formula'\''s name and one-line description' 'determine-test-runners:Determines the runners used to test formulae or their dependents' @@ -745,6 +746,19 @@ _brew_create() { '--verbose[Make some output more verbose]' } +# brew debugger +_brew_debugger() { + _arguments \ + '--debug[Display any debugging information]' \ + '--help[Show this message]' \ + '--open[Start remote debugging over a Unix socket]' \ + '--quiet[Make some output more quiet]' \ + '--stop[Stop at the beginning of the script]' \ + '--verbose[Make some output more verbose]' \ + - command \ + '*::command:__brew_commands' +} + # brew deps _brew_deps() { _arguments \ diff --git a/docs/Manpage.md b/docs/Manpage.md index 83bbaefa8e..ee610a483c 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -2142,6 +2142,21 @@ see: : Ignore errors for disallowed formula names and names that shadow aliases. +### `debugger` \[`--stop`\] \[`--open`\] *`command`* \[...\] + +Run the specified Homebrew command in debug mode. + +To pass flags to the command, use `--` to separate them from the `brew` flags. +For example: `brew debugger -- list --formula`. + +`-s`, `--stop` + +: Stop at the beginning of the script. + +`-O`, `--open` + +: Start remote debugging over a Unix socket. + ### `dispatch-build-bottle` \[*`options`*\] *`formula`* \[...\] Build bottles for these formulae with GitHub Actions. diff --git a/manpages/brew.1 b/manpages/brew.1 index eee49e1f93..9122a34752 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -1363,6 +1363,16 @@ Generate the new formula within the given tap, specified as \fIuser\fP\fB/\fP\fI .TP \fB\-f\fP, \fB\-\-force\fP Ignore errors for disallowed formula names and names that shadow aliases\. +.SS "\fBdebugger\fP \fR[\fB\-\-stop\fP] \fR[\fB\-\-open\fP] \fIcommand\fP \fR[\.\.\.]" +Run the specified Homebrew command in debug mode\. +.P +To pass flags to the command, use \fB\-\-\fP to separate them from the \fBbrew\fP flags\. For example: \fBbrew debugger \-\- list \-\-formula\fP\&\. +.TP +\fB\-s\fP, \fB\-\-stop\fP +Stop at the beginning of the script\. +.TP +\fB\-O\fP, \fB\-\-open\fP +Start remote debugging over a Unix socket\. .SS "\fBdispatch\-build\-bottle\fP \fR[\fIoptions\fP] \fIformula\fP \fR[\.\.\.]" Build bottles for these formulae with GitHub Actions\. .TP