Merge pull request #20364 from Homebrew/var-notation

output: express environment variables consistently

Author: EricFromCanada

Library/Homebrew/bundle/commands/exec.rb

@@ -180,7 +180,7 @@ def self.run(*args, global: false, file: nil, subcommand: "", services: false, c
               <<~EOS
                 Your shell has been configured to use a build environment from your `Brewfile`.
                 This should help you build stuff.
-                Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`).
+                Hide these hints with `HOMEBREW_NO_ENV_HINTS=1` (see `man brew`).
                 When done, type `exit`.
               EOS
             end

Library/Homebrew/cask/cask.rb

@@ -32,7 +32,7 @@ class Cask
 
     def self.all(eval_all: false)
       if !eval_all && !Homebrew::EnvConfig.eval_all?
-        raise ArgumentError, "Cask::Cask#all cannot be used without `--eval-all` or HOMEBREW_EVAL_ALL"
+        raise ArgumentError, "Cask::Cask#all cannot be used without `--eval-all` or `HOMEBREW_EVAL_ALL=1`"
       end
 
       # Load core casks from tokens so they load from the API when the core cask is not tapped.

Library/Homebrew/cask/installer.rb

@@ -248,7 +248,7 @@ def verify_has_sha
 
       raise CaskError, <<~EOS
         Cask '#{@cask}' does not have a sha256 checksum defined and was not installed.
-        This means you have the #{Formatter.identifier("--require-sha")} option set, perhaps in your HOMEBREW_CASK_OPTS.
+        This means you have the #{Formatter.identifier("--require-sha")} option set, perhaps in your `$HOMEBREW_CASK_OPTS`.
       EOS
     end
 
@@ -703,9 +703,9 @@ def forbidden_tap_check
           dep_full_name = cask_or_formula.full_name
           error_message = "The installation of #{@cask} has a dependency #{dep_full_name}\n" \
                           "from the #{dep_tap} tap but #{owner} "
-          error_message << "has not allowed this tap in `HOMEBREW_ALLOWED_TAPS`" unless dep_tap.allowed_by_env?
+          error_message << "has not allowed this tap in `$HOMEBREW_ALLOWED_TAPS`" unless dep_tap.allowed_by_env?
           error_message << " and\n" if !dep_tap.allowed_by_env? && dep_tap.forbidden_by_env?
-          error_message << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if dep_tap.forbidden_by_env?
+          error_message << "has forbidden this tap in `$HOMEBREW_FORBIDDEN_TAPS`" if dep_tap.forbidden_by_env?
           error_message << ".#{owner_contact}"
 
           raise CaskCannotBeInstalledError.new(@cask, error_message)
@@ -717,9 +717,9 @@ def forbidden_tap_check
 
       error_message = "The installation of #{@cask.full_name} has the tap #{cask_tap}\n" \
                       "but #{owner} "
-      error_message << "has not allowed this tap in `HOMEBREW_ALLOWED_TAPS`" unless cask_tap.allowed_by_env?
+      error_message << "has not allowed this tap in `$HOMEBREW_ALLOWED_TAPS`" unless cask_tap.allowed_by_env?
       error_message << " and\n" if !cask_tap.allowed_by_env? && cask_tap.forbidden_by_env?
-      error_message << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if cask_tap.forbidden_by_env?
+      error_message << "has forbidden this tap in `$HOMEBREW_FORBIDDEN_TAPS`" if cask_tap.forbidden_by_env?
       error_message << ".#{owner_contact}"
 
       raise CaskCannotBeInstalledError.new(@cask, error_message)

Library/Homebrew/cleanup.rb

@@ -258,8 +258,8 @@ def self.puts_no_install_cleanup_disable_message
       return if Homebrew::EnvConfig.no_env_hints?
       return if Homebrew::EnvConfig.no_install_cleanup?
 
-      puts "Disable this behaviour by setting HOMEBREW_NO_INSTALL_CLEANUP."
-      puts "Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`)."
+      puts "Disable this behaviour by setting `HOMEBREW_NO_INSTALL_CLEANUP=1`."
+      puts "Hide these hints with `HOMEBREW_NO_ENV_HINTS=1` (see `man brew`)."
     end
 
     def self.puts_no_install_cleanup_disable_message_if_not_already!
