admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/share/doc/homebrew/Troubleshooting.md
Mike McQuaid b745546943 Overhaul, simplify and cleanup documentation. 
Remove duplication, link to the API documentation more often,
tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s
and `@adamv`'s significant past contributions to Homebrew, delete some
outdated or unneeded documentation, add some missing `Formula` API.
entries and simplify/improve `CONTRIBUTING.md`.

Closes Homebrew/homebrew#46179.

Closes Homebrew/homebrew#46618.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-07 13:37:49 +00:00

2.0 KiB
Raw Blame History

Troubleshooting

Run brew update (twice) and brew doctor before creating an issue!

When creating a formula-related issue please include the link output by running:

brew gist-logs <formula>

Check for common issues

  • Run brew update (twice).
  • Run brew doctor and fix all the warnings (outdated Xcode/CLT and unbrewed dylibs are very likely to cause problems).
  • Read through the Common Issues.
  • If you’re installing something Java-related, maybe you need to install Java (brew cask install java)?
  • Check that Command Line Tools for Xcode (CLT) and/or Xcode are up to date.
  • If things fail with permissions errors, check the permissions in /usr/local. If you’re unsure what to do, you can sudo chown -R $(whoami) /usr/local.
  • If you see permission errors after upgrading to El Capitan please see the El Capitan and Homebrew document.

Check to see if the issue has been reported

  • Check the issue tracker to see if someone else has already reported the same issue.
  • Make sure you check issues on the correct repository. If the formula that failed to build is part of a tap like homebrew/science or homebrew/dupes check there instead.

Create an issue

  1. Upload debugging information to a Gist:
  • If you had a formula error: run brew gist-logs <formula> (where <formula> is the name of the formula that failed to build).
  • If you encountered a non-formula bug: upload the output of brew config and brew doctor to a new Gist.
  1. Create a new issue titled "<formula name> failed to build on 10.x", where <formula name> is the name of the formula that failed to build, and 10.x is the version of OS X you are using and including the link output by `brew gist-logs