Class: Homebrew::Diagnostic::Checks Private

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
diagnostic.rb,
extend/os/mac/diagnostic.rb,
extend/os/linux/diagnostic.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Diagnostic checks.

HELPERS collapse

Instance Method Summary collapse

Constructor Details

#initialize(verbose: true) ⇒ Checks

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns a new instance of Checks.



53
54
55
# File 'diagnostic.rb', line 53

def initialize(verbose: true)
  @verbose = verbose
end

Instance Method Details

#__check_linked_brew(f) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



636
637
638
639
640
641
642
643
644
645
646
647
# File 'diagnostic.rb', line 636

def __check_linked_brew(f)
  f.installed_prefixes.each do |prefix|
    prefix.find do |src|
      next if src == prefix

      dst = HOMEBREW_PREFIX + src.relative_path_from(prefix)
      return true if dst.symlink? && src == dst.resolved_path
    end
  end

  false
end

#__check_stray_files(dir, pattern, allow_list, message) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



206
207
208
209
210
211
212
213
214
215
216
217
# File 'diagnostic.rb', line 206

def __check_stray_files(dir, pattern, allow_list, message)
  return unless File.directory?(dir)

  files = Dir.chdir(dir) do
    (Dir.glob(pattern) - Dir.glob(allow_list))
      .select { |f| File.file?(f) && !File.symlink?(f) }
      .map { |f| File.join(dir, f) }
  end
  return if files.empty?

  inject_file_list(files.sort, message)
end

#add_info(*args) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



81
82
83
# File 'diagnostic.rb', line 81

def add_info(*args)
  ohai(*args) if @verbose
end

#allObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



1045
1046
1047
# File 'diagnostic.rb', line 1045

def all
  methods.map(&:to_s).grep(/^check_/).sort
end

#broken_tap(tap) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'diagnostic.rb', line 150

def broken_tap(tap)
  return unless Utils::Git.available?

  repo = HOMEBREW_REPOSITORY.dup.extend(GitRepositoryExtension)
  return unless repo.git?

  message = <<~EOS
    #{tap.full_name} was not tapped properly! Run:
      rm -rf "#{tap.path}"
      brew tap #{tap.name}
  EOS

  return message if tap.remote.blank?

  tap_head = tap.git_head
  return message if tap_head.blank?
  return if tap_head != repo.git_head

  message
end

#build_error_checksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



110
111
112
# File 'diagnostic.rb', line 110

def build_error_checks
  supported_configuration_checks + build_from_source_checks
end

#build_from_source_checksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



85
86
87
88
89
90
91
# File 'extend/os/mac/diagnostic.rb', line 85

def build_from_source_checks
  %w[
    check_for_installed_developer_tools
    check_xcode_up_to_date
    check_clt_up_to_date
  ].freeze
end

#cask_checksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



1049
1050
1051
# File 'diagnostic.rb', line 1049

def cask_checks
  all.grep(/^check_cask_/)
end

#check_access_directoriesObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'diagnostic.rb', line 381

def check_access_directories
  not_writable_dirs =
    Keg::MUST_BE_WRITABLE_DIRECTORIES.select(&:exist?)
                                     .reject(&:writable_real?)
  return if not_writable_dirs.empty?

  <<~EOS
    The following directories are not writable by your user:
    #{not_writable_dirs.join("\n")}

    You should change the ownership of these directories to your user.
      sudo chown -R $(whoami) #{not_writable_dirs.join(" ")}

    And make sure that your user has write permission.
      chmod u+w #{not_writable_dirs.join(" ")}
  EOS
end

#check_brew_git_originObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



587
588
589
590
# File 'diagnostic.rb', line 587

def check_brew_git_origin
  repo = HOMEBREW_REPOSITORY.dup.extend(GitRepositoryExtension)
  examine_git_origin(repo, Homebrew::EnvConfig.brew_git_remote)
end

#check_broken_sdksObject

The CLT 10.x -> 11.x upgrade process on 10.14 contained a bug which broke the SDKs. Notably, MacOSX10.14.sdk would indirectly symlink to MacOSX10.15.sdk. This diagnostic was introduced to check for this and recommend a full reinstall.



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
# File 'extend/os/mac/diagnostic.rb', line 468

def check_broken_sdks
  locator = MacOS.sdk_locator

  return if locator.all_sdks.all? do |sdk|
    path_version = sdk.path.basename.to_s[MacOS::SDK::VERSIONED_SDK_REGEX, 1]
    next true if path_version.blank?

    sdk.version == MacOS::Version.new(path_version).strip_patch
  end

  if locator.source == :clt
    source = "Command Line Tools (CLT)"
    path_to_remove = MacOS::CLT::PKG_PATH
    installation_instructions = MacOS::CLT.installation_instructions
  else
    source = "Xcode"
    path_to_remove = MacOS::Xcode.bundle_path
    installation_instructions = MacOS::Xcode.installation_instructions
  end

  <<~EOS
    The contents of the SDKs in your #{source} installation do not match the SDK folder names.
    A clean reinstall of #{source} should fix this.

    Remove the broken installation before reinstalling:
      sudo rm -rf #{path_to_remove}

    #{installation_instructions}
  EOS
end

#check_cask_environment_variablesObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# File 'diagnostic.rb', line 977

