mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
brew/docs/Troubleshooting.md
Issy Long 31d7bcc583
Add a last_reviewed_date to docs metadata 
- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
  documentation, so that we can periodically implement a review
  mechanism (GitHub Actions posts to Slack for a regular documentation
  outdatedness check?) to track how old docs are and ensure they're
  still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
  to the metadata of all docs with a date of earlier than Homebrew's
  inception because everything needs reviewing so that we start from a
  good base!
2025-02-03 11:56:07 +00:00

2.4 KiB
Raw Blame History

last_review_date
last_review_date
1970-01-01

Troubleshooting

Run brew update twice and brew doctor (and fix all the warnings) before creating an issue!

This document will help you check for common issues and make sure your issue has not already been reported.

Check for common issues

Check to see if the issue has been reported

Create an issue

If your problem hasn't been solved or reported, then create an issue:

  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.
  • If your have a non-formula problem: collect the output of brew config and brew doctor.
  1. Create a new issue on the issue tracker for Homebrew/homebrew-core, Homebrew/homebrew-cask or Homebrew/brew 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.