Why should brew upgrade: --cask and --display-times be mutually exclusive?

[toobuntu]

Output of brew config

N/A

Output of brew doctor

N/A

Description of issue

Installation times are useful to me. I observed seemingly quirky behavior: If I do not specify --cask when upgrading a cask with brew upgrade --display-times, I do get the installation times for all formulae and casks. But if I do specify --cask I get

Error: Invalid usage: Options --cask and --display-times are mutually exclusive.

Perhaps this conflict should be loosened? It affects (at least) upgrade and install.

• https://github.com/Homebrew/brew/blob/master/Library/Homebrew/cmd/upgrade.rb#L39-L83
• https://github.com/Homebrew/brew/blob/master/Library/Homebrew/cmd/install.rb#L43-L124

Relevant casks

Any

[Bo98]

Initially it was only supported with formulae but that changed with Homebrew/brew@eb16e10, but without updating the conflicts. So it looks like the conflict probably can be removed now if it all works correctly.

[toobuntu]

Thank you for your very helpful reply. I tried modifying the relevant files (from git grep -lF 'display-times'). Now it will print the installation times for reinstall but not install. Any thoughts on why?

(I haven't tested upgrade, but from memory that had worked before these changes.)

Here's the diff:

diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb
index 13b65b40c..74f59b172 100644
--- a/Library/Homebrew/cmd/install.rb
+++ b/Library/Homebrew/cmd/install.rb
@@ -32,6 +32,9 @@ module Homebrew
         switch "-d", "--debug",
                description: "If brewing fails, open an interactive debugging session with access to IRB " \
                             "or a shell inside the temporary build directory."
+        switch "--display-times",
+               env:         :display_install_times,
+               description: "Print install times for each package at the end of the run."
         switch "-f", "--force",
                description: "Install formulae without checking for previously installed keg-only or " \
                             "non-migrated versions. When installing casks, overwrite existing files " \
@@ -103,10 +106,6 @@ module Homebrew
             description: "Optimise bottles for the specified architecture rather than the oldest " \
                          "architecture supported by the version of macOS the bottles are built on.",
           }],
-          [:switch, "--display-times", {
-            env:         :display_install_times,
-            description: "Print install times for each package at the end of the run.",
-          }],
           [:switch, "-i", "--interactive", {
             description: "Download and patch <formula>, then open a shell. This allows the user to " \
                          "run `./configure --help` and otherwise determine how to turn the software " \
diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb
index fb1f1d0d9..20f87915f 100644
--- a/Library/Homebrew/cmd/reinstall.rb
+++ b/Library/Homebrew/cmd/reinstall.rb
@@ -31,6 +31,9 @@ module Homebrew
         switch "-d", "--debug",
                description: "If brewing fails, open an interactive debugging session with access to IRB " \
                             "or a shell inside the temporary build directory."
+        switch "--display-times",
+               env:         :display_install_times,
+               description: "Print install times for each package at the end of the run."
         switch "-f", "--force",
                description: "Install without checking for previously installed keg-only or " \
                             "non-migrated versions."
@@ -57,10 +60,6 @@ module Homebrew
             depends_on:  "--build-from-source",
             description: "Generate debug symbols on build. Source will be retained in a cache directory.",
           }],
-          [:switch, "--display-times", {
-            env:         :display_install_times,
-            description: "Print install times for each formula at the end of the run.",
-          }],
           [:switch, "-g", "--git", {
             description: "Create a Git repository, useful for creating patches to the software.",
           }],
diff --git a/Library/Homebrew/cmd/upgrade.rb b/Library/Homebrew/cmd/upgrade.rb
index 26a802d8f..71516f116 100644
--- a/Library/Homebrew/cmd/upgrade.rb
+++ b/Library/Homebrew/cmd/upgrade.rb
@@ -28,6 +28,9 @@ module Homebrew
         switch "-d", "--debug",
                description: "If brewing fails, open an interactive debugging session with access to IRB " \
                             "or a shell inside the temporary build directory."
+        switch "--display-times",
+               env:         :display_install_times,
+               description: "Print install times for each package at the end of the run."
         switch "-f", "--force",
                description: "Install formulae without checking for previously installed keg-only or " \
                             "non-migrated versions. When installing casks, overwrite existing files " \
@@ -69,10 +72,6 @@ module Homebrew
             depends_on:  "--build-from-source",
             description: "Generate debug symbols on build. Source will be retained in a cache directory.",
           }],
