Class: Homebrew::Diagnostic::Checks

Inherits:
Object
  • Object
show all
Defined in:
Library/Homebrew/diagnostic.rb,
Library/Homebrew/extend/os/mac/diagnostic.rb

Instance Method Summary collapse

Instance Method Details

#__check_linked_brew(f) ⇒ Object 



804
805
806
807
808
809
810
811
812
813
814
 
# File 'Library/Homebrew/diagnostic.rb', line 804

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, white_list, message) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'Library/Homebrew/diagnostic.rb', line 150

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

  files = Dir.chdir(dir) do
    (Dir.glob(pattern) - Dir.glob(white_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

#all ⇒ Object 



1099
1100
1101
 
# File 'Library/Homebrew/diagnostic.rb', line 1099

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

#build_error_checks ⇒ Object 



87
88
89
90
 
# File 'Library/Homebrew/diagnostic.rb', line 87

def build_error_checks
  (development_tools_checks + %w[
  ]).freeze
end

#check_access_cache ⇒ Object 



391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'Library/Homebrew/diagnostic.rb', line 391

def check_access_cache
  return unless HOMEBREW_CACHE.exist?
  return if HOMEBREW_CACHE.writable_real?

  <<~EOS
    #{HOMEBREW_CACHE} isn't writable.
    This can happen if you run `brew install` or `brew fetch` as another user.
    Homebrew caches downloaded files to this location.

    You should change the ownership and permissions of #{HOMEBREW_CACHE}
    back to your user .
      sudo chown -R $(whoami) #{HOMEBREW_CACHE}
  EOS
end

#check_access_cellar ⇒ Object 



406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'Library/Homebrew/diagnostic.rb', line 406

def check_access_cellar
  return unless HOMEBREW_CELLAR.exist?
  return if HOMEBREW_CELLAR.writable_real?

  <<~EOS
    #{HOMEBREW_CELLAR} isn't writable.

    You should change the ownership and permissions of #{HOMEBREW_CELLAR}
    back to your user .
      sudo chown -R $(whoami) #{HOMEBREW_CELLAR}
  EOS
end

#check_access_homebrew_repository ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
 
# File 'Library/Homebrew/diagnostic.rb', line 310

def check_access_homebrew_repository
  return if HOMEBREW_REPOSITORY.writable_real?

  <<~EOS
    #{HOMEBREW_REPOSITORY} is not writable.

    You should change the ownership and permissions of #{HOMEBREW_REPOSITORY}
    back to your user .
      sudo chown -R $(whoami) #{HOMEBREW_REPOSITORY}
  EOS
end

#check_access_lock_dir ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'Library/Homebrew/diagnostic.rb', line 363

def check_access_lock_dir
  return unless HOMEBREW_LOCK_DIR.exist?
  return if HOMEBREW_LOCK_DIR.writable_real?

  <<~EOS
    #{HOMEBREW_LOCK_DIR} isn't writable.
    Homebrew writes lock files to this location.

    You should change the ownership and permissions of #{HOMEBREW_LOCK_DIR}
    back to your user .
      sudo chown -R $(whoami) #{HOMEBREW_LOCK_DIR}
  EOS
end

#check_access_logs ⇒ Object 



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'Library/Homebrew/diagnostic.rb', line 377

def check_access_logs
  return unless HOMEBREW_LOGS.exist?
  return if HOMEBREW_LOGS.writable_real?

  <<~EOS
    #{HOMEBREW_LOGS} isn't writable.
    Homebrew writes debugging logs to this location.

    You should change the ownership and permissions of #{HOMEBREW_LOGS}
    back to your user .
      sudo chown -R $(whoami) #{HOMEBREW_LOGS}
  EOS
end

#check_access_prefix_directories ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'Library/Homebrew/diagnostic.rb', line 322

def check_access_prefix_directories
  not_writable_dirs = []

  Keg::ALL_TOP_LEVEL_DIRECTORIES.each do |dir|
    path = HOMEBREW_PREFIX/dir
    next unless path.exist?
    next if path.writable_real?
    not_writable_dirs << path
  end

  return if not_writable_dirs.empty?

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

    This can happen if you "sudo make install" software that isn't managed
    by Homebrew. If a formula tries to write a file to this directory, the
    install will fail during the link step.

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

#check_access_site_packages ⇒ Object 



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'Library/Homebrew/diagnostic.rb', line 347

def check_access_site_packages
  return unless Language::Python.homebrew_site_packages.exist?
  return if Language::Python.homebrew_site_packages.writable_real?

  <<~EOS
    #{Language::Python.homebrew_site_packages} isn't writable.
    This can happen if you "sudo pip install" software that isn't managed
    by Homebrew. If you install a formula with Python modules, the install
    will fail during the link step.

    You should change the ownership and permissions of #{Language::Python.homebrew_site_packages}
    back to your user account.
      sudo chown -R $(whoami) #{Language::Python.homebrew_site_packages}
  EOS
end

#check_brew_git_origin ⇒ Object 



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'Library/Homebrew/diagnostic.rb', line 733

def check_brew_git_origin
  return if !Utils.git_available? || !(HOMEBREW_REPOSITORY/".git").exist?

  origin = HOMEBREW_REPOSITORY.git_origin

  if origin.nil?
    <<~EOS
      Missing Homebrew/brew git origin remote.

      Without a correctly configured origin, Homebrew won't update
      properly. You can solve this by adding the Homebrew remote:
        git -C "#{HOMEBREW_REPOSITORY}" remote add origin #{Formatter.url("https://github.com/Homebrew/brew.git")}
    EOS
  elsif origin !~ %r{Homebrew/brew(\.git|/)?$}
    <<~EOS
      Suspicious Homebrew/brew git origin remote found.

      With a non-standard origin, Homebrew won't pull updates from
      the main repository. The current git origin is:
        #{origin}

      Unless you have compelling reasons, consider setting the
      origin remote to point at the main repository by running:
        git -C "#{HOMEBREW_REPOSITORY}" remote set-url origin #{Formatter.url("https://github.com/Homebrew/brew.git")}
    EOS
  end
end

#check_build_from_source ⇒ Object 



101
102
103
104
105
106
107
108
109
110
 
# File 'Library/Homebrew/diagnostic.rb', line 101

def check_build_from_source
  return unless ENV["HOMEBREW_BUILD_FROM_SOURCE"]

  <<~EOS
    You have HOMEBREW_BUILD_FROM_SOURCE set. This environment variable is
    intended for use by Homebrew developers. If you are encountering errors,
    please try unsetting this. Please do not file issues if you encounter
    errors when using this environment variable.
  EOS
end

#check_clt_minimum_version ⇒ Object 



119
120
121
122
123
124
125
126
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 119

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 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 80

def check_clt_up_to_date
  return unless MacOS::CLT.outdated?

  # Travis 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 provider
  # Homebrew/brew is currently using.
  return if ENV["TRAVIS"]

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

#check_coretap_git_origin ⇒ Object 



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'Library/Homebrew/diagnostic.rb', line 761

def check_coretap_git_origin
  coretap_path = CoreTap.instance.path
  return if !Utils.git_available? || !(coretap_path/".git").exist?

  origin = coretap_path.git_origin

  if origin.nil?
    <<~EOS
      Missing #{CoreTap.instance} git origin remote.

      Without a correctly configured origin, Homebrew won't update
      properly. You can solve this by adding the Homebrew remote:
        git -C "#{coretap_path}" remote add origin #{Formatter.url("https://github.com/Homebrew/homebrew-core.git")}
    EOS
  elsif origin !~ %r{Homebrew/homebrew-core(\.git|/)?$}
    return if ENV["CI"] && origin.include?("Homebrew/homebrew-test-bot")

    <<~EOS
      Suspicious #{CoreTap.instance} git origin remote found.

      With a non-standard origin, Homebrew won't pull updates from
      the main repository. The current git origin is:
        #{origin}

      Unless you have compelling reasons, consider setting the
      origin remote to point at the main repository by running:
        git -C "#{coretap_path}" remote set-url origin #{Formatter.url("https://github.com/Homebrew/homebrew-core.git")}
    EOS
  end

  return if ENV["CI"]

  branch = coretap_path.git_branch
  return if branch.nil? || branch =~ /master/

  <<~EOS
    Homebrew/homebrew-core is not on the master branch

    Check out the master branch by running:
      git -C "$(brew --repo homebrew/core)" checkout master
  EOS
end

#check_dyld_vars ⇒ Object 



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

def check_dyld_vars
  dyld_vars = ENV.keys.grep(/^DYLD_/)
  return if dyld_vars.empty?

  values = dyld_vars.map { |var| "#{var}: #{ENV.fetch(var)}" }
  message = inject_file_list values, <<~EOS
    Setting DYLD_* vars can break dynamic linking.
    Set variables:
  EOS

  if dyld_vars.include? "DYLD_INSERT_LIBRARIES"
    message += <<~EOS

      Setting DYLD_INSERT_LIBRARIES can cause Go builds to fail.
      Having this set is common if you use this software:
        #{Formatter.url("https://asepsis.binaryage.com/")}
    EOS
  end

  message
end

#check_filesystem_case_sensitive ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 300

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

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.



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

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-available
    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_curl ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 252

def check_for_bad_curl
  return unless MacOS.version <= "10.8"
  return if Formula["curl"].installed?

  <<~EOS
    The system curl on 10.8 and below is often incapable of supporting
    modern secure connections & will fail on fetching formulae.

    We recommend you:
      brew install curl
  EOS
end

#check_for_bad_install_name_tool ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 170

def check_for_bad_install_name_tool
  return if MacOS.version < "10.9"

  libs = Pathname.new("/usr/bin/install_name_tool").dynamically_linked_libraries

  # otool may not work, for example if the Xcode license hasn't been accepted yet
  return if libs.empty?
  return if libs.include? "/usr/lib/libxcselect.dylib"

  <<~EOS
    You have an outdated version of /usr/bin/install_name_tool installed.
    This will cause binary package installations to fail.
    This can happen if you install osx-gcc-installer or RailsInstaller.
    To restore it, you must reinstall macOS or restore the binary from
    the OS packages.
  EOS
end

#check_for_bad_python_symlink ⇒ Object 



957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'Library/Homebrew/diagnostic.rb', line 957

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_beta_xquartz ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 288

def check_for_beta_xquartz
  return unless MacOS::XQuartz.version.to_s.include?("beta")

  <<~EOS
    The following beta release of XQuartz is installed: #{MacOS::XQuartz.version}

    XQuartz beta releases include address sanitization, and do not work with
    all software; notably, wine will not work with beta releases of XQuartz.
    We recommend only installing stable releases of XQuartz.
  EOS
end

#check_for_broken_symlinks ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'Library/Homebrew/diagnostic.rb', line 282

def check_for_broken_symlinks
  broken_symlinks = []

  Keg::PRUNEABLE_DIRECTORIES.each do |d|
    next unless d.directory?
    d.find do |path|
      if path.symlink? && !path.resolved_path_exists?
        broken_symlinks << path
      end
    end
  end
  return if broken_symlinks.empty?

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

#check_for_config_scripts ⇒ Object 



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'Library/Homebrew/diagnostic.rb', line 566

def check_for_config_scripts
  return unless HOMEBREW_CELLAR.exist?
  real_cellar = HOMEBREW_CELLAR.realpath

  scripts = []

  whitelist = %W[
    /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 whitelist.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 what 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_enthought_python ⇒ Object 



910
911
912
913
914
915
916
917
918
919
 
# File 'Library/Homebrew/diagnostic.rb', line 910

def check_for_enthought_python
  return unless which "enpkg"

  <<~EOS
    Enthought Python was found in your PATH.
    This can cause build problems, as this software installs its own
    copies of iconv and libxml2 into directories that are picked up by
    other build systems.
  EOS
end

#check_for_external_cmd_name_conflict ⇒ Object 



1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'Library/Homebrew/diagnostic.rb', line 1049

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 following places:
    EOS
  end

  message
end

#check_for_gettext ⇒ Object 



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'Library/Homebrew/diagnostic.rb', line 512

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
  homebrew_owned = @found.all? do |path|
    Pathname.new(path).realpath.to_s.start_with? "#{HOMEBREW_CELLAR}/gettext"
  end
  return if gettext&.linked_keg&.directory? && homebrew_owned

  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 



704
705
706
707
708
709
710
711
712
713
 
# File 'Library/Homebrew/diagnostic.rb', line 704

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 



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'Library/Homebrew/diagnostic.rb', line 536

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 



92
93
94
95
96
97
98
99
 
# File 'Library/Homebrew/diagnostic.rb', line 92

def check_for_installed_developer_tools
  return if DevelopmentTools.installed?

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

#check_for_large_cache ⇒ Object 



838
839
840
841
842
843
844
845
846
847
848
 
# File 'Library/Homebrew/diagnostic.rb', line 838

def check_for_large_cache
  return unless HOMEBREW_CACHE.exist?
  # CI can be expected to have a large cache.
  return if ENV["CI"]
  cache_size = HOMEBREW_CACHE.disk_usage
  return unless cache_size > 2_147_483_648
  <<~EOS
    Your HOMEBREW_CACHE is using #{disk_usage_readable(cache_size)} of disk space.
    You may wish to consider running `brew cleanup`.
  EOS
end

#check_for_library_python ⇒ Object 



921
922
923
924
925
926
927
928
929
930
931
 
# File 'Library/Homebrew/diagnostic.rb', line 921

def check_for_library_python
  return unless File.exist?("/Library/Frameworks/Python.framework")

  <<~EOS
    Python is installed at /Library/Frameworks/Python.framework

    Homebrew only supports building against the System-provided Python or a
    brewed Python. In particular, Pythons installed to /Library can interfere
    with other software installs.
  EOS
end

#check_for_linked_keg_only_brews ⇒ Object 



816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'Library/Homebrew/diagnostic.rb', line 816

def check_for_linked_keg_only_brews
  return unless HOMEBREW_CELLAR.exist?

  linked = Formula.installed.sort.select do |f|
    f.keg_only? && __check_linked_brew(f)
  end
  return if linked.empty?

  inject_file_list linked.map(&:full_name), <<~EOS
    Some keg-only formula are linked into the Cellar.
    Linking a keg-only formula, such as gettext, into the cellar with
    `brew link <formula>` will cause other formulae to detect them during
    the `./configure` step. This may cause problems when compiling those
    other formulae.

    Binaries provided by keg-only formulae may override system binaries
    with other strange results.

    You may wish to `brew unlink` these brews:
  EOS
end

#check_for_multiple_volumes ⇒ Object 



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'Library/Homebrew/diagnostic.rb', line 656

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" environmental variable to a suitable
    directory on the same volume as your Cellar.
  EOS
end

#check_for_non_prefixed_coreutils ⇒ Object 



970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'Library/Homebrew/diagnostic.rb', line 970

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
  return
end

#check_for_non_prefixed_findutils ⇒ Object 



984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'Library/Homebrew/diagnostic.rb', line 984

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
  return
end

#check_for_old_homebrew_share_python_in_path ⇒ Object 



933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'Library/Homebrew/diagnostic.rb', line 933

def check_for_old_homebrew_share_python_in_path
  message = ""
  ["", "3"].map do |suffix|
    next unless paths.include?((HOMEBREW_PREFIX/"share/python#{suffix}").to_s)
    message += <<~EOS
      #{HOMEBREW_PREFIX}/share/python#{suffix} is not needed in PATH.
    EOS
  end
  unless message.empty?
    message += <<~EOS

      Formerly homebrew put Python scripts you installed via `pip` or `pip3`
      (or `easy_install`) into that directory above but now it can be removed
      from your PATH variable.
      Python scripts will now install into #{HOMEBREW_PREFIX}/bin.
      You can delete anything, except 'Extras', from the #{HOMEBREW_PREFIX}/share/python
      (and #{HOMEBREW_PREFIX}/share/python3) dir and install affected Python packages
      anew with `pip install --upgrade`.
    EOS
  end

  message unless message.empty?
end

#check_for_osx_gcc_installer ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 137

def check_for_osx_gcc_installer
  return unless MacOS.version < "10.7" || ((MacOS::Xcode.version || "0") > "4.1")
  return unless DevelopmentTools.clang_version == "2.1"

  fix_advice = if MacOS.version >= :mavericks
    "Please run `xcode-select --install` to install the CLT."
  elsif MacOS.version >= :lion
    "Please install the CLT or Xcode #{MacOS::Xcode.latest_version}."
  else
    "Please install Xcode #{MacOS::Xcode.latest_version}."
  end

  <<~EOS
    You seem to have osx-gcc-installer installed.
    Homebrew doesn't support osx-gcc-installer. It causes many builds to fail and
    is an unlicensed distribution of really old Xcode files.
    #{fix_advice}
  EOS
end

#check_for_other_frameworks ⇒ Object 



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'Library/Homebrew/diagnostic.rb', line 850

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 likely
    cause the build to fail. To compile CMake, you may wish to move these
    out of the way:
  EOS
end

#check_for_other_package_managers ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 188

def check_for_other_package_managers
  ponk = MacOS.macports_or_fink
  return if ponk.empty?

  <<~EOS
    You have MacPorts or Fink installed:
      #{ponk.join(", ")}

    This can cause trouble. You don't have to uninstall them, but you may want to
    temporarily move them out of the way, e.g.

      sudo mv /opt/local ~/macports
  EOS
end

#check_for_pth_support ⇒ Object 



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'Library/Homebrew/diagnostic.rb', line 1031

def check_for_pth_support
  homebrew_site_packages = Language::Python.homebrew_site_packages
  return unless homebrew_site_packages.directory?
  return if Language::Python.reads_brewed_pth_files?("python") != false
  return unless Language::Python.in_sys_path?("python", homebrew_site_packages)

  user_site_packages = Language::Python.user_site_packages "python"
  <<~EOS
    Your default Python does not recognize the Homebrew site-packages
    directory as a special site-packages directory, which means that .pth
    files will not be followed. This means you will not be able to import
    some modules after installing them with Homebrew, like wxpython. To fix
    this for the current user, you can run:
      mkdir -p #{user_site_packages}
      echo 'import site; site.addsitedir("#{homebrew_site_packages}")' >> #{user_site_packages}/homebrew.pth
  EOS
end

#check_for_pydistutils_cfg_in_home ⇒ Object 



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'Library/Homebrew/diagnostic.rb', line 999

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_developer_directory ⇒ Object 



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

def check_for_stray_developer_directory
  # if the uninstaller script isn't there, it's a good guess neither are
  # any troublesome leftover Xcode files
  uninstaller = Pathname.new("/Developer/Library/uninstall-developer-folder")
  return unless ((MacOS::Xcode.version || "0") >= "4.3") && uninstaller.exist?

  <<~EOS
    You have leftover files from an older version of Xcode.
    You should delete them using:
      #{uninstaller}
  EOS
end

#check_for_stray_dylibs ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'Library/Homebrew/diagnostic.rb', line 163

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.
  white_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", white_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 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'Library/Homebrew/diagnostic.rb', line 263

def check_for_stray_headers
  white_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", white_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 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'Library/Homebrew/diagnostic.rb', line 242

def check_for_stray_las
  white_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", white_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 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'Library/Homebrew/diagnostic.rb', line 222

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.
  white_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", white_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 



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
 
# File 'Library/Homebrew/diagnostic.rb', line 195

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.
  white_list = [
    "libsecurity_agent_client.a", # OS X 10.8.2 Supplemental Update
    "libsecurity_agent_server.a", # OS X 10.8.2 Supplemental Update
    "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", white_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 



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'Library/Homebrew/diagnostic.rb', line 637

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 formula install to locations that are mapped on top of each
    other during the linking step.
  EOS
end

#check_for_tap_ruby_files_locations ⇒ Object 



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'Library/Homebrew/diagnostic.rb', line 1076

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 



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'Library/Homebrew/diagnostic.rb', line 1010

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_unsupported_macos ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 32

def check_for_unsupported_macos
  return if ARGV.homebrew_developer?

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

  <<~EOS
    You are using macOS #{MacOS.version}.
    #{who} do not provide support for this #{what}.
    You may encounter build failures or other breakages.
    Please create pull-requests instead of filing issues.
  EOS
end

#check_git_newline_settings ⇒ Object 



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'Library/Homebrew/diagnostic.rb', line 715

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 



895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'Library/Homebrew/diagnostic.rb', line 895

def check_git_status
  return unless Utils.git_available?
  HOMEBREW_REPOSITORY.cd do
    return if `git status --untracked-files=all --porcelain -- Library/Homebrew/ 2>/dev/null`.chomp.empty?
  end

  <<~EOS
    You have uncommitted modifications to Homebrew
    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 #{HOMEBREW_LIBRARY} && git stash && git clean -d -f
  EOS
end

#check_git_version ⇒ Object 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'Library/Homebrew/diagnostic.rb', line 688

def check_git_version
  # https://help.github.com/articles/https-cloning-errors
  return unless Utils.git_available?
  return unless Version.create(Utils.git_version) < Version.create("1.8.5")

  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 1.8.5 or newer is required to perform checkouts over HTTPS from GitHub and
    to support the 'git -C <path>' option.
    Please upgrade:
      brew #{git_upgrade_cmd} git
  EOS
end

#check_homebrew_prefix ⇒ Object 



333
334
335
336
337
338
339
340
341
342
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 333

def check_homebrew_prefix
  return if HOMEBREW_PREFIX.to_s == "/usr/local"

  <<~EOS
    Your Homebrew's prefix is not /usr/local.
    You can install Homebrew anywhere you want but some bottles (binary packages)
    can only be used with a /usr/local prefix and some formulae (packages)
    may not build correctly with a non-/usr/local prefix.
  EOS
end

#check_if_xcode_needs_clt_installed ⇒ Object 



128
129
130
131
132
133
134
135
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 128

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_missing_deps ⇒ Object 



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

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



419
420
421
422
423
424
425
426
427
428
429
 
# File 'Library/Homebrew/diagnostic.rb', line 419

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_path_for_trailing_slashes ⇒ Object

See github.com/Homebrew/legacy-homebrew/pull/9986



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

def check_path_for_trailing_slashes
  bad_paths = PATH.new(ENV["HOMEBREW_PATH"]).select { |p| p.end_with?("/") }
  return if bad_paths.empty?

  inject_file_list bad_paths, <<~EOS
    Some directories in your path end in a slash.
    Directories in your path should not end in a slash. This can break other
    doctor checks. The following directories should be edited:
  EOS
end

#check_ruby_version ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 203

def check_ruby_version
  ruby_version = "2.3.3"
  return if RUBY_VERSION == ruby_version
  return if ARGV.homebrew_developer? && OS::Mac.prerelease?

  <<~EOS
    Ruby version #{RUBY_VERSION} is unsupported on #{MacOS.version}. Homebrew
    is developed and tested on Ruby #{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_ssl_cert_file ⇒ Object 



625
626
627
628
629
630
631
632
633
634
635
 
# File 'Library/Homebrew/diagnostic.rb', line 625

def check_ssl_cert_file
  return unless ENV.key?("SSL_CERT_FILE")
  <<~EOS
    Setting SSL_CERT_FILE can break downloading files; if that happens
    you should unset it before running Homebrew.

    Homebrew uses the system curl which uses system certificates by
    default. Setting SSL_CERT_FILE makes it use an outdated OpenSSL, which
    does not support modern OpenSSL certificate stores.
  EOS
end

#check_tmpdir ⇒ Object 



869
870
871
872
873
874
875
876
 
# File 'Library/Homebrew/diagnostic.rb', line 869

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

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

#check_tmpdir_sticky_bit ⇒ Object 



300
301
302
303
304
305
306
307
308
 
# File 'Library/Homebrew/diagnostic.rb', line 300

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_user_curlrc ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'Library/Homebrew/diagnostic.rb', line 497

def check_user_curlrc
  curlrc_found = %w[CURL_HOME HOME].any? do |var|
    ENV[var] && File.exist?("#{ENV[var]}/.curlrc")
  end
  return unless curlrc_found

  <<~EOS
    You have a curlrc file
    If you have trouble downloading packages with Homebrew, then maybe this
    is the problem? If the following command doesn't work, then try removing
    your curlrc:
      curl #{Formatter.url("https://github.com")}
  EOS
end

#check_user_path_1 ⇒ Object 



431
432
433
434
435
436
437
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
464
465
466
467
468
469
470
 
# File 'Library/Homebrew/diagnostic.rb', line 431

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
            This means that system-provided programs will be used instead of those
            provided by Homebrew. The following tools exist at both paths:
          EOS

          message += <<~EOS

            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")}
          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_2 ⇒ Object 



472
473
474
475
476
477
478
479
480
 
# File 'Library/Homebrew/diagnostic.rb', line 472

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 



482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'Library/Homebrew/diagnostic.rb', line 482

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? && !sbin.children.empty?

  <<~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_which_pkg_config ⇒ Object 



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 344

def check_which_pkg_config
  binary = which "pkg-config"
  return if binary.nil?

  mono_config = Pathname.new("/usr/bin/pkg-config")
  if mono_config.exist? && mono_config.realpath.to_s.include?("Mono.framework")
    <<~EOS
      You have a non-Homebrew 'pkg-config' in your PATH:
        /usr/bin/pkg-config => #{mono_config.realpath}

      This was most likely created by the Mono installer. `./configure` may
      have problems finding brew-installed packages using this other pkg-config.

      Mono no longer installs this file as of 3.0.4. You should
      `sudo rm /usr/bin/pkg-config` and upgrade to the latest version of Mono.
    EOS
  elsif binary.to_s != "#{HOMEBREW_PREFIX}/bin/pkg-config"
    <<~EOS
      You have a non-Homebrew 'pkg-config' in your PATH:
        #{binary}

      `./configure` may have problems finding brew-installed packages using
      this other pkg-config.
    EOS
  end
end

#check_xcode_8_without_clt_on_el_capitan ⇒ Object 



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

def check_xcode_8_without_clt_on_el_capitan
  return unless MacOS::Xcode.without_clt?
  # Scope this to Xcode 8 on El Cap for now
  return unless MacOS.version == :el_capitan
  return unless MacOS::Xcode.version >= "8"

  <<~EOS
    You have Xcode 8 installed without the CLT;
    this causes certain builds to fail on OS X El Capitan (10.11).
    Please install the CLT via:
      sudo xcode-select --install
  EOS
end

#check_xcode_license_approved ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 265

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` =~ /license/ && !$CHILD_STATUS.success?

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

#check_xcode_minimum_version ⇒ Object 



109
110
111
112
113
114
115
116
117
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 109

def check_xcode_minimum_version
  return unless MacOS::Xcode.below_minimum_version?

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

#check_xcode_prefix ⇒ Object 



216
217
218
219
220
221
222
223
224
225
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 216

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 



227
228
229
230
231
232
233
234
235
236
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 227

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 



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 238

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 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 53

def check_xcode_up_to_date
  return unless MacOS::Xcode.outdated?

  # Travis 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 provider
  # Homebrew/brew is currently using.
  return if ENV["TRAVIS"]

  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.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_xquartz_up_to_date ⇒ Object 



277
278
279
280
281
282
283
284
285
286
 
# File 'Library/Homebrew/extend/os/mac/diagnostic.rb', line 277

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 cask reinstall xquartz
  EOS
end

#development_tools_checks ⇒ Object

END HELPERS



76
77
78
79
80
 
# File 'Library/Homebrew/diagnostic.rb', line 76

def development_tools_checks
  %w[
    check_for_installed_developer_tools
  ].freeze
end

#fatal_development_tools_checks ⇒ Object 



82
83
84
85
 
# File 'Library/Homebrew/diagnostic.rb', line 82

def fatal_development_tools_checks
  %w[
  ].freeze
end

#find_relative_paths(*relative_paths) ⇒ Object

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



65
66
67
68
69
 
# File 'Library/Homebrew/diagnostic.rb', line 65

def find_relative_paths(*relative_paths)
  @found = [HOMEBREW_PREFIX, "/usr/local"].uniq.inject([]) 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 



71
72
73
 
# File 'Library/Homebrew/diagnostic.rb', line 71

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