98 Commits
Author SHA1 Message Date
Patrick Linnane 235beed9f8 docs: update FAQ and troubleshooting pages
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2026-07-18 23:26:37 -07:00
Patrick Linnane 24fb0e8c89 docs/FAQ: clarify brew upgrade handling of self-updating apps.
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2026-07-18 11:26:13 -07:00
Mike McQuaid 9c609523db Rename Homebrew security docs page
- Gives the security guide a URL that targets `homebrew security`.
- Keeps the old supply chain URL working through `redirect_from`.
- Updates internal links while limiting visible text changes.
2026-06-21 13:56:57 +01:00
Mike McQuaid 7c38a5da3b docs: drop advice to disable security or lower support tier
- remove the FAQ section explaining how to bypass Gatekeeper for
  apps from unidentified developers, plus its screenshots
- remove the `pkg allow_untrusted` Cask DSL docs and mark the
  `allow_untrusted` definitions `# odeprecated` as they disable
  certificate verification
- remove "untar anywhere" and "multiple installations" install
  instructions that push users to a non-default prefix and source
  builds, dropping them below Tier 1
2026-06-15 16:41:01 +01:00
Mike McQuaidandGitHub 1f42f25e4f Merge pull request #22657 from Homebrew/docs-supply-chain-security
Add software supply chain security docs
2026-06-11 09:10:37 +00:00
Mike McQuaid 6f0d765be4 Add software supply chain security docs
- explain recent npm and PyPI supply-side incidents and patterns
- contrast Homebrew's reviewed, checksummed, bottled trust model
- note most protections predate the current supply-chain focus
- document mitigations: sandboxing, environment filtering, cooldowns
- note maintainer vetting, inactivity removal and 2FA requirements
- state Homebrew trusts no third-party non-Homebrew repositories
- note tap migrations never move packages out to third-party taps
- note Homebrew does not defer to upstream against users' interests
- explain ephemeral build runners and building from source
- describe the cask trust model and how it compares to upstream
- note bottles are only supported for core and warn off other paths
- explain prioritising security over backwards compatibility
- note layered infrastructure cross-checks and GitHub security features
- explain why Homebrew needs no blanket or double dependency cooldown
- warn about untrusted third-party taps in the interesting taps doc
- record one-sentence-per-line and aligned-table docs Markdown style
- cross-link the new doc from index, Tap Trust and the FAQ
2026-06-11 09:51:48 +01:00
Mike McQuaid 330e98fc7b docs/FAQ: address "rewrite Homebrew in Rust"
- explain why a Rust frontend rewrite was tried and abandoned
- link to the `brew-rs` experiment README for the full story
2026-06-11 09:49:11 +01:00
Mike McQuaid 811ba078c9 Deprecate default opt-ins
- Avoid keeping no-op opt-in flags after their behaviour became
  the default.
- Document the negative switches and environment variables as the
  supported opt-out path.
- Let explicit positive CLI switches override environment opt-outs.
- Add `-y` and `--yes` as ask opt-out aliases.
- Use `--no-ask` in tests that need to opt out.
- Regenerate generated command documentation and completions.
2026-06-09 16:17:45 +01:00
Mike McQuaid 7a07806658 Support pinning casks
- `brew pin` should cover casks now that upgrades skip both package types.
- Cask pin records keep list, info and upgrade output consistent.
- `auto_updates true` casks need a warning because app updaters bypass Homebrew.
2026-05-15 16:33:37 +01:00
Mike McQuaid 8f059a0675 cask: gate auto-updates behind opt-in
- switch `auto_updates true` upgrades to
  `HOMEBREW_UPGRADE_AUTO_UPDATES_CASKS` so users keep the
  current behavior until Homebrew 5.2.0
- keep hidden `HOMEBREW_NO_UPGRADE_AUTO_UPDATES_CASKS`
  support for developer overrides, reject conflicting env
  settings early in `brew upgrade`, and keep
  `HOMEBREW_DEVELOPER` boolean parsing consistent