@@ -315,8 +315,8 @@ def clean!(quiet: false, periodic: false)
         end
 
         if ENV["HOMEBREW_AUTOREMOVE"].present?
-          opoo "HOMEBREW_AUTOREMOVE is now a no-op as it is the default behaviour. " \
-               "Set HOMEBREW_NO_AUTOREMOVE=1 to disable it."
+          opoo "`$HOMEBREW_AUTOREMOVE` is now a no-op as it is the default behaviour. " \
+               "Set `HOMEBREW_NO_AUTOREMOVE=1` to disable it."
         end
         Cleanup.autoremove(dry_run: dry_run?) unless Homebrew::EnvConfig.no_autoremove?
 

Library/Homebrew/cmd/deps.rb

@@ -130,7 +130,7 @@ def run
             opoo <<~EOS
               `brew deps` is not the actual runtime dependencies because #{not_using_runtime_dependencies_reason}!
               This means dependencies may differ from a formula's declared dependencies.
-              Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`).
+              Hide these hints with `HOMEBREW_NO_ENV_HINTS=1` (see `man brew`).
             EOS
           end
 

Library/Homebrew/cmd/desc.rb

@@ -49,7 +49,7 @@ def run
 
         if search_type.present?
           if !args.eval_all? && Homebrew::EnvConfig.no_install_from_api?
-            raise UsageError, "`brew desc --search` needs `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
+            raise UsageError, "`brew desc --search` needs `--eval-all` passed or `HOMEBREW_EVAL_ALL=1` set!"
           end
 
           query = args.named.join(" ")

Library/Homebrew/cmd/gist-logs.rb

@@ -63,7 +63,9 @@ def gistify_logs(formula)
           files["00.tap.out"] = { content: tap }
         end
 
-        odie "`brew gist-logs` requires HOMEBREW_GITHUB_API_TOKEN to be set!" if GitHub::API.credentials_type == :none
+        if GitHub::API.credentials_type == :none
+          odie "`brew gist-logs` requires `$HOMEBREW_GITHUB_API_TOKEN` to be set!"
+        end
 
         # Description formatted to work well as page title when viewing gist
         descr = if formula.core_formula?

Library/Homebrew/cmd/readall.rb

@@ -50,7 +50,7 @@ def run
 
           taps = if args.no_named?
             unless args.eval_all?
-              raise UsageError, "`brew readall` needs a tap or `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
+              raise UsageError, "`brew readall` needs a tap or `--eval-all` passed or `HOMEBREW_EVAL_ALL=1` set!"
             end
 
             Tap.installed

Library/Homebrew/cmd/search.rb

@@ -72,7 +72,7 @@ def run
 
         if args.desc?
           if !args.eval_all? && Homebrew::EnvConfig.no_install_from_api?
-            raise UsageError, "`brew search --desc` needs `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
+            raise UsageError, "`brew search --desc` needs `--eval-all` passed or `HOMEBREW_EVAL_ALL=1` set!"
           end
 
           Search.search_descriptions(string_or_regex, args)

Library/Homebrew/cmd/uninstall.rb

@@ -78,8 +78,8 @@ def run
         end
 
         if ENV["HOMEBREW_AUTOREMOVE"].present?
-          opoo "HOMEBREW_AUTOREMOVE is now a no-op as it is the default behaviour. " \
-               "Set HOMEBREW_NO_AUTOREMOVE=1 to disable it."
+          opoo "`$HOMEBREW_AUTOREMOVE` is now a no-op as it is the default behaviour. " \
+               "Set `HOMEBREW_NO_AUTOREMOVE=1` to disable it."
         end
         Cleanup.autoremove unless Homebrew::EnvConfig.no_autoremove?
       end