def check_cask_environment_variables
  environment_variables = %w[
    RUBYLIB
    RUBYOPT
    RUBYPATH
    RBENV_VERSION
    CHRUBY_VERSION
    GEM_HOME
    GEM_PATH
    BUNDLE_PATH
    PATH
    SHELL
    HOMEBREW_CASK_OPTS
  ]

  locale_variables = ENV.keys.grep(/^(?:LC_\S+|LANG|LANGUAGE)\Z/).sort

  add_info "Cask Environment Variables:", ((locale_variables + environment_variables).sort.each do |var|
    next unless ENV.key?(var)

    var = %Q(#{var}="#{ENV[var]}")
    user_tilde(var)
  end)
end

#check_cask_install_locationObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



918
919
920
921
922
923
924
925
# File 'diagnostic.rb', line 918

def check_cask_install_location
  locations = Dir.glob(HOMEBREW_CELLAR.join("brew-cask", "*")).reverse
  return if locations.empty?

  locations.map do |l|
    "Legacy install at #{l}. Run `brew uninstall --force brew-cask`."
  end.join "\n"
end

#check_cask_load_pathObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



969
970
971
972
973
974
975
# File 'diagnostic.rb', line 969

def check_cask_load_path
  paths = $LOAD_PATH.map(&method(:user_tilde))

  add_info "$LOAD_PATHS", paths.presence || none_string

  "$LOAD_PATH is empty" if paths.blank?
end

#check_cask_quarantine_supportObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
# File 'diagnostic.rb', line 1030

def check_cask_quarantine_support
  case Cask::Quarantine.check_quarantine_support
  when :quarantine_available
    nil
  when :xattr_broken
    "There's no working version of `xattr` on this system."
  when :no_swift
    "Swift is not available on this system."
  when :no_quarantine
    "This feature requires the macOS 10.10 SDK or higher."
  else
    "Unknown support status"
  end
end

#check_cask_software_versionsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
# File 'diagnostic.rb', line 896

def check_cask_software_versions
  add_info "Homebrew Version", HOMEBREW_VERSION
  add_info "macOS", MacOS.full_version
  add_info "SIP", begin
    csrutil = "/usr/bin/csrutil"
    if File.executable?(csrutil)
      Open3.capture2(csrutil, "status")
           .first
           .gsub("This is an unsupported configuration, likely to break in " \
                 "the future and leave your machine in an unknown state.", "")
           .gsub("System Integrity Protection status: ", "")
           .delete("\t\.")
           .capitalize
           .strip
    else
      "N/A"
    end
  end

  nil
end

#check_cask_staging_locationObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
# File 'diagnostic.rb', line 927

def check_cask_staging_location
  # Skip this check when running CI since the staging path is not writable for security reasons
  return if ENV["GITHUB_ACTIONS"]

  path = Cask::Caskroom.path

  add_info "Homebrew Cask Staging Location", user_tilde(path.to_s)

  return if !path.exist? || path.writable?

  <<~EOS
    The staging path #{user_tilde(path.to_s)} is not writable by the current user.
    To fix, run:
      sudo chown -R $(whoami):staff #{user_tilde(path.to_s)}
  EOS
end

#check_cask_tapsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
# File 'diagnostic.rb', line 944

def check_cask_taps
  default_cask_tap = Tap.default_cask_tap
  alt_taps = Tap.select { |t| t.cask_dir.exist? && t != default_cask_tap }

  error_tap_paths = []

  add_info "Homebrew Cask Taps:", ([default_cask_tap, *alt_taps].map do |tap|
    if tap.path.blank?
      none_string
    else
      cask_count = begin
        tap.cask_files.count
      rescue
        error_tap_paths << tap.path
        0
      end

      "#{tap.path} (#{cask_count} #{"cask".pluralize(cask_count)})"
    end
  end)

  taps = "tap".pluralize error_tap_paths.count
  "Unable to read from cask #{taps}: #{error_tap_paths.to_sentence}" if error_tap_paths.present?
end

#check_cask_xattrObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
# File 'diagnostic.rb', line 1002

def check_cask_xattr
  result = system_command "/usr/bin/xattr", args: ["-h"]

  return if result.status.success?

  if result.stderr.include? "ImportError: No module named pkg_resources"
    result = Utils.popen_read "/usr/bin/python", "--version", err: :out

    if result.include? "Python 2.7"
      <<~EOS
        Your Python installation has a broken version of setuptools.
        To fix, reinstall macOS or run:
          sudo /usr/bin/python -m pip install -I setuptools
      EOS
    else
      <<~EOS
        The system Python version is wrong.
        To fix, run:
          defaults write com.apple.versioner.python Version 2.7
      EOS
    end
  elsif result.stderr.include? "pkg_resources.DistributionNotFound"
    "Your Python installation is unable to find `xattr`."
  else
    "unknown xattr error: #{result.stderr.split("\n").last}"
  end
end

#check_casktap_integrityObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



597
598
599
600
601
602
# File 'diagnostic.rb', line 597

def check_casktap_integrity
  default_cask_tap = Tap.default_cask_tap
  return unless default_cask_tap.installed?

  broken_tap(default_cask_tap) || examine_git_origin(default_cask_tap.path, default_cask_tap.remote)
end

#check_clt_minimum_versionObject



185
186
187
188
189
190
191
192
# File 'extend/os/mac/diagnostic.rb', line 185

def check_clt_minimum_version
  return unless MacOS::CLT.below_minimum_version?

  <<~EOS
    Your Command Line Tools are too outdated.
    #{MacOS::CLT.update_instructions}
  EOS
end

#check_clt_up_to_dateObject



157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'extend/os/mac/diagnostic.rb', line 157

def check_clt_up_to_date
  return unless MacOS::CLT.outdated?

  # CI images are going to end up outdated so don't complain when
  # `brew test-bot` runs `brew doctor` in the CI for the Homebrew/brew
  # repository. This only needs to support whatever CI providers
  # Homebrew/brew is currently using.
  return if ENV["GITHUB_ACTIONS"]

  <<~EOS
    A newer Command Line Tools release is available.
    #{MacOS::CLT.update_instructions}
  EOS
end

#check_coretap_integrityObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



592
593
594
595
# File 'diagnostic.rb', line 592

def check_coretap_integrity
  coretap = CoreTap.instance
  broken_tap(coretap) || examine_git_origin(coretap.path, Homebrew::EnvConfig.core_git_remote)
end

#check_deleted_formulaObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
# File 'diagnostic.rb', line 879

def check_deleted_formula
  keg_names = Keg.all.map(&:name).uniq

  deleted_formulae = keg_names.map do |keg_name|
    keg_name if Formulary.tap_paths(keg_name).blank?
  end.compact

  return if deleted_formulae.blank?

  <<~EOS
    Some installed kegs have no formulae!
    This means they were either deleted or installed with `brew diy`.
    You should find replacements for the following formulae:
      #{deleted_formulae.join("\n  ")}
  EOS
end

#check_deprecated_caskroom_tapsObject



426
427
428
429
430
431
432
433
434
435
436
# File 'extend/os/mac/diagnostic.rb', line 426

def check_deprecated_caskroom_taps
  tapped_caskroom_taps = Tap.select { |t| t.user == "caskroom" || t.name == "phinze/cask" }
                            .map(&:name)
  return if tapped_caskroom_taps.empty?

  <<~EOS
    You have the following deprecated, cask taps tapped:
      #{tapped_caskroom_taps.join("\n  ")}
    Untap them with `brew untap`.
  EOS
end

#check_deprecated_disabledObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



695
696
697
698
699
700
701
702
703
704
705
706
707
# File 'diagnostic.rb', line 695

def check_deprecated_disabled
  return unless HOMEBREW_CELLAR.exist?

  deprecated_or_disabled = Formula.installed.select(&:deprecated?)
  deprecated_or_disabled += Formula.installed.select(&:disabled?)
  return if deprecated_or_disabled.empty?

  <<~EOS
    Some installed formulae are deprecated or disabled.
    You should find replacements for the following formulae:
      #{deprecated_or_disabled.sort_by(&:full_name).uniq * "\n  "}
  EOS
end

#check_deprecated_official_tapsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



624
625
626
627
628
629
630
631
632
633
634
# File 'diagnostic.rb', line 624

def check_deprecated_official_taps
  tapped_deprecated_taps =
    Tap.select(&:official?).map(&:repo) & DEPRECATED_OFFICIAL_TAPS
  return if tapped_deprecated_taps.empty?

  <<~EOS
    You have the following deprecated, official taps tapped:
      Homebrew/homebrew-#{tapped_deprecated_taps.join("\n  Homebrew/homebrew-")}
    Untap them with `brew untap`.
  EOS
end

#check_exist_directoriesObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'diagnostic.rb', line 365

def check_exist_directories
  return if HOMEBREW_PREFIX.writable_real?

  not_exist_dirs = Keg::MUST_EXIST_DIRECTORIES.reject(&:exist?)
  return if not_exist_dirs.empty?

  <<~EOS
    The following directories do not exist:
    #{not_exist_dirs.join("\n")}

    You should create these directories and change their ownership to your user.
      sudo mkdir -p #{not_exist_dirs.join(" ")}
      sudo chown -R $(whoami) #{not_exist_dirs.join(" ")}
  EOS
end

#check_filesystem_case_sensitiveObject



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'extend/os/mac/diagnostic.rb', line 282

def check_filesystem_case_sensitive
  dirs_to_check = [
    HOMEBREW_PREFIX,
    HOMEBREW_REPOSITORY,
    HOMEBREW_CELLAR,
    HOMEBREW_TEMP,
  ]
  case_sensitive_dirs = dirs_to_check.select do |dir|
    # We select the dir as being case-sensitive if either the UPCASED or the
    # downcased variant is missing.
    # Of course, on a case-insensitive fs, both exist because the os reports so.
    # In the rare situation when the user has indeed a downcased and an upcased
    # dir (e.g. /TMP and /tmp) this check falsely thinks it is case-insensitive
    # but we don't care because: 1. there is more than one dir checked, 2. the
    # check is not vital and 3. we would have to touch files otherwise.
    upcased = Pathname.new(dir.to_s.upcase)
    downcased = Pathname.new(dir.to_s.downcase)
    dir.exist? && !(upcased.exist? && downcased.exist?)
  end
  return if case_sensitive_dirs.empty?

  volumes = Volumes.new
  case_sensitive_vols = case_sensitive_dirs.map do |case_sensitive_dir|
    volumes.get_mounts(case_sensitive_dir)
  end
  case_sensitive_vols.uniq!

  <<~EOS
    The filesystem on #{case_sensitive_vols.join(",")} appears to be case-sensitive.
    The default macOS filesystem is case-insensitive. Please report any apparent problems.
  EOS
end

#check_for_anacondaObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Anaconda installs multiple system & brew dupes, including OpenSSL, Python, sqlite, libpng, Qt, etc. Regularly breaks compile on Vim, MacVim and others. Is flagged as part of the *-config script checks below, but people seem to ignore those as warnings rather than extremely likely breakage.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'diagnostic.rb', line 184

def check_for_anaconda
  return unless which("anaconda")
  return unless which("python")

  anaconda_directory = which("anaconda").realpath.dirname
  python_binary = Utils.popen_read(which("python"), "-c", "import sys; sys.stdout.write(sys.executable)")
  python_directory = Pathname.new(python_binary).realpath.dirname

  # Only warn if Python lives with Anaconda, since is most problematic case.
  return unless python_directory == anaconda_directory

  <<~EOS
    Anaconda is known to frequently break Homebrew builds, including Vim and
    MacVim, due to bundling many duplicates of system and Homebrew-provided
    tools.

    If you encounter a build failure please temporarily remove Anaconda
    from your $PATH and attempt the build again prior to reporting the
    failure to us. Thanks!
  EOS
end

#check_for_bitdefenderObject



380
381
382
383
384
385
386
387
388
389
390
391
# File 'extend/os/mac/diagnostic.rb', line 380

def check_for_bitdefender
  if !Pathname("/Library/Bitdefender/AVP/EndpointSecurityforMac.app").exist? &&
     !Pathname("/Library/Bitdefender/AVP/BDLDaemon").exist?
    return
  end

  <<~EOS
    You have installed Bitdefender. The "Traffic Scan" option interferes with
    Homebrew's ability to download packages. See:
      #{Formatter.url("https://github.com/Homebrew/brew/issues/5558")}
  EOS
end

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'diagnostic.rb', line 336

def check_for_broken_symlinks
  broken_symlinks = []

  Keg::MUST_EXIST_SUBDIRECTORIES.each do |d|
    next unless d.directory?

    d.find do |path|
      broken_symlinks << path if path.symlink? && !path.resolved_path_exists?
    end
  end
  return if broken_symlinks.empty?

  inject_file_list broken_symlinks, <<~EOS
    Broken symlinks were found. Remove them with `brew cleanup`:
  EOS
end

#check_for_config_scriptsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
# File 'diagnostic.rb', line 476

def check_for_config_scripts
  return unless HOMEBREW_CELLAR.exist?

  real_cellar = HOMEBREW_CELLAR.realpath

  scripts = []

  allowlist = %W[
    /bin /sbin
    /usr/bin /usr/sbin
    /usr/X11/bin /usr/X11R6/bin /opt/X11/bin
    #{HOMEBREW_PREFIX}/bin #{HOMEBREW_PREFIX}/sbin
    /Applications/Server.app/Contents/ServerRoot/usr/bin
    /Applications/Server.app/Contents/ServerRoot/usr/sbin
  ]
  if OS.mac? && Hardware::CPU.physical_cpu_arm64?
    allowlist += %W[
      #{HOMEBREW_MACOS_ARM_DEFAULT_PREFIX}/bin
      #{HOMEBREW_MACOS_ARM_DEFAULT_PREFIX}/sbin
      #{HOMEBREW_DEFAULT_PREFIX}/bin
      #{HOMEBREW_DEFAULT_PREFIX}/sbin
    ]
  end
  allowlist.map!(&:downcase)

  paths.each do |p|
    next if allowlist.include?(p.downcase) || !File.directory?(p)

    realpath = Pathname.new(p).realpath.to_s
    next if realpath.start_with?(real_cellar.to_s, HOMEBREW_CELLAR.to_s)

    scripts += Dir.chdir(p) { Dir["*-config"] }.map { |c| File.join(p, c) }
  end

  return if scripts.empty?

  inject_file_list scripts, <<~EOS
    "config" scripts exist outside your system or Homebrew directories.
    `./configure` scripts often look for *-config scripts to determine if
    software packages are installed, and which additional flags to use when
    compiling and linking.

    Having additional scripts in your path can confuse software installed via
    Homebrew if the config script overrides a system or Homebrew-provided
    script of the same name. We found the following "config" scripts:
  EOS
end

#check_for_external_cmd_name_conflictObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'diagnostic.rb', line 815

def check_for_external_cmd_name_conflict
  cmds = Tap.cmd_directories.flat_map { |p| Dir["#{p}/brew-*"] }.uniq
  cmds = cmds.select { |cmd| File.file?(cmd) && File.executable?(cmd) }
  cmd_map = {}
  cmds.each do |cmd|
    cmd_name = File.basename(cmd, ".rb")
    cmd_map[cmd_name] ||= []
    cmd_map[cmd_name] << cmd
  end
  cmd_map.reject! { |_cmd_name, cmd_paths| cmd_paths.size == 1 }
  return if cmd_map.empty?

  if ENV["CI"] && cmd_map.keys.length == 1 &&
     cmd_map.keys.first == "brew-test-bot"
    return
  end

  message = "You have external commands with conflicting names.\n"
  cmd_map.each do |cmd_name, cmd_paths|
    message += inject_file_list cmd_paths, <<~EOS
      Found command `#{cmd_name}` in the following places:
    EOS
  end

  message
end

#check_for_gettextObject



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'extend/os/mac/diagnostic.rb', line 315

def check_for_gettext
  find_relative_paths("lib/libgettextlib.dylib",
                      "lib/libintl.dylib",
                      "include/libintl.h")
  return if @found.empty?

  # Our gettext formula will be caught by check_linked_keg_only_brews
  gettext = begin
    Formulary.factory("gettext")
  rescue
    nil
  end

  if gettext&.linked_keg&.directory?
    allowlist = ["#{HOMEBREW_CELLAR}/gettext"]
    if Hardware::CPU.physical_cpu_arm64?
      allowlist += %W[
        #{HOMEBREW_MACOS_ARM_DEFAULT_PREFIX}/Cellar/gettext
        #{HOMEBREW_DEFAULT_PREFIX}/Cellar/gettext
      ]
    end

    return if @found.all? do |path|
      realpath = Pathname.new(path).realpath.to_s
      allowlist.any? { |rack| realpath.start_with?(rack) }
    end
  end

  inject_file_list @found, <<~EOS
    gettext files detected at a system prefix.
    These files can cause compilation and link failures, especially if they
    are compiled with improper architectures. Consider removing these files:
  EOS
end

#check_for_gitObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



558
559
560
561
562
563
564
565
566
567
# File 'diagnostic.rb', line 558

def check_for_git
  return if Utils::Git.available?

  <<~EOS
    Git could not be found in your PATH.
    Homebrew uses Git for several internal functions, and some formulae use Git
    checkouts instead of stable tarballs. You may want to install Git:
      brew install git
  EOS
end

#check_for_iconvObject



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'extend/os/mac/diagnostic.rb', line 350

def check_for_iconv
  find_relative_paths("lib/libiconv.dylib", "include/iconv.h")
  return if @found.empty?

  libiconv = begin
    Formulary.factory("libiconv")
  rescue
    nil
  end
  if libiconv&.linked_keg&.directory?
    unless libiconv.keg_only?
      <<~EOS
        A libiconv formula is installed and linked.
        This will break stuff. For serious. Unlink it.
      EOS
    end
  else
    inject_file_list @found, <<~EOS
      libiconv files detected at a system prefix other than /usr.
      Homebrew doesn't provide a libiconv formula, and expects to link against
      the system version in /usr. libiconv in other prefixes can cause
      compile or link failure, especially if compiled with improper
      architectures. macOS itself never installs anything to /usr/local so
      it was either installed by a user or some other third party software.

      tl;dr: delete these files:
    EOS
  end
end

#check_for_installed_developer_toolsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



171
172
173
174
175
176
177
178
# File 'diagnostic.rb', line 171

def check_for_installed_developer_tools
  return if DevelopmentTools.installed?

  <<~EOS
    No developer tools installed.
    #{DevelopmentTools.installation_instructions}
  EOS
end

#check_for_multiple_volumesObject



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'extend/os/mac/diagnostic.rb', line 393

def check_for_multiple_volumes
  return unless HOMEBREW_CELLAR.exist?

  volumes = Volumes.new

  # Find the volumes for the TMP folder & HOMEBREW_CELLAR
  real_cellar = HOMEBREW_CELLAR.realpath
  where_cellar = volumes.which real_cellar

  begin
    tmp = Pathname.new(Dir.mktmpdir("doctor", HOMEBREW_TEMP))
    begin
      real_tmp = tmp.realpath.parent
      where_tmp = volumes.which real_tmp
    ensure
      Dir.delete tmp
    end
  rescue
    return
  end

  return if where_cellar == where_tmp

  <<~EOS
    Your Cellar and TEMP directories are on different volumes.
    macOS won't move relative symlinks across volumes unless the target file already
    exists. Brews known to be affected by this are Git and Narwhal.

    You should set the "HOMEBREW_TEMP" environment variable to a suitable
    directory on the same volume as your Cellar.
  EOS
end

#check_for_non_prefixed_coreutilsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



750
751
752
753
754
755
756
757
758
759
760
761
762
# File 'diagnostic.rb', line 750

def check_for_non_prefixed_coreutils
  coreutils = Formula["coreutils"]
  return unless coreutils.any_version_installed?

  gnubin = %W[#{coreutils.opt_libexec}/gnubin #{coreutils.libexec}/gnubin]
  return if (paths & gnubin).empty?

  <<~EOS
    Putting non-prefixed coreutils in your path can cause GMP builds to fail.
  EOS
rescue FormulaUnavailableError
  nil
end

#check_for_non_prefixed_findutilsObject



93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'extend/os/mac/diagnostic.rb', line 93

def check_for_non_prefixed_findutils
  findutils = Formula["findutils"]
  return unless findutils.any_version_installed?

  gnubin = %W[#{findutils.opt_libexec}/gnubin #{findutils.libexec}/gnubin]
  default_names = Tab.for_name("findutils").with? "default-names"
  return if !default_names && (paths & gnubin).empty?

  <<~EOS
    Putting non-prefixed findutils in your path can cause python builds to fail.
  EOS
rescue FormulaUnavailableError
  nil
end

#check_for_other_frameworksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'diagnostic.rb', line 649

def check_for_other_frameworks
  # Other frameworks that are known to cause problems when present
  frameworks_to_check = %w[
    expat.framework
    libexpat.framework
    libcurl.framework
  ]
  frameworks_found = frameworks_to_check
                     .map { |framework| "/Library/Frameworks/#{framework}" }
                     .select { |framework| File.exist? framework }
  return if frameworks_found.empty?

  inject_file_list frameworks_found, <<~EOS
    Some frameworks can be picked up by CMake's build system and will likely
    cause the build to fail. To compile CMake, you may wish to move these
    out of the way:
  EOS
end

#check_for_pydistutils_cfg_in_homeObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



764
765
766
767
768
769
770
771
772
773
# File 'diagnostic.rb', line 764

def check_for_pydistutils_cfg_in_home
  return unless File.exist? "#{ENV["HOME"]}/.pydistutils.cfg"

  <<~EOS
    A '.pydistutils.cfg' file was found in $HOME, which may cause Python
    builds to fail. See:
      #{Formatter.url("https://bugs.python.org/issue6138")}
      #{Formatter.url("https://bugs.python.org/issue4655")}
  EOS
end

#check_for_stray_dylibsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'diagnostic.rb', line 219

def check_for_stray_dylibs
  # Dylibs which are generally OK should be added to this list,
  # with a short description of the software they come with.
  allow_list = [
    "libfuse.2.dylib", # MacFuse
    "libfuse_ino64.2.dylib", # MacFuse
    "libmacfuse_i32.2.dylib", # OSXFuse MacFuse compatibility layer
    "libmacfuse_i64.2.dylib", # OSXFuse MacFuse compatibility layer
    "libosxfuse_i32.2.dylib", # OSXFuse
    "libosxfuse_i64.2.dylib", # OSXFuse
    "libosxfuse.2.dylib", # OSXFuse
    "libTrAPI.dylib", # TrAPI/Endpoint Security VPN
    "libntfs-3g.*.dylib", # NTFS-3G
    "libntfs.*.dylib", # NTFS-3G
    "libublio.*.dylib", # NTFS-3G
    "libUFSDNTFS.dylib", # Paragon NTFS
    "libUFSDExtFS.dylib", # Paragon ExtFS
    "libecomlodr.dylib", # Symantec Endpoint Protection
    "libsymsea*.dylib", # Symantec Endpoint Protection
    "sentinel.dylib", # SentinelOne
    "sentinel-*.dylib", # SentinelOne
  ]

  __check_stray_files "/usr/local/lib", "*.dylib", allow_list, <<~EOS
    Unbrewed dylibs were found in /usr/local/lib.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae, and may need to be deleted.

    Unexpected dylibs:
  EOS
end

#check_for_stray_headersObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'diagnostic.rb', line 317

def check_for_stray_headers
  allow_list = [
    "fuse.h", # MacFuse
    "fuse/**/*.h", # MacFuse
    "macfuse/**/*.h", # OSXFuse MacFuse compatibility layer
    "osxfuse/**/*.h", # OSXFuse
    "ntfs/**/*.h", # NTFS-3G
    "ntfs-3g/**/*.h", # NTFS-3G
  ]

  __check_stray_files "/usr/local/include", "**/*.h", allow_list, <<~EOS
    Unbrewed header files were found in /usr/local/include.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae, and may need to be deleted.

    Unexpected header files:
  EOS
end

#check_for_stray_lasObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'diagnostic.rb', line 296

def check_for_stray_las
  allow_list = [
    "libfuse.la", # MacFuse
    "libfuse_ino64.la", # MacFuse
    "libosxfuse_i32.la", # OSXFuse
    "libosxfuse_i64.la", # OSXFuse
    "libosxfuse.la", # OSXFuse
    "libntfs-3g.la", # NTFS-3G
    "libntfs.la", # NTFS-3G
    "libublio.la", # NTFS-3G
  ]

  __check_stray_files "/usr/local/lib", "*.la", allow_list, <<~EOS
    Unbrewed '.la' files were found in /usr/local/lib.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae, and may need to be deleted.

    Unexpected '.la' files:
  EOS
end

#check_for_stray_pcsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'diagnostic.rb', line 276

def check_for_stray_pcs
  # Package-config files which are generally OK should be added to this list,
  # with a short description of the software they come with.
  allow_list = [
    "fuse.pc", # OSXFuse/MacFuse
    "macfuse.pc", # OSXFuse MacFuse compatibility layer
    "osxfuse.pc", # OSXFuse
    "libntfs-3g.pc", # NTFS-3G
    "libublio.pc", # NTFS-3G
  ]

  __check_stray_files "/usr/local/lib/pkgconfig", "*.pc", allow_list, <<~EOS
    Unbrewed '.pc' files were found in /usr/local/lib/pkgconfig.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae, and may need to be deleted.

    Unexpected '.pc' files:
  EOS
end

#check_for_stray_static_libsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'diagnostic.rb', line 251

def check_for_stray_static_libs
  # Static libs which are generally OK should be added to this list,
  # with a short description of the software they come with.
  allow_list = [
    "libntfs-3g.a", # NTFS-3G
    "libntfs.a", # NTFS-3G
    "libublio.a", # NTFS-3G
    "libappfirewall.a", # Symantec Endpoint Protection
    "libautoblock.a", # Symantec Endpoint Protection
    "libautosetup.a", # Symantec Endpoint Protection
    "libconnectionsclient.a", # Symantec Endpoint Protection
    "liblocationawareness.a", # Symantec Endpoint Protection
    "libpersonalfirewall.a", # Symantec Endpoint Protection
    "libtrustedcomponents.a", # Symantec Endpoint Protection
  ]

  __check_stray_files "/usr/local/lib", "*.a", allow_list, <<~EOS
    Unbrewed static libraries were found in /usr/local/lib.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae, and may need to be deleted.

    Unexpected static libraries:
  EOS
end

#check_for_symlinked_cellarObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
# File 'diagnostic.rb', line 524

def check_for_symlinked_cellar
  return unless HOMEBREW_CELLAR.exist?
  return unless HOMEBREW_CELLAR.symlink?

  <<~EOS
    Symlinked Cellars can cause problems.
    Your Homebrew Cellar is a symlink: #{HOMEBREW_CELLAR}
                    which resolves to: #{HOMEBREW_CELLAR.realpath}

    The recommended Homebrew installations are either:
    (A) Have Cellar be a real directory inside of your HOMEBREW_PREFIX
    (B) Symlink "bin/brew" into your prefix, but don't symlink "Cellar".

    Older installations of Homebrew may have created a symlinked Cellar, but this can
    cause problems when two formulae install to locations that are mapped on top of each
    other during the linking step.
  EOS
end

#check_for_tap_ruby_files_locationsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
# File 'diagnostic.rb', line 842

def check_for_tap_ruby_files_locations
  bad_tap_files = {}
  Tap.each do |tap|
    unused_formula_dirs = tap.potential_formula_dirs - [tap.formula_dir]
    unused_formula_dirs.each do |dir|
      next unless dir.exist?

      dir.children.each do |path|
        next unless path.extname == ".rb"

        bad_tap_files[tap] ||= []
        bad_tap_files[tap] << path
      end
    end
  end
  return if bad_tap_files.empty?

  bad_tap_files.keys.map do |tap|
    <<~EOS
      Found Ruby file outside #{tap} tap formula directory.
      (#{tap.formula_dir}):
        #{bad_tap_files[tap].join("\n  ")}
    EOS
  end.join("\n")
end

#check_for_unlinked_but_not_keg_onlyObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
# File 'diagnostic.rb', line 794

def check_for_unlinked_but_not_keg_only
  unlinked = Formula.racks.reject do |rack|
    if (HOMEBREW_LINKED_KEGS/rack.basename).directory?
      true
    else
      begin
        Formulary.from_rack(rack).keg_only?
      rescue FormulaUnavailableError, TapFormulaAmbiguityError, TapFormulaWithOldnameAmbiguityError
        false
      end
    end
  end.map(&:basename)
  return if unlinked.empty?

  inject_file_list unlinked, <<~EOS
    You have unlinked kegs in your Cellar.
    Leaving kegs unlinked can lead to build-trouble and cause formulae that depend on
    those kegs to fail to run properly once built. Run `brew link` on these:
  EOS
end

#check_for_unreadable_installed_formulaObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
# File 'diagnostic.rb', line 775

def check_for_unreadable_installed_formula
  formula_unavailable_exceptions = []
  Formula.racks.each do |rack|
    Formulary.from_rack(rack)
  rescue FormulaUnreadableError, FormulaClassUnavailableError,
         TapFormulaUnreadableError, TapFormulaClassUnavailableError => e
    formula_unavailable_exceptions << e
  rescue FormulaUnavailableError,
         TapFormulaAmbiguityError, TapFormulaWithOldnameAmbiguityError
    nil
  end
  return if formula_unavailable_exceptions.empty?

  <<~EOS
    Some installed formulae are not readable:
      #{formula_unavailable_exceptions.join("\n\n  ")}
  EOS
end

#check_for_unsupported_macosObject



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'extend/os/mac/diagnostic.rb', line 108

def check_for_unsupported_macos
  return if Homebrew::EnvConfig.developer?
  return if ENV["HOMEBREW_INTEGRATION_TEST"]

  who = +"We"
  what = if OS::Mac.version.prerelease?
    "pre-release version"
  elsif OS::Mac.version.outdated_release?
    who << " (and Apple)"
    "old version"
  end
  return if what.blank?

  who.freeze

  <<~EOS
    You are using macOS #{MacOS.version}.
    #{who} do not provide support for this #{what}.
    #{please_create_pull_requests(what)}
  EOS
end

#check_git_newline_settingsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'diagnostic.rb', line 569

def check_git_newline_settings
  return unless Utils::Git.available?

  autocrlf = HOMEBREW_REPOSITORY.cd { `git config --get core.autocrlf`.chomp }
  return unless autocrlf == "true"

  <<~EOS
    Suspicious Git newline settings found.

    The detected Git newline settings will cause checkout problems:
      core.autocrlf = #{autocrlf}

    If you are not routinely dealing with Windows-based projects,
    consider removing these by running:
      git config --global core.autocrlf input
  EOS
end

#check_git_statusObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
# File 'diagnostic.rb', line 709

def check_git_status
  return unless Utils::Git.available?

  message = nil

  repos = {
    "Homebrew/brew"          => HOMEBREW_REPOSITORY,
    "Homebrew/homebrew-core" => CoreTap.instance.path,
  }

  %w[cask cask-drivers cask-fonts cask-versions].each do |tap|
    cask_tap = Tap.fetch "homebrew", tap
    repos[cask_tap.full_name] = cask_tap.path if cask_tap.installed?
  end

  repos.each do |name, path|
    status = path.cd do
      `git status --untracked-files=all --porcelain 2>/dev/null`
    end
    next if status.blank?

    message ||= ""
    message += "\n" unless message.empty?
    message += <<~EOS
      You have uncommitted modifications to #{name}.
      If this is a surprise to you, then you should stash these modifications.
      Stashing returns Homebrew to a pristine state but can be undone
      should you later need to do so for some reason.
        cd #{path} && git stash && git clean -d -f
    EOS

    modified = status.split("\n")
    message += inject_file_list modified, <<~EOS

      Uncommitted files:
    EOS
  end

  message
end

#check_git_versionObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



543
544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'diagnostic.rb', line 543

def check_git_version
  minimum_version = ENV["HOMEBREW_MINIMUM_GIT_VERSION"]
  return unless Utils::Git.available?
  return if Version.create(Utils::Git.version) >= Version.create(minimum_version)

  git = Formula["git"]
  git_upgrade_cmd = git.any_version_installed? ? "upgrade" : "install"
  <<~EOS
    An outdated version (#{Utils::Git.version}) of Git was detected in your PATH.
    Git #{minimum_version} or newer is required for Homebrew.
    Please upgrade:
      brew #{git_upgrade_cmd} git
  EOS
end

#check_glibc_minimum_versionObject



96
97
98
99
100
101
102
103
104
105
106
107
# File 'extend/os/linux/diagnostic.rb', line 96

def check_glibc_minimum_version
  return unless OS::Linux::Glibc.below_minimum_version?

  <<~EOS
    Your system glibc #{OS::Linux::Glibc.system_version} is too old.
    We only support glibc #{OS::Linux::Glibc.minimum_version} or later.
    #{please_create_pull_requests}
    We recommend updating to a newer version via your distribution's
    package manager, upgrading your distribution to the latest version,
    or changing distributions.
  EOS
end

#check_homebrew_prefixObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



868
869
870
871
872
873
874
875
876
877
# File 'diagnostic.rb', line 868

def check_homebrew_prefix
  return if Homebrew.default_prefix?

  <<~EOS
    Your Homebrew's prefix is not #{Homebrew::DEFAULT_PREFIX}.
    Some of Homebrew's bottles (binary packages) can only be used with the default
    prefix (#{Homebrew::DEFAULT_PREFIX}).
    #{please_create_pull_requests}
  EOS
end

#check_if_supported_sdk_availableObject



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
# File 'extend/os/mac/diagnostic.rb', line 438

def check_if_supported_sdk_available
  return unless DevelopmentTools.installed?
  return unless MacOS.sdk_root_needed?
  return if MacOS.sdk

  locator = MacOS.sdk_locator

  source = if locator.source == :clt
    return if MacOS::CLT.below_minimum_version? # Handled by other diagnostics.

    update_instructions = MacOS::CLT.update_instructions
    "Command Line Tools (CLT)"
  else
    return if MacOS::Xcode.below_minimum_version? # Handled by other diagnostics.

    update_instructions = MacOS::Xcode.update_instructions
    "Xcode"
  end

  <<~EOS
    Your #{source} does not support macOS #{MacOS.version}.
    It is either outdated or was modified.
    Please update your #{source} or delete it if no updates are available.
    #{update_instructions}
  EOS
end

#check_if_xcode_needs_clt_installedObject



194
195
196
197
198
199
200
201
# File 'extend/os/mac/diagnostic.rb', line 194

def check_if_xcode_needs_clt_installed
  return unless MacOS::Xcode.needs_clt_installed?

  <<~EOS
    Xcode alone is not sufficient on #{MacOS.version.pretty_name}.
    #{DevelopmentTools.installation_instructions}
  EOS
end

#check_kernel_minimum_versionObject



109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'extend/os/linux/diagnostic.rb', line 109

def check_kernel_minimum_version
  return unless OS::Linux::Kernel.below_minimum_version?

  <<~EOS
    Your Linux kernel #{OS.kernel_version} is too old.
    We only support kernel #{OS::Linux::Kernel.minimum_version} or later.
    You will be unable to use binary packages (bottles).
    #{please_create_pull_requests}
    We recommend updating to a newer version via your distribution's
    package manager, upgrading your distribution to the latest version,
    or changing distributions.
  EOS
end

#check_linuxbrew_bottle_domainObject



132
133
134
135
136
137
138
139
140
# File 'extend/os/linux/diagnostic.rb', line 132

def check_linuxbrew_bottle_domain
  return unless Homebrew::EnvConfig.bottle_domain.include?("linuxbrew")

  <<~EOS
    Your HOMEBREW_BOTTLE_DOMAIN still contains "linuxbrew".
    You must unset it (or adjust it to not contain linuxbrew
    e.g. by using homebrew instead).
  EOS
end

#check_linuxbrew_coreObject



123
124
125
126
127
128
129
130
# File 'extend/os/linux/diagnostic.rb', line 123

def check_linuxbrew_core
  return unless CoreTap.instance.linuxbrew_core?

  <<~EOS
    Your Linux Homebrew/core repository is still linuxbrew-core.
    You must `brew update` to update to homebrew-core.
  EOS
end

#check_missing_depsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'diagnostic.rb', line 677

def check_missing_deps
  return unless HOMEBREW_CELLAR.exist?

  missing = Set.new
  Homebrew::Diagnostic.missing_deps(Formula.installed).each_value do |deps|
    missing.merge(deps)
  end
  return if missing.empty?

  <<~EOS
    Some installed formulae are missing dependencies.
    You should `brew install` the missing dependencies:
      brew install #{missing.sort_by(&:full_name) * " "}

    Run `brew missing` for more details.
  EOS
end

#check_multiple_cellarsObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



399
400
401
402
403
404
405
406
407
408
409
# File 'diagnostic.rb', line 399

def check_multiple_cellars
  return if HOMEBREW_PREFIX.to_s == HOMEBREW_REPOSITORY.to_s
  return unless (HOMEBREW_REPOSITORY/"Cellar").exist?
  return unless (HOMEBREW_PREFIX/"Cellar").exist?

  <<~EOS
    You have multiple Cellars.
    You should delete #{HOMEBREW_REPOSITORY}/Cellar:
      rm -rf #{HOMEBREW_REPOSITORY}/Cellar
  EOS
end

#check_ruby_versionObject



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'extend/os/mac/diagnostic.rb', line 203

def check_ruby_version
  # TODO: require 2.6.8 for everyone once enough have updated to Monterey
  required_version = if MacOS.version >= :monterey ||
                        ENV["HOMEBREW_RUBY_PATH"].to_s.include?("/vendor/portable-ruby/")
    "2.6.8"
  else
    HOMEBREW_REQUIRED_RUBY_VERSION
  end
  return if RUBY_VERSION == required_version
  return if Homebrew::EnvConfig.developer? && OS::Mac.version.prerelease?

  <<~EOS
    Ruby version #{RUBY_VERSION} is unsupported on macOS #{MacOS.version}. Homebrew
    is developed and tested on Ruby #{required_version}, and may not work correctly
    on other Rubies. Patches are accepted as long as they don't cause breakage
    on supported Rubies.
  EOS
end

#check_supported_architectureObject



86
87
88
89
90
91
92
93
94
# File 'extend/os/linux/diagnostic.rb', line 86

def check_supported_architecture
  return if Hardware::CPU.arch == :x86_64

  <<~EOS
    Your CPU architecture (#{Hardware::CPU.arch}) is not supported. We only support
    x86_64 CPU architectures. You will be unable to use binary packages (bottles).
    #{please_create_pull_requests}
  EOS
end

#check_tap_git_branchString?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
# File 'diagnostic.rb', line 605

def check_tap_git_branch
  return if ENV["CI"]
  return unless Utils::Git.available?

  commands = Tap.map do |tap|
    next if tap.path.git_default_origin_branch?

    "git -C $(brew --repo #{tap.name}) checkout #{tap.path.git_origin_branch}"
  end.compact

  return if commands.blank?

  <<~EOS
    Some taps are not on the default git origin branch and may not receive
    updates. If this is a surprise to you, check out the default branch with:
      #{commands.join("\n  ")}
  EOS
end

#check_tmpdirObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



668
669
670
671
672
673
674
675
# File 'diagnostic.rb', line 668

def check_tmpdir
  tmpdir = ENV["TMPDIR"]
  return if tmpdir.nil? || File.directory?(tmpdir)

  <<~EOS
    TMPDIR #{tmpdir.inspect} doesn't exist.
  EOS
end

#check_tmpdir_executableObject



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'extend/os/linux/diagnostic.rb', line 44

def check_tmpdir_executable
  f = Tempfile.new(%w[homebrew_check_tmpdir_executable .sh], HOMEBREW_TEMP)
  f.write "#!/bin/sh\n"
  f.chmod 0700
  f.close
  return if system f.path

  <<~EOS
    The directory #{HOMEBREW_TEMP} does not permit executing
    programs. It is likely mounted as "noexec". Please set HOMEBREW_TEMP
    in your #{shell_profile} to a different directory, for example:
      export HOMEBREW_TEMP=~/tmp
      echo 'export HOMEBREW_TEMP=~/tmp' >> #{shell_profile}
  EOS
ensure
  f.unlink
end

#check_tmpdir_sticky_bitObject Also known as: generic_check_tmpdir_sticky_bit

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



31
32
33
34
35
36
37
38
39
40
41
42
# File 'extend/os/linux/diagnostic.rb', line 31

def check_tmpdir_sticky_bit
  message = generic_check_tmpdir_sticky_bit
  return if message.nil?

  message + <<~EOS
    If you don't have administrative privileges on this machine,
    create a directory and set the HOMEBREW_TEMP environment variable,
    for example:
      install -d -m 1755 ~/tmp
      #{Utils::Shell.set_variable_in_profile("HOMEBREW_TEMP", "~/tmp")}
  EOS
end

#check_umask_not_zeroObject



75
76
77
78
79
80
81
82
83
84
# File 'extend/os/linux/diagnostic.rb', line 75

def check_umask_not_zero
  return unless File.umask.zero?

  <<~EOS
    umask is currently set to 000. Directories created by Homebrew cannot
    be world-writable. This issue can be resolved by adding "umask 002" to
    your #{shell_profile}:
      echo 'umask 002' >> #{shell_profile}
  EOS
end

#check_user_path_1Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# File 'diagnostic.rb', line 411

def check_user_path_1
  @seen_prefix_bin = false
  @seen_prefix_sbin = false

  message = ""

  paths.each do |p|
    case p
    when "/usr/bin"
      unless @seen_prefix_bin
        # only show the doctor message if there are any conflicts
        # rationale: a default install should not trigger any brew doctor messages
        conflicts = Dir["#{HOMEBREW_PREFIX}/bin/*"]
                    .map { |fn| File.basename fn }
                    .select { |bn| File.exist? "/usr/bin/#{bn}" }

        unless conflicts.empty?
          message = inject_file_list conflicts, <<~EOS
            /usr/bin occurs before #{HOMEBREW_PREFIX}/bin in your PATH.
            This means that system-provided programs will be used instead of those
            provided by Homebrew. Consider setting your PATH so that
            #{HOMEBREW_PREFIX}/bin occurs before /usr/bin. Here is a one-liner:
              #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/bin")}

            The following tools exist at both paths:
          EOS
        end
      end
    when "#{HOMEBREW_PREFIX}/bin"
      @seen_prefix_bin = true
    when "#{HOMEBREW_PREFIX}/sbin"
      @seen_prefix_sbin = true
    end
  end

  message unless message.empty?
end

#check_user_path_2Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



449
450
451
452
453
454
455
456
457
# File 'diagnostic.rb', line 449

def check_user_path_2
  return if @seen_prefix_bin

  <<~EOS
    Homebrew's "bin" was not found in your PATH.
    Consider setting your PATH for example like so:
      #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/bin")}
  EOS
end

#check_user_path_3Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
# File 'diagnostic.rb', line 459

def check_user_path_3
  return if @seen_prefix_sbin

  # Don't complain about sbin not being in the path if it doesn't exist
  sbin = HOMEBREW_PREFIX/"sbin"
  return unless sbin.directory?
  return if sbin.children.empty?
  return if sbin.children.one? && sbin.children.first.basename.to_s == ".keepme"

  <<~EOS
    Homebrew's "sbin" was not found in your PATH but you have installed
    formulae that put executables in #{HOMEBREW_PREFIX}/sbin.
    Consider setting your PATH for example like so:
      #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/sbin")}
  EOS
end

#check_xcode_license_approvedObject



258
259
260
261
262
263
264
265
266
267
268
269
# File 'extend/os/mac/diagnostic.rb', line 258

def check_xcode_license_approved
  # If the user installs Xcode-only, they have to approve the
  # license or no "xc*" tool will work.
  return unless `/usr/bin/xcrun clang 2>&1`.include?("license")
  return if $CHILD_STATUS.success?

  <<~EOS
    You have not agreed to the Xcode license.
    Agree to the license by opening Xcode.app or running:
      sudo xcodebuild -license
  EOS
end

#check_xcode_minimum_versionObject



172
173
174
175
176
177
178
179
180
181
182
183
# File 'extend/os/mac/diagnostic.rb', line 172

def check_xcode_minimum_version
  return unless MacOS::Xcode.below_minimum_version?

  xcode = MacOS::Xcode.version.to_s
  xcode += " => #{MacOS::Xcode.prefix}" unless MacOS::Xcode.default_prefix?

  <<~EOS
    Your Xcode (#{xcode}) is too outdated.
    Please update to Xcode #{MacOS::Xcode.latest_version} (or delete it).
    #{MacOS::Xcode.update_instructions}
  EOS
end

#check_xcode_prefixObject



222
223
224
225
226
227
228
229
230
231
# File 'extend/os/mac/diagnostic.rb', line 222

def check_xcode_prefix
  prefix = MacOS::Xcode.prefix
  return if prefix.nil?
  return unless prefix.to_s.include?(" ")

  <<~EOS
    Xcode is installed to a directory with a space in the name.
    This will cause some formulae to fail to build.
  EOS
end

#check_xcode_prefix_existsObject



233
234
235
236
237
238
239
240
241
242
# File 'extend/os/mac/diagnostic.rb', line 233

def check_xcode_prefix_exists
  prefix = MacOS::Xcode.prefix
  return if prefix.nil? || prefix.exist?

  <<~EOS
    The directory Xcode is reportedly installed to doesn't exist:
      #{prefix}
    You may need to `xcode-select` the proper path if you have moved Xcode.
  EOS
end

#check_xcode_select_pathObject



244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'extend/os/mac/diagnostic.rb', line 244

def check_xcode_select_path
  return if MacOS::CLT.installed?
  return unless MacOS::Xcode.installed?
  return if File.file?("#{MacOS.active_developer_dir}/usr/bin/xcodebuild")

  path = MacOS::Xcode.bundle_path
  path = "/Developer" if path.nil? || !path.directory?
  <<~EOS
    Your Xcode is configured with an invalid path.
    You should change it to the correct path:
      sudo xcode-select --switch #{path}
  EOS
end

#check_xcode_up_to_dateObject



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'extend/os/mac/diagnostic.rb', line 130

def check_xcode_up_to_date
  return unless MacOS::Xcode.outdated?

  # CI images are going to end up outdated so don't complain when
  # `brew test-bot` runs `brew doctor` in the CI for the Homebrew/brew
  # repository. This only needs to support whatever CI providers
  # Homebrew/brew is currently using.
  return if ENV["GITHUB_ACTIONS"]

  message = <<~EOS
    Your Xcode (#{MacOS::Xcode.version}) is outdated.
    Please update to Xcode #{MacOS::Xcode.latest_version} (or delete it).
    #{MacOS::Xcode.update_instructions}
  EOS

  if OS::Mac.version.prerelease?
    current_path = Utils.popen_read("/usr/bin/xcode-select", "-p")
    message += <<~EOS
      If #{MacOS::Xcode.latest_version} is installed, you may need to:
        sudo xcode-select --switch /Applications/Xcode.app
      Current developer directory is:
        #{current_path}
    EOS
  end
  message
end

#check_xdg_data_dirsObject



62
63
64
65
66
67
68
69
70
71
72
73
# File 'extend/os/linux/diagnostic.rb', line 62

def check_xdg_data_dirs
  return if ENV["XDG_DATA_DIRS"].blank?
  return if ENV["XDG_DATA_DIRS"].split("/").include?(HOMEBREW_PREFIX/"share")

  <<~EOS
    Homebrew's share was not found in your XDG_DATA_DIRS but you have
    this variable set to include other locations.
    Some programs like `vapigen` may not work correctly.
    Consider adding Homebrew's share directory to XDG_DATA_DIRS like so:
      echo 'export XDG_DATA_DIRS="#{HOMEBREW_PREFIX}/share:$XDG_DATA_DIRS"' >> #{shell_profile}
  EOS
end

#check_xquartz_up_to_dateObject



271
272
273
274
275
276
277
278
279
280
# File 'extend/os/mac/diagnostic.rb', line 271

def check_xquartz_up_to_date
  return unless MacOS::XQuartz.outdated?

  <<~EOS
    Your XQuartz (#{MacOS::XQuartz.version}) is outdated.
    Please install XQuartz #{MacOS::XQuartz.latest_version} (or delete the current version).
    XQuartz can be updated using Homebrew Cask by running:
      brew reinstall xquartz
  EOS
end

#examine_git_origin(repository_path, desired_origin) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'diagnostic.rb', line 124

def examine_git_origin(repository_path, desired_origin)
  return if !Utils::Git.available? || !repository_path.git?

  current_origin = repository_path.git_origin

  if current_origin.nil?
    <<~EOS
      Missing #{desired_origin} git origin remote.

      Without a correctly configured origin, Homebrew won't update
      properly. You can solve this by adding the remote:
        git -C "#{repository_path}" remote add origin #{Formatter.url(desired_origin)}
    EOS
  elsif !current_origin.match?(%r{#{desired_origin}(\.git|/)?$}i)
    <<~EOS
      Suspicious #{desired_origin} git origin remote found.
      The current git origin is:
        #{current_origin}

      With a non-standard origin, Homebrew won't update properly.
      You can solve this by setting the origin remote:
        git -C "#{repository_path}" remote set-url origin #{Formatter.url(desired_origin)}
    EOS
  end
end

#fatal_build_from_source_checksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



60
61
62
63
64
65
66
67
68
69
# File 'extend/os/mac/diagnostic.rb', line 60

def fatal_build_from_source_checks
  %w[
    check_xcode_license_approved
    check_xcode_minimum_version
    check_clt_minimum_version
    check_if_xcode_needs_clt_installed
    check_if_supported_sdk_available
    check_broken_sdks
  ].freeze
end

#fatal_preinstall_checksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



86
87
88
89
90
91
92
93
94
95
# File 'diagnostic.rb', line 86

def fatal_preinstall_checks
  checks = %w[
    check_access_directories
  ]

  # We need the developer tools for `codesign`.
  checks << "check_for_installed_developer_tools" if Hardware::CPU.arm?

  checks.freeze
end

#fatal_setup_build_environment_checksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



71
72
73
74
75
76
77
# File 'extend/os/mac/diagnostic.rb', line 71

def fatal_setup_build_environment_checks
  %w[
    check_xcode_minimum_version
    check_clt_minimum_version
    check_if_supported_sdk_available
  ].freeze
end

#find_relative_paths(*relative_paths) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Finds files in HOMEBREW_PREFIX and /usr/local. Specify paths relative to a prefix, e.g. “include/foo.h”. Sets @found for your convenience.



61
62
63
64
65
# File 'diagnostic.rb', line 61

def find_relative_paths(*relative_paths)
  @found = [HOMEBREW_PREFIX, "/usr/local"].uniq.reduce([]) do |found, prefix|
    found + relative_paths.map { |f| File.join(prefix, f) }.select { |f| File.exist? f }
  end
end

#inject_file_list(list, string) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



67
68
69
70
# File 'diagnostic.rb', line 67

def inject_file_list(list, string)
  list.reduce(string.dup) { |acc, elem| acc << "  #{elem}\n" }
      .freeze
end

#none_stringString

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



77
78
79
# File 'diagnostic.rb', line 77

def none_string
  "<NONE>"
end

#please_create_pull_requests(what = "unsupported configuration") ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



114
115
116
117
118
119
120
121
122
# File 'diagnostic.rb', line 114

def please_create_pull_requests(what = "unsupported configuration")
  <<~EOS
    You will encounter build failures with some formulae.
    Please create pull requests instead of asking for help on Homebrew's GitHub,
    Twitter or any other official channels. You are responsible for resolving
    any issues you experience while you are running this
    #{what}.
  EOS
end

#supported_configuration_checksObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



79
80
81
82
83
# File 'extend/os/mac/diagnostic.rb', line 79

def supported_configuration_checks
  %w[
    check_for_unsupported_macos
  ].freeze
end

#user_tilde(path) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



72
73
74
# File 'diagnostic.rb', line 72

def user_tilde(path)
  path.gsub(ENV["HOME"], "~")
end