admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Update Troubleshooting.md

Browse Source
This commit is contained in:
EricFromCanada 2021-08-25 13:05:35 -04:00
parent b71644e735
commit a237699936
No known key found for this signature in database
GPG Key ID: 179D9CDDDB814168
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/Troubleshooting.md
View File

@ -6,25 +6,26 @@ This document will help you check for common issues and make sure your issue has
## Check for common issues
* Read through the [Common Issues](Common-Issues.md).
* Read through the list of [Common Issues](Common-Issues.md).
## Check to see if the issue has been reported
* Search the [Homebrew/homebrew-core issue tracker](https://github.com/Homebrew/homebrew-core/issues) to see if someone else has already reported the same issue.
* If a formula that has failed to build is part of a non-core tap or a cask is part of [homebrew/cask](https://github.com/Homebrew/homebrew-cask/issues) check those issue trackers instead.
* Search the [Homebrew discussion forum](https://github.com/homebrew/discussions/discussions) or [Discourse](https://discourse.brew.sh/) to see if any discussions have started about the issue.
* Search the appropriate issue tracker to see if someone else has already reported the same issue:
* [Homebrew/homebrew-core issue tracker](https://github.com/Homebrew/homebrew-core/issues) (formulae)
* [Homebrew/homebrew-cask issue tracker](https://github.com/Homebrew/homebrew-cask/issues) (casks)
* [Homebrew/brew issue tracker](https://github.com/Homebrew/brew/issues) (`brew` itself)
* If the formula or cask that has failed to install is part of a non-Homebrew tap, then check that tap's issue tracker instead.
* Search the [Homebrew discussion forum](https://github.com/homebrew/discussions/discussions) or [Discourse archive](https://discourse.brew.sh/) to see if any discussions have started about the issue.
## Create an issue
If your problem hasn't been solved or reported, then create an issue:
1. Upload debugging information to a [Gist](https://gist.github.com):
1. Collect debugging information:
* If you have a problem with installing a formula: run `brew gist-logs <formula>` (where `<formula>` is the name of the formula) to upload the logs to a new [Gist](https://gist.github.com).
* If your have a non-formula problem: collect the output of `brew config` and `brew doctor`.
* If you had a formula-related problem: run `brew gist-logs <formula>` (where `<formula>` is the name of the formula).
* If you encountered a non-formula problem: upload the output of `brew config` and `brew doctor` to a new [Gist](https://gist.github.com).
2. Create a new issue on the [Homebrew/homebrew-core issue tracker](https://github.com/Homebrew/homebrew-core/issues/new/choose)
* Give your issue a descriptive title which includes the formula name (if applicable) and the version of macOS or Linux you are using. For example, if a formula fails to build, title your issue "\<formula> failed to build on \<10.x>", where "\<formula>" is the name of the formula that failed to build, and "\<10.x>" is the version of macOS or Linux you are using.
* Include the URL output by `brew gist-logs <formula>` (if applicable).
* Include links to any additional Gists you may have created (such as for the output of `brew config` and `brew doctor`).
1. Create a new issue on the issue tracker for [Homebrew/homebrew-core](https://github.com/Homebrew/homebrew-core/issues/new/choose), [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask/issues/new/choose) or [Homebrew/brew](https://github.com/Homebrew/brew/issues/new/choose) and follow the instructions:
* Give your issue a descriptive title which includes the formula name (if applicable) and the version of macOS or Linux you are using. For example, if a formula fails to build, title your issue "\<formula> failed to build on \<platform>", where "\<formula>" is the name of the formula that failed to build, and "\<platform>" is the name and version of macOS or Linux you are using.
* Include the URL provided by `brew gist-logs <formula>` (if applicable) plus links to any additional Gists you may have created.
* Include the output of `brew config` and `brew doctor`.