Merge pull request #18055 from Homebrew/sponsors-maintainers-man-completions

Update manpage and completions.

Author: ZhongRuoyu

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 ;;

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'

completions/internal_commands_list.txt

@@ -28,6 +28,7 @@ completions
 config
 contributions
 create
+debugger
 deps
 desc
 determine-test-runners

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 \

docs/Manpage.md

@@ -2142,6 +2142,21 @@ see: <https://rubydoc.brew.sh/Formula>
 
 : 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.

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