Skip to content

doc: add note about brew doctor #18070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
fanquake merged 1 commit into from
Feb 20, 2020
Merged

doc: add note about brew doctor #18070

fanquake merged 1 commit into from
Feb 20, 2020

Conversation

@givanse
Copy link
Contributor

@givanse givanse commented Feb 5, 2020

A trivial documentation update.

When I was following the build steps for mac, I had some errors installing the dependencies. After searching on the Internet, and correcting the errors, I found that brew doctor had all the answers I needed. Could have skipped the Internet searches all together.

@fanquake fanquake added the Docs label Feb 5, 2020
@givanse givanse changed the title [doc] add note about brew doctor doc: add note about brew doctor Feb 5, 2020
@fanquake
Copy link
Member

fanquake commented Feb 5, 2020

I'm not sure this needs to be in our documentation, as it's general to brew.

@laanwj
Copy link
Member

laanwj commented Feb 5, 2020

Thanks for contributing, but in addition to what @fanquake says I think this is not specific enough for documentation "some issues" "some ideas". You might want to add what kind of issues, and what kind of suggestions.

@givanse
Copy link
Contributor Author

givanse commented Feb 5, 2020 •
edited
Loading

A specific problem I had, that seems general enough, was that I was missing a couple of folders in my system. The original error I got was:

==> Pouring python-3.7.6_1.catalina.bottle.tar.gz
Error: An unexpected error occurred during the `brew link` step
The formula built, but is not symlinked into /usr/local
Permission denied @ dir_s_mkdir - /usr/local/Frameworks
Error: Permission denied @ dir_s_mkdir - /usr/local/Frameworks

In hindsight, it does show an issue with trying to create one of the folders. I didn't catch that initially.

The fix is:

sudo mkdir -p /usr/local/Frameworks /usr/local/sbin
sudo chown -R $(whoami) /usr/local/Frameworks /usr/local/sbin

It seems like anyone who has never installed some of the dependencies before will run into this hiccup. Would it be worth to preemptively ask everyone to:

sudo mkdir ...
sudo chown ...
brew install ...

?

@dongcarl
Copy link
Contributor

dongcarl commented Feb 5, 2020

I understand that the initial setup of Homebrew can be confusing to some... Here's an alternative idea: link to Homebrew's troubleshooting page, which will be more updated on the latest best practices.

fanquake
fanquake approved these changes Feb 20, 2020
View reviewed changes
Copy link
Member

@fanquake fanquake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 63ce882 - a link to the troubleshooting page seems fine. I wouldn't really want our README to have anything more specific than that.

@fanquake fanquake merged commit eb3c6b0 into bitcoin:master Feb 20, 2020
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Feb 22, 2020
@fanquake
Merge bitcoin#18070: doc: add note about brew doctor
c801245 
63ce882 doc: link to homebrew's troubleshooting page (Gastón I. Silva)

Pull request description:

  A trivial documentation update.

  When I was following the build steps for mac, I had some errors installing the dependencies. After searching on the Internet, and correcting the errors, I found that `brew doctor` had all the answers I needed. Could have skipped the Internet searches all together.

ACKs for top commit:
  fanquake:
    ACK 63ce882 - a link to the troubleshooting page seems fine. I wouldn't really want our README to have anything more specific than that.

Tree-SHA512: 12c96cd9c9bd39ada21f3f27cbec3ed4bef4b8e74dec7872c892fc6a92a70418a5cc0882ff449883e91d96c01e1ca7104b076590917f397334c82931ec7fda1c
@fanquake fanquake mentioned this pull request Feb 28, 2020
Closed
@MarkLTZ MarkLTZ mentioned this pull request Apr 4, 2020
Closed
@givanse givanse deleted the documentation branch September 6, 2020 22:35
sidhujag pushed a commit to syscoin-core/syscoin that referenced this pull request Nov 10, 2020
@fanquake
Merge bitcoin#18070: doc: add note about brew doctor
18742ee 
63ce882 doc: link to homebrew's troubleshooting page (Gastón I. Silva)

Pull request description:

  A trivial documentation update.

  When I was following the build steps for mac, I had some errors installing the dependencies. After searching on the Internet, and correcting the errors, I found that `brew doctor` had all the answers I needed. Could have skipped the Internet searches all together.

ACKs for top commit:
  fanquake:
    ACK 63ce882 - a link to the troubleshooting page seems fine. I wouldn't really want our README to have anything more specific than that.

Tree-SHA512: 12c96cd9c9bd39ada21f3f27cbec3ed4bef4b8e74dec7872c892fc6a92a70418a5cc0882ff449883e91d96c01e1ca7104b076590917f397334c82931ec7fda1c
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@fanquake fanquake fanquake approved these changes

Assignees

No one assigned

Labels

Docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@givanse @fanquake @laanwj @dongcarl