Skip to content
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.

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

docs: improve some $(brew --prefix) usage #14738

Merged
merged 2 commits into from Feb 21, 2023
Merged

docs: improve some $(brew --prefix) usage #14738

merged 2 commits into from Feb 21, 2023

Conversation

aristocrates
Copy link
Contributor

Intended change: for brew docs https://docs.brew.sh/Homebrew-and-Python#python-3y to say $(brew --prefix python)/libexec/bin instead of $(brew --prefix)/opt/python/libexec/bin in order to be more robust to edge cases from package installation issues.

brew --prefix python errors out when the python package is not installed, so using that instead of brew --prefix prevents python package installation issues from silently breaking, for example, shell env scripts that add this to $PATH.

See https://github.com/orgs/Homebrew/discussions/3596#discussioncomment-5050569

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

aristocrates and others added 2 commits February 20, 2023 16:28
brew --prefix python errors out when the python package is not
installed, so using that instead of brew --prefix prevents python
package installation issues from silently breaking, for example, shell
env scripts that add this to $PATH.

See https://github.com/orgs/Homebrew/discussions/3596#discussioncomment-5050569
The new form used to be slow but both are now fast.
@MikeMcQuaid
Copy link
Member

Thanks so much for your first contribution! Without people like you submitting PRs we couldn't run this project. You rock, @aristocrates!

I fixed up a few more references in here too. Nothing wrong with your work, just wanted to do this before I forgot.

@MikeMcQuaid MikeMcQuaid changed the title Improve unversioned python location specification docs: improve some $(brew --prefix) usage Feb 21, 2023
@MikeMcQuaid MikeMcQuaid merged commit 059945a into Homebrew:master Feb 21, 2023
@aristocrates aristocrates deleted the patch-1 branch February 22, 2023 03:58
@github-actions github-actions bot added the outdated PR was locked due to age label Mar 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants