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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[email protected]: tweak EXTERNALLY-MANAGED guidance #165681

Merged

Conversation

woodruffw
Copy link
Member

  • Have you followed the guidelines for contributing?
  • Have you ensured that your commits follow the commit style guide?
  • Have you checked that there aren't other open pull requests for the same formula update/change?
  • Have you built your formula locally with HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>, where <formula> is the name of the formula you're submitting?
  • Is your test running fine brew test <formula>, where <formula> is the name of the formula you're submitting?
  • Does your build pass brew audit --strict <formula> (after doing HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>)? If this is a new formula, does it pass brew audit --new <formula>?

Per https://github.com/orgs/Homebrew/discussions/3404#discussioncomment-8724311: this tweaks the EXTERNALLY-MANAGED marker on Python 3.12:

  • Elaborates the virtual environment example a bit
  • Documents the --break-system-packages escape hatch as something expert users can do

Wording feedback greatly appreciated 馃檪

@woodruffw
Copy link
Member Author

NB: I haven't marked a rebuild or anything else here, not sure if it's worth it. I figure the next patch/bugfix release can send this out as well.

Copy link
Member

@colindean colindean left a comment

Choose a reason for hiding this comment

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

Avoiding the multiple dash adjective lengthens the message but makes it clearer in a few places, plus some indicators of key text and commands would make it easier to read, methinks.

Formula/p/[email protected] Outdated Show resolved Hide resolved
Formula/p/[email protected] Outdated Show resolved Hide resolved
Formula/p/[email protected] Outdated Show resolved Hide resolved
Formula/p/[email protected] Outdated Show resolved Hide resolved
Formula/p/[email protected] Outdated Show resolved Hide resolved
@github-actions github-actions bot added the autosquash Automatically squash pull request commits according to Homebrew style. label Mar 10, 2024
@woodruffw woodruffw force-pushed the ww/externally-managed-tweaks branch from 4422fe5 to fd8237c Compare March 10, 2024 20:59
@Bo98 Bo98 added CI-skip-dependents Pass --skip-dependents to brew test-bot. CI-no-bottles Merge without publishing bottles labels Mar 10, 2024
Comment on lines 410 to 413
Expert users may restore the old behavior of pip by passing
the '--break-system-packages' flag to pip, or by adding
'break-system-packages = true' to their pip.conf file. The latter
will permanently disable this warning.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe worth mentioning that it's strongly recommended to also pass/set --user to avoid the risk of brew link errors if you happen to install something brew ships.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, good catch -- I think this should only mention the --user case, since any other case is likely to break Homebrew + we strongly want to discourage anyways. I'll update today!

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated, PTAL! Also fixed the use of second person to be consistent with the rest of the error.

Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@woodruffw woodruffw force-pushed the ww/externally-managed-tweaks branch from b78fa67 to 6e68ac8 Compare March 12, 2024 00:39
@github-actions github-actions bot removed the autosquash Automatically squash pull request commits according to Homebrew style. label Mar 12, 2024
Copy link
Member

@colindean colindean left a comment

Choose a reason for hiding this comment

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

Looking good 馃憤

@BrewTestBot BrewTestBot added this pull request to the merge queue Mar 12, 2024
Merged via the queue into Homebrew:master with commit 7d5ffc0 Mar 12, 2024
22 checks passed
@BrewTestBot BrewTestBot deleted the ww/externally-managed-tweaks branch March 12, 2024 05:31
@github-actions github-actions bot added the outdated PR was locked due to age label Apr 11, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CI-no-bottles Merge without publishing bottles CI-skip-dependents Pass --skip-dependents to brew test-bot. outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants