diff options
| author | Mike McQuaid | 2016-09-19 19:58:21 +0100 |
|---|---|---|
| committer | Mike McQuaid | 2016-09-20 10:41:42 +0100 |
| commit | bd6fb88ddc72a0de4c27f65e60a82790a5d87f3f (patch) | |
| tree | 4a40854293dc41c0184f5532583a864712aa5b8c /docs/Troubleshooting.md | |
| parent | f87e3626bb241bc88bead4ed6448a76c1bf49f56 (diff) | |
| download | brew-bd6fb88ddc72a0de4c27f65e60a82790a5d87f3f.tar.bz2 | |
Rearrange repository files.
Diffstat (limited to 'docs/Troubleshooting.md')
| -rw-r--r-- | docs/Troubleshooting.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md new file mode 100644 index 000000000..4fc77d6cd --- /dev/null +++ b/docs/Troubleshooting.md @@ -0,0 +1,26 @@ +# 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: + +```shell +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](Common-Issues.md). +* 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 of `/usr/local`'s subdirectories. If you’re unsure what to do, you can `cd /usr/local && sudo chown -R $(whoami) bin etc include lib sbin share var Frameworks`. + +## Check to see if the issue has been reported +* Check the [issue tracker](https://github.com/Homebrew/homebrew-core/issues) 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](https://github.com/Homebrew/homebrew-science) or [homebrew/dupes](https://github.com/Homebrew/homebrew-dupes) check there instead. + +## Create an issue +0. Upload debugging information to a [Gist](https://gist.github.com): + - 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](https://gist.github.com). +1. [Create a new issue](https://github.com/Homebrew/homebrew-core/issues/new) 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 macOS you are using and including the link output by `brew gist-logs` |