Class: Homebrew::Diagnostic::Checks Private
- Inherits:
-
Object
- Object
- Homebrew::Diagnostic::Checks
- Defined in:
- Library/Homebrew/diagnostic.rb,
Library/Homebrew/extend/os/mac/diagnostic.rb,
Library/Homebrew/extend/os/linux/diagnostic.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
Diagnostic checks.
HELPERS collapse
- #add_info(*args) ⇒ Object private
-
#find_relative_paths(*relative_paths) ⇒ Object
private
Finds files in
HOMEBREW_PREFIX
and /usr/local. - #inject_file_list(list, string) ⇒ Object private
- #none_string ⇒ Object private
- #user_tilde(path) ⇒ Object private
Instance Method Summary collapse
- #__check_linked_brew(f) ⇒ Object private
- #__check_stray_files(dir, pattern, allow_list, message) ⇒ Object private
- #all ⇒ Object private
- #build_error_checks ⇒ Object private
- #build_from_source_checks ⇒ Object private
- #cask_checks ⇒ Object private
- #check_access_directories ⇒ Object private
- #check_brew_git_origin ⇒ Object private
- #check_cask_environment_variables ⇒ Object private
- #check_cask_install_location ⇒ Object private
- #check_cask_load_path ⇒ Object private
- #check_cask_quarantine_support ⇒ Object private
- #check_cask_software_versions ⇒ Object private
- #check_cask_staging_location ⇒ Object private
- #check_cask_taps ⇒ Object private
- #check_cask_xattr ⇒ Object private
- #check_casktap_git_origin ⇒ Object private
- #check_clt_minimum_version ⇒ Object private
- #check_clt_up_to_date ⇒ Object private
- #check_coretap_git_branch ⇒ Object private
- #check_coretap_git_origin ⇒ Object private
- #check_deleted_formula ⇒ Object private
- #check_deprecated_caskroom_taps ⇒ Object private
- #check_deprecated_disabled ⇒ Object private
- #check_deprecated_official_taps ⇒ Object private
- #check_exist_directories ⇒ Object private
- #check_filesystem_case_sensitive ⇒ Object private
-
#check_for_anaconda ⇒ Object
private
Anaconda installs multiple system & brew dupes, including OpenSSL, Python, sqlite, libpng, Qt, etc.
- #check_for_bad_python_symlink ⇒ Object private
- #check_for_bitdefender ⇒ Object private
- #check_for_broken_symlinks ⇒ Object private
- #check_for_config_scripts ⇒ Object private
- #check_for_external_cmd_name_conflict ⇒ Object private
- #check_for_gettext ⇒ Object private
- #check_for_git ⇒ Object private
- #check_for_iconv ⇒ Object private
- #check_for_installed_developer_tools ⇒ Object private
- #check_for_multiple_volumes ⇒ Object private
- #check_for_non_prefixed_coreutils ⇒ Object private
- #check_for_non_prefixed_findutils ⇒ Object private
- #check_for_other_frameworks ⇒ Object private
- #check_for_pydistutils_cfg_in_home ⇒ Object private
- #check_for_stray_dylibs ⇒ Object private
- #check_for_stray_headers ⇒ Object private
- #check_for_stray_las ⇒ Object private
- #check_for_stray_pcs ⇒ Object private
- #check_for_stray_static_libs ⇒ Object private
- #check_for_symlinked_cellar ⇒ Object private
- #check_for_tap_ruby_files_locations ⇒ Object private
- #check_for_unlinked_but_not_keg_only ⇒ Object private
- #check_for_unreadable_installed_formula ⇒ Object private
- #check_for_unsupported_macos ⇒ Object private
- #check_git_newline_settings ⇒ Object private
- #check_git_status ⇒ Object private
- #check_git_version ⇒ Object private
- #check_glibc_minimum_version ⇒ Object private
- #check_homebrew_prefix ⇒ Object private
- #check_if_supported_sdk_available ⇒ Object private
- #check_if_xcode_needs_clt_installed ⇒ Object private
- #check_kernel_minimum_version ⇒ Object private
- #check_missing_deps ⇒ Object private
- #check_multiple_cellars ⇒ Object private
- #check_ruby_version ⇒ Object private
- #check_supported_architecture ⇒ Object private
- #check_tmpdir ⇒ Object private
- #check_tmpdir_executable ⇒ Object private
- #check_tmpdir_sticky_bit ⇒ Object private
- #check_umask_not_zero ⇒ Object private
- #check_user_path_1 ⇒ Object private
- #check_user_path_2 ⇒ Object private
- #check_user_path_3 ⇒ Object private
- #check_xcode_license_approved ⇒ Object private
- #check_xcode_minimum_version ⇒ Object private
- #check_xcode_prefix ⇒ Object private
- #check_xcode_prefix_exists ⇒ Object private
- #check_xcode_select_path ⇒ Object private
- #check_xcode_up_to_date ⇒ Object private
- #check_xdg_data_dirs ⇒ Object private
- #check_xquartz_up_to_date ⇒ Object private
- #examine_git_origin(repository_path, desired_origin) ⇒ Object private
- #fatal_build_from_source_checks ⇒ Object private
- #fatal_preinstall_checks ⇒ Object private
- #fatal_setup_build_environment_checks ⇒ Object private
- #generic_check_tmpdir_sticky_bit ⇒ Object private
-
#initialize(verbose: true) ⇒ Checks
constructor
private
A new instance of Checks.
- #please_create_pull_requests(what = "unsupported configuration") ⇒ Object private
- #supported_configuration_checks ⇒ Object private
Constructor Details
#initialize(verbose: true) ⇒ Checks
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of Checks.
51 52 53 |
# File 'Library/Homebrew/diagnostic.rb', line 51 def initialize(verbose: true) @verbose = verbose end |
Instance Method Details
#__check_linked_brew(f) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
594 595 596 597 598 599 600 601 602 603 604 605 |
# File 'Library/Homebrew/diagnostic.rb', line 594 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. You should avoid using this method if possible, as it may be removed or be changed in the future.
181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'Library/Homebrew/diagnostic.rb', line 181 def __check_stray_files(dir, pattern, allow_list, ) 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, ) end |
#add_info(*args) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
78 79 80 |
# File 'Library/Homebrew/diagnostic.rb', line 78 def add_info(*args) ohai(*args) if @verbose end |
#all ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1008 1009 1010 |
# File 'Library/Homebrew/diagnostic.rb', line 1008 def all methods.map(&:to_s).grep(/^check_/) end |
#build_error_checks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
107 108 109 |
# File 'Library/Homebrew/diagnostic.rb', line 107 def build_error_checks supported_configuration_checks + build_from_source_checks end |
#build_from_source_checks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
103 104 105 |
# File 'Library/Homebrew/diagnostic.rb', line 103 def build_from_source_checks [].freeze end |
#cask_checks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1012 1013 1014 |
# File 'Library/Homebrew/diagnostic.rb', line 1012 def cask_checks all.grep(/^check_cask_/) end |
#check_access_directories ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'Library/Homebrew/diagnostic.rb', line 353 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_origin ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
550 551 552 |
# File 'Library/Homebrew/diagnostic.rb', line 550 def check_brew_git_origin examine_git_origin(HOMEBREW_REPOSITORY, Homebrew::EnvConfig.brew_git_remote) end |
#check_cask_environment_variables ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 |
# File 'Library/Homebrew/diagnostic.rb', line 942 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_location ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
884 885 886 887 888 889 890 891 |
# File 'Library/Homebrew/diagnostic.rb', line 884 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_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
934 935 936 937 938 939 940 |
# File 'Library/Homebrew/diagnostic.rb', line 934 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_support ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 |
# File 'Library/Homebrew/diagnostic.rb', line 993 def check_cask_quarantine_support case Cask::Quarantine.check_quarantine_support when :quarantine_available nil when :xattr_broken "There's not a working version of xattr." 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_versions ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'Library/Homebrew/diagnostic.rb', line 861 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 add_info "Java", SystemConfig.describe_java nil end |
#check_cask_staging_location ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 |
# File 'Library/Homebrew/diagnostic.rb', line 893 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 unless 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_taps ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 |
# File 'Library/Homebrew/diagnostic.rb', line 909 def check_cask_taps default_tap = Tap.default_cask_tap alt_taps = Tap.select { |t| t.cask_dir.exist? && t != default_tap } error_tap_paths = [] add_info "Homebrew Cask Taps:", ([default_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_xattr ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 |
# File 'Library/Homebrew/diagnostic.rb', line 967 def check_cask_xattr result = system_command "/usr/bin/xattr" 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_git_origin ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
558 559 560 561 562 563 |
# File 'Library/Homebrew/diagnostic.rb', line 558 def check_casktap_git_origin cask_tap = Tap.default_cask_tap return unless cask_tap.installed? examine_git_origin(cask_tap.path, cask_tap.remote) end |
#check_clt_minimum_version ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
172 173 174 175 176 177 178 179 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 172 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_date ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 144 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_git_branch ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 |
# File 'Library/Homebrew/diagnostic.rb', line 565 def check_coretap_git_branch return if ENV["CI"] coretap_path = CoreTap.instance.path return if !Utils::Git.available? || !(coretap_path/".git").exist? branch = coretap_path.git_branch return if branch.blank? || branch.include?("master") <<~EOS #{CoreTap.instance.full_name} is not on the master branch. Check out the master branch by running: git -C "$(brew --repo homebrew/core)" checkout master EOS end |
#check_coretap_git_origin ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
554 555 556 |
# File 'Library/Homebrew/diagnostic.rb', line 554 def check_coretap_git_origin examine_git_origin(CoreTap.instance.path, Homebrew::EnvConfig.core_git_remote) end |
#check_deleted_formula ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 |
# File 'Library/Homebrew/diagnostic.rb', line 844 def check_deleted_formula kegs = Keg.all deleted_formulae = [] kegs.each do |keg| keg_name = keg.name deleted_formulae << keg_name if Formulary.tap_paths(keg_name).blank? end 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_taps ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
398 399 400 401 402 403 404 405 406 407 408 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 398 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_disabled ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'Library/Homebrew/diagnostic.rb', line 653 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_taps ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
582 583 584 585 586 587 588 589 590 591 592 |
# File 'Library/Homebrew/diagnostic.rb', line 582 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_directories ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'Library/Homebrew/diagnostic.rb', line 339 def check_exist_directories 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 account. sudo mkdir -p #{not_exist_dirs.join(" ")} sudo chown -R $(whoami) #{not_exist_dirs.join(" ")} EOS end |
#check_filesystem_case_sensitive ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 262 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_anaconda ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
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.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'Library/Homebrew/diagnostic.rb', line 159 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_bad_python_symlink ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
701 702 703 704 705 706 707 708 709 710 711 712 713 |
# File 'Library/Homebrew/diagnostic.rb', line 701 def check_for_bad_python_symlink return unless which "python" `python -V 2>&1` =~ /Python (\d+)\./ # This won't be the right warning if we matched nothing at all return if Regexp.last_match(1).nil? return if Regexp.last_match(1) == "2" <<~EOS python is symlinked to python#{Regexp.last_match(1)} This will confuse build scripts and in general lead to subtle breakage. EOS end |
#check_for_bitdefender ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 352 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 |
#check_for_broken_symlinks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'Library/Homebrew/diagnostic.rb', line 311 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_scripts ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
# File 'Library/Homebrew/diagnostic.rb', line 448 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 ].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_conflict ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'Library/Homebrew/diagnostic.rb', line 780 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 = "You have external commands with conflicting names.\n" cmd_map.each do |cmd_name, cmd_paths| += inject_file_list cmd_paths, <<~EOS Found command `#{cmd_name}` in the following places: EOS end end |
#check_for_gettext ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 295 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? homebrew_owned = @found.all? do |path| Pathname.new(path).realpath.to_s.start_with? "#{HOMEBREW_CELLAR}/gettext" end return if homebrew_owned 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_git ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
521 522 523 524 525 526 527 528 529 530 |
# File 'Library/Homebrew/diagnostic.rb', line 521 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_iconv ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
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 349 350 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 322 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_tools ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
146 147 148 149 150 151 152 153 |
# File 'Library/Homebrew/diagnostic.rb', line 146 def check_for_installed_developer_tools return if DevelopmentTools.installed? <<~EOS No developer tools installed. #{DevelopmentTools.installation_instructions} EOS end |
#check_for_multiple_volumes ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 365 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_coreutils ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'Library/Homebrew/diagnostic.rb', line 715 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_findutils ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 78 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_frameworks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 |
# File 'Library/Homebrew/diagnostic.rb', line 607 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_home ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
729 730 731 732 733 734 735 736 737 738 |
# File 'Library/Homebrew/diagnostic.rb', line 729 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_dylibs ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'Library/Homebrew/diagnostic.rb', line 194 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_headers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'Library/Homebrew/diagnostic.rb', line 292 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_las ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'Library/Homebrew/diagnostic.rb', line 271 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_pcs ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'Library/Homebrew/diagnostic.rb', line 251 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_libs ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
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 'Library/Homebrew/diagnostic.rb', line 226 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_cellar ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 |
# File 'Library/Homebrew/diagnostic.rb', line 487 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_locations ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 |
# File 'Library/Homebrew/diagnostic.rb', line 807 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_only ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 |
# File 'Library/Homebrew/diagnostic.rb', line 759 def check_for_unlinked_but_not_keg_only unlinked = Formula.racks.reject do |rack| if !(HOMEBREW_LINKED_KEGS/rack.basename).directory? begin Formulary.from_rack(rack).keg_only? rescue FormulaUnavailableError, TapFormulaAmbiguityError, TapFormulaWithOldnameAmbiguityError false end else true 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 brews that depend on those kegs to fail to run properly once built. Run `brew link` on these: EOS end |
#check_for_unreadable_installed_formula ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 |
# File 'Library/Homebrew/diagnostic.rb', line 740 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_macos ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 93 def check_for_unsupported_macos return if Homebrew::EnvConfig.developer? # TODO: remove when Big Sur is released. return if MacOS.version == :big_sur && ENV["HOMEBREW_GITHUB_ACTIONS_BIG_SUR_TESTING"] who = +"We" if OS::Mac.prerelease? what = "pre-release version" elsif OS::Mac.outdated_release? who << " (and Apple)" what = "old version" else return end 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_settings ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'Library/Homebrew/diagnostic.rb', line 532 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_status ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 |
# File 'Library/Homebrew/diagnostic.rb', line 667 def check_git_status return unless Utils::Git.available? = nil { "Homebrew/brew" => HOMEBREW_REPOSITORY, "Homebrew/homebrew-core" => CoreTap.instance.path, }.each do |name, path| status = path.cd do `git status --untracked-files=all --porcelain 2>/dev/null` end next if status.blank? ||= "" += "\n" unless .empty? += <<~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") += inject_file_list modified, <<~EOS Uncommitted files: EOS end end |
#check_git_version ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'Library/Homebrew/diagnostic.rb', line 506 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_version ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'Library/Homebrew/extend/os/linux/diagnostic.rb', line 86 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_prefix ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
833 834 835 836 837 838 839 840 841 842 |
# File 'Library/Homebrew/diagnostic.rb', line 833 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_available ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 410 def check_if_supported_sdk_available return unless MacOS.sdk_root_needed? return if MacOS.sdk locator = MacOS.sdk_locator source = if locator.source == :clt "CLT" else "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. EOS end |
#check_if_xcode_needs_clt_installed ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
181 182 183 184 185 186 187 188 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 181 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_version ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'Library/Homebrew/extend/os/linux/diagnostic.rb', line 99 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_missing_deps ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 |
# File 'Library/Homebrew/diagnostic.rb', line 635 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_cellars ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
371 372 373 374 375 376 377 378 379 380 381 |
# File 'Library/Homebrew/diagnostic.rb', line 371 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_version ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
190 191 192 193 194 195 196 197 198 199 200 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 190 def check_ruby_version return if RUBY_VERSION == HOMEBREW_REQUIRED_RUBY_VERSION return if Homebrew::EnvConfig.developer? && OS::Mac.prerelease? <<~EOS Ruby version #{RUBY_VERSION} is unsupported on #{MacOS.version}. Homebrew is developed and tested on Ruby #{HOMEBREW_REQUIRED_RUBY_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_architecture ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
76 77 78 79 80 81 82 83 84 |
# File 'Library/Homebrew/extend/os/linux/diagnostic.rb', line 76 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_tmpdir ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
626 627 628 629 630 631 632 633 |
# File 'Library/Homebrew/diagnostic.rb', line 626 def check_tmpdir tmpdir = ENV["TMPDIR"] return if tmpdir.nil? || File.directory?(tmpdir) <<~EOS TMPDIR #{tmpdir.inspect} doesn't exist. EOS end |
#check_tmpdir_executable ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'Library/Homebrew/extend/os/linux/diagnostic.rb', line 34 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_bit ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
328 329 330 331 332 333 334 335 336 |
# File 'Library/Homebrew/diagnostic.rb', line 328 def check_tmpdir_sticky_bit world_writable = HOMEBREW_TEMP.stat.mode & 0777 == 0777 return if !world_writable || HOMEBREW_TEMP.sticky? <<~EOS #{HOMEBREW_TEMP} is world-writable but does not have the sticky bit set. Please execute `sudo chmod +t #{HOMEBREW_TEMP}` in your Terminal. EOS end |
#check_umask_not_zero ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
65 66 67 68 69 70 71 72 73 74 |
# File 'Library/Homebrew/extend/os/linux/diagnostic.rb', line 65 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_1 ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
383 384 385 386 387 388 389 390 391 392 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 |
# File 'Library/Homebrew/diagnostic.rb', line 383 def check_user_path_1 @seen_prefix_bin = false @seen_prefix_sbin = false = "" 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? = inject_file_list conflicts, <<~EOS /usr/bin occurs before #{HOMEBREW_PREFIX}/bin 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 unless .empty? end |
#check_user_path_2 ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
421 422 423 424 425 426 427 428 429 |
# File 'Library/Homebrew/diagnostic.rb', line 421 def check_user_path_2 return if @seen_prefix_bin <<~EOS Homebrew's bin was not found in your PATH. Consider setting the PATH for example like so: #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/bin")} EOS end |
#check_user_path_3 ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'Library/Homebrew/diagnostic.rb', line 431 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 the PATH for example like so: #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/sbin")} EOS end |
#check_xcode_license_approved ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 238 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_version ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 159 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_prefix ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
202 203 204 205 206 207 208 209 210 211 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 202 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_exists ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
213 214 215 216 217 218 219 220 221 222 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 213 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_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 224 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_date ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 117 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"] = <<~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.prerelease? current_path = Utils.popen_read("/usr/bin/xcode-select", "-p") += <<~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 end |
#check_xdg_data_dirs ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'Library/Homebrew/extend/os/linux/diagnostic.rb', line 52 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_date ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
251 252 253 254 255 256 257 258 259 260 |
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 251 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. You should avoid using this method if possible, as it may be removed or be changed in the future.
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'Library/Homebrew/diagnostic.rb', line 120 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_checks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
89 90 91 92 93 |
# File 'Library/Homebrew/diagnostic.rb', line 89 def fatal_build_from_source_checks %w[ check_for_installed_developer_tools ].freeze end |
#fatal_preinstall_checks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
83 84 85 86 87 |
# File 'Library/Homebrew/diagnostic.rb', line 83 def fatal_preinstall_checks %w[ check_access_directories ].freeze end |
#fatal_setup_build_environment_checks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
95 96 97 |
# File 'Library/Homebrew/diagnostic.rb', line 95 def fatal_setup_build_environment_checks [].freeze end |
#find_relative_paths(*relative_paths) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Finds files in HOMEBREW_PREFIX
and /usr/local.
Specify paths relative to a prefix, e.g. "include/foo.h".
Sets @found for your convenience.
59 60 61 62 63 |
# File 'Library/Homebrew/diagnostic.rb', line 59 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 |
#generic_check_tmpdir_sticky_bit ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
337 338 339 340 341 342 343 344 345 |
# File 'Library/Homebrew/diagnostic.rb', line 337 def check_tmpdir_sticky_bit world_writable = HOMEBREW_TEMP.stat.mode & 0777 == 0777 return if !world_writable || HOMEBREW_TEMP.sticky? <<~EOS #{HOMEBREW_TEMP} is world-writable but does not have the sticky bit set. Please execute `sudo chmod +t #{HOMEBREW_TEMP}` in your Terminal. EOS end |
#inject_file_list(list, string) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
65 66 67 68 |
# File 'Library/Homebrew/diagnostic.rb', line 65 def inject_file_list(list, string) list.reduce(string.dup) { |acc, elem| acc << " #{elem}\n" } .freeze end |
#none_string ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
74 75 76 |
# File 'Library/Homebrew/diagnostic.rb', line 74 def none_string "<NONE>" end |
#please_create_pull_requests(what = "unsupported configuration") ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
111 112 113 114 115 116 117 118 |
# File 'Library/Homebrew/diagnostic.rb', line 111 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, Discourse, Twitter or IRC. You are responsible for resolving any issues you experience while you are running this #{what}. EOS end |
#supported_configuration_checks ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
99 100 101 |
# File 'Library/Homebrew/diagnostic.rb', line 99 def supported_configuration_checks [].freeze end |
#user_tilde(path) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
70 71 72 |
# File 'Library/Homebrew/diagnostic.rb', line 70 def user_tilde(path) path.gsub(ENV["HOME"], "~") end |