- ignore bad bundle versions such as `0.0` so broken
  `Info.plist` metadata does not trigger false upgrades
- skip hidden env vars cleanly when generating manpages so
  undocumented entries cannot affect formatting
2026-04-11 08:09:05 +01:00
Mike McQuaid 037696e270 docs: document developer update channel and MCP tools
- `FAQ.md` lacked any explanation of how running a
  developer command changes update behavior (hourly
  instead of daily, tracking `main` instead of tags)
- `MCP-Server.md` only listed user commands; added
  `brew style`, `brew typecheck`, `brew tests` and
  `brew audit` for contributor awareness
2026-04-10 15:54:13 +01:00
Bevan Kay 7efdec2357 docs: reflect new auto_updates behaviour 2026-04-09 12:19:06 +10:00
Mike McQuaid 1afe40ec7b Centralize version-locking docs
- move the supported and unsupported guidance into
  `docs/Versions.md` so users get one consistent answer when
  they want to freeze formula versions
- distinguish the churn-reduction knobs from the
  personal-tap workflows, including `brew pin`,
  `$HOMEBREW_NO_AUTO_UPDATE`, `brew bundle --no-upgrade`,
  `$HOMEBREW_BUNDLE_NO_UPGRADE`,
  `$HOMEBREW_NO_INSTALL_UPGRADE`,
  `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK`,
  `brew version-install`, and `brew extract`
- explain the support boundaries that matter in practice:
  missed security updates, custom tap maintenance, and only
  filing issues after `brew update` when the problem
  reproduces with core formulae
- point the FAQ, tips, bundle, and tap docs at the new
  section so the wording stays aligned as these workflows
  evolve
2026-04-04 11:36:42 +01:00
Mike McQuaid ba3ceb8eb9 Document unsupported multi-user setups
- clarify in `Support-Tiers.md` that shared multi-user
  Homebrew installs are unsupported because Homebrew is
  designed around single-user ownership
- tell users running a Homebrew wrapper to get support from
  that wrapper first unless the issue reproduces without it
- align `FAQ.md` and `Homebrew-on-Linux.md` with this policy
  and remove the old `linuxbrew` role-account guidance
2026-04-03 21:34:58 +01:00
Patrick Linnane 963c93acc2 docs/FAQ: Remove Mountain Lion reference
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2026-01-23 13:00:25 -08:00
Mike McQuaid 84dd40dc2f cmd/version-install: add new command.
This lets people install arbitrary versions by creating their own local non-Git tap if it doesn't already exist and puts formulae in there.
2026-01-18 00:48:38 -07:00
liuxy6 db70c09e1a docs: clarify Homebrew is not recommended for multi-user environments 2026-01-01 17:05:06 -08:00
liuxy6 edaf64bedf docs: fix permissions and privilege explanation in FAQ
* Align multi-user guidance with recommended dedicated brew account
* Correct runtime privileges: no implicit admin rights
2025-12-20 11:23:34 -08:00
sean-freeman bd09ce078a docs: update FAQ with file permissions behavior 2025-10-26 14:10:09 +00:00
Mike McQuaid ffe954753b Prepare for deprecation of --no-quarantine.
We're going to deprecate this in 4.7.0 so let's hide it from the man
page, completions and other documentation until then.
2025-10-23 16:55:20 +01:00
Eric Knibbe de3cebf45c docs: edit various URLs 2025-08-16 23:33:38 -04:00
Eric Knibbe 6a07851c46 docs: localize internal URLs 2025-05-22 12:17:52 -04:00
Patrick Linnane c0f4e11370 docs/FAQ: fix broken link
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2025-05-20 12:37:49 -07:00
Issy Long 8f75f66d01 Review some docs
- Most of these were fine still, apart from:
  - FAQ: `hub` is less maintained than `gh`.
  - Brew-Maintainer-Guide: link to GitHub docs on commit signing via GPG or SSH.
  - Interesting-Taps-and-Forks: remove outdated information about `homebrew/core` being in `Library/Taps`.
  - New-Maintainer-Checklist: remove outdated information about the `@members` team.