-          [:switch, "--display-times", {
-            env:         :display_install_times,
-            description: "Print install times for each package at the end of the run.",
-          }],
           [:switch, "--overwrite", {
             description: "Delete files that already exist in the prefix while linking.",
           }],
diff --git a/docs/Manpage.md b/docs/Manpage.md
index 07804adf0..ac2cb5afc 100644
--- a/docs/Manpage.md
+++ b/docs/Manpage.md
@@ -533,6 +533,10 @@ upgrade *`formula`* if it is already installed but outdated.
 : If brewing fails, open an interactive debugging session with access to IRB or
   a shell inside the temporary build directory.
 
+`--display-times`
+
+: Print install times for each package at the end of the run.
+
 `-f`, `--force`
 
 : Install formulae without checking for previously installed keg-only or
@@ -619,10 +623,6 @@ upgrade *`formula`* if it is already installed but outdated.
 : Optimise bottles for the specified architecture rather than the oldest
   architecture supported by the version of macOS the bottles are built on.
 
-`--display-times`
-
-: Print install times for each package at the end of the run.
-
 `-i`, `--interactive`
 
 : Download and patch *`formula`*, then open a shell. This allows the user to run
@@ -975,6 +975,10 @@ the reinstalled formulae or, every 30 days, for all formulae.
 : If brewing fails, open an interactive debugging session with access to IRB or
   a shell inside the temporary build directory.
 
+`--display-times`
+
+: Print install times for each package at the end of the run.
+
 `-f`, `--force`
 
 : Install without checking for previously installed keg-only or non-migrated
@@ -1011,10 +1015,6 @@ the reinstalled formulae or, every 30 days, for all formulae.
 
 : Generate debug symbols on build. Source will be retained in a cache directory.
 
-`--display-times`
-
-: Print install times for each formula at the end of the run.
-
 `-g`, `--git`
 
 : Create a Git repository, useful for creating patches to the software.
@@ -1281,6 +1281,10 @@ the upgraded formulae or, every 30 days, for all formulae.
 : If brewing fails, open an interactive debugging session with access to IRB or
   a shell inside the temporary build directory.
 
+`--display-times`
+
+: Print install times for each package at the end of the run.
+
 `-f`, `--force`
 
 : Install formulae without checking for previously installed keg-only or
@@ -1329,10 +1333,6 @@ the upgraded formulae or, every 30 days, for all formulae.
 
 : Generate debug symbols on build. Source will be retained in a cache directory.
 
-`--display-times`
-
-: Print install times for each package at the end of the run.
-
 `--overwrite`
 
 : Delete files that already exist in the prefix while linking.

# git grep --files-with-matches --fixed-strings 'display-times'
Library/Homebrew/cmd/install.rb
Library/Homebrew/cmd/reinstall.rb
Library/Homebrew/cmd/upgrade.rb
completions/bash/brew
completions/fish/brew.fish
completions/zsh/_brew
docs/Manpage.md

# git grep --files-with-matches --fixed-strings 'install_times'
Library/Homebrew/cmd/install.rb
Library/Homebrew/cmd/reinstall.rb
Library/Homebrew/cmd/upgrade.rb
Library/Homebrew/messages.rb
Library/Homebrew/sorbet/rbi/dsl/homebrew/env_config.rbi
Library/Homebrew/test/messages_spec.rb

So I tried to update the rbi, but brew typecheck --update led me to this bug sorbet/sorbet#6778 and I didn't want to install Rosetta 2 just for this:

# brew sh
Your shell has been configured to use Homebrew's build environment;
this should help you build stuff. Notably though, the system versions of
gem and pip will ignore our configuration and insist on using the
environment they were built under (mostly). Sadly, scons will also
ignore our configuration.
When done, type `exit`.
brew /opt/homebrew$ brew typecheck --update
bundler: failed to load command: tapioca (/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/bin/tapioca)
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/3.1.0/open3.rb:222:in `spawn': Bad CPU type in executable - /opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-static-0.5.11332-universal-darwin/libexec/sorbet (Errno::EBADARCH)
...
Error: Failure while executing; `bundle exec tapioca dsl` exited with 1.
brew /opt/homebrew$ file /opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-static-0.5.11332-universal-darwin/libexec/sorbet
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-static-0.5.11332-universal-darwin/libexec/sorbet: Mach-O 64-bit executable x86_64