2025-02-08 14:43:49 +00:00
Eric Knibbe 29b2f35ce8 docs: prefer /opt/homebrew in examples 2025-02-03 15:30:03 +01:00
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
Leo Heitmann Ruiz 5c515aa679 Add --force to tap instructions 2024-05-19 14:01:29 +02:00
Eric Knibbe 931f762598 docs+rubydoc: various grammar/wording fixes 2023-09-11 02:26:37 -04:00
Eric Knibbe a63cee48e3 docs/FAQ: ensure homebrew/core is downloaded 2023-09-05 00:38:31 -04:00
Eric Knibbe 23f656bf8c docs: localize FAQ images 2023-09-01 00:21:44 -04:00
Amy GraceandMike McQuaid edf022d94e docs: update formula and cask URLs to new sharded format 2023-08-26 14:54:19 +01:00
Eric Knibbe b6c49b7a2d docs: assume core repositories are untapped 2023-07-24 09:55:56 -04:00
Steve Matsumoto fa3bfc796d docs/FAQ: tap homebrew/core before editing formula
New installs don't tap `homebrew/core`, so `brew edit foo` fails with
`Error: Invalid usage: foo doesn't exist on disk.` for any package.
Add an instruction to run `brew tap homebrew/core` first, which fixes
this issue.
2023-07-18 10:32:18 -04:00
Mike McQuaidandGitHub 16234637ca docs/FAQ: tweak wording. 2023-06-27 09:55:52 +01:00
gtnbssnandGitHub 6e9b964125 Explain how to undo brew edit
Add a line explaining how brew update-reset can be used to undo changes users might have made with brew edit.
2023-06-27 10:28:15 +08:00
Mike McQuaidandGitHub 98dd8610ae Tweak code style and documentation wording 2023-05-29 08:59:35 +01:00
JBYoshi f43847516d Add information about App Management permissions to the FAQ. 2023-05-28 14:42:07 -05:00
Ruoyu Zhong 36e78e9558 docs/FAQ: fix HOMEBREW_NO_INSTALL_FROM_API mention
There is no `HOMEBREW_NO_INSTALL_WITH_API`; it should be
`HOMEBREW_NO_INSTALL_FROM_API`.

Signed-off-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2023-02-17 16:51:05 +08:00
c7b8b3a989 docs/FAQ: correct an entry regarding simple formula edit
Co-authored-by: Kevin <apainintheneck@gmail.com>
2023-02-14 12:04:37 +00:00
EricFromCanada 42e91e8668 docs: add Table of Contents to selected pages 2022-12-30 00:45:30 -05:00
EricFromCanada 67f6f29675 docs: section 1 wording/formatting fixes 2022-10-20 09:35:42 -04:00
Watal M. Iwasaki 4e29ed4c17 Restore the remove line, and make it less confusing 2022-07-24 07:53:33 +09:00
Watal M. Iwasaki 975e799969 Remove reference to --enable-bar that does not exist 2022-07-23 18:23:05 +09:00
EricFromCanada 02cb1a14cb Update FAQ.md 2021-12-02 22:59:00 -05:00
EricFromCanada 77efcdf8fb Add & remove line breaks 2021-12-02 22:58:31 -05:00
Carlo Cabrera bf3b12656d FAQ: document HOMEBREW_NO_CLEANUP_FORMULAE 2021-11-26 18:11:35 +08:00
Mike McQuaidandGitHub be7512f71f Update FAQ.md
Note that both brew install and brew upgrade can upgrade seemingly unrelated formulae.
2021-10-09 09:53:56 +01:00
XuehaiPan 3f96d963f7 style: fix inconsistent code style for shell scripts 2021-09-15 14:59:01 +08:00
f76ffa2eaa docs: tweak wording/formatting.
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2021-07-14 14:22:31 +01:00
Mike McQuaid 0a8167d2dc docs: update /usr/local references.
Update or remove these based on our latest state.
2021-07-14 10:11:27 +01:00