51 Commits
Author SHA1 Message Date
Patrick Linnane 7e7be2706b docs: address review comments on troubleshooting pages
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2026-07-19 09:00:21 -07:00
Patrick Linnane 3ae9785494 docs/Common-Issues: write the migration snapshot to an explicit path
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2026-07-18 23:41:22 -07:00
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
Mike McQuaid 594fcc12ce Allow binary installs without developer tools
- enable FFI quarantine, xattr copying and Trash operations for all
  cask users instead of invoking Swift
- remove the completed developer rollout gates, TODOs and obsolete
  Swift helper scripts
- drop the relocated-bottle tools check now that ruby-macho performs
  ad-hoc signing without `codesign`
- keep developer tools fatal for source builds and document the
  supported-installation requirement
- report quarantine as unavailable on generic and unsupported
  platforms instead of raising

Fixes #23029
2026-07-14 14:58:00 +01:00
Mike McQuaid 0a137ee80b Preserve cask quarantine approval
- Avoid repeated Gatekeeper prompts by inheriting approval only when
  the new app satisfies the old app's designated requirement.
- Preserve quarantine provenance and validate identities through
  Security.framework without invoking `codesign`.
- Keep relocated bottles on the current `codesign` path; link its
  eventual removal to `Homebrew/ruby-macho#997` pure-Ruby signing.
- Keep `release!` for explicit no-quarantine downloads and remove the
  FFI rollout TODOs only after their trials are complete.
2026-07-11 16:11:35 +01:00
Branch Vincent ef90c54409 docs: remove references to removed setup_install_args 2026-07-10 18:59:32 -07:00
Sean Molenaar 173a4827a7 Update issue links in docs to use correct template 2026-07-06 15:13:05 +02:00
rohan436 6c811218ba docs: fix Common Issues typo 2026-03-09 17:28:28 +08:00
Eric Knibbe de3cebf45c docs: edit various URLs 2025-08-16 23:33:38 -04:00
Mike McQuaid d661cffc1f Switch to using main as the default branch
Homebrew/brew has moved to a `main` default branch so we can more move
references from `master` to `main`.
2025-06-24 11:14:57 +01:00
Eric Knibbe 6a07851c46 docs: localize internal URLs 2025-05-22 12:17:52 -04:00
Mike McQuaid 7a57af242e Cleanup some missing references to Homebrew Bundle.
Let's just call it `brew bundle` from now on as it's a normal command.

Also, fix a reference to "Homebrew Services" while we're here.
2025-03-19 09:51:39 +00:00
Mike McQuaidandGitHub 689fb13299 docs/Common-Issues: fix style. 2025-03-18 08:43:51 +00:00
Mike McQuaidandGitHub e81794c96a docs/Common-Issues: tweak wording. 2025-03-18 08:41:25 +00:00
NeimadTL 7c23b7aa4a Add possible curl issues
This new part of documentation has been added in order to provide
users a way to identify curl related issues which may or may not be
caused by their workstation.
2025-03-17 19:29:39 -04: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
Mike McQuaidandCarlo Cabrera 7073258a6a Speed up brew list
Similarly to have we have with other commands, use Bash to speed it up.

Before:
```
$ hyperfine "brew list"
Benchmark 1: brew list
  Time (mean ± σ):     559.9 ms ± 122.8 ms    [User: 176.2 ms, System: 126.2 ms]
  Range (min … max):   503.2 ms … 907.3 ms    10 runs
```

After:
```
$ hyperfine "brew list"
Benchmark 1: brew list
  Time (mean ± σ):     223.7 ms ±  31.9 ms    [User: 35.0 ms, System: 53.4 ms]
  Range (min … max):   198.1 ms … 302.4 ms    10
```

Petty after comparison because someone on Homebrew/discussions compared
them:
```
$ hyperfine "brew list" "pip3 list"
Benchmark 1: brew list
  Time (mean ± σ):     213.1 ms ±  22.8 ms    [User: 34.2 ms, System: 49.2 ms]
  Range (min … max):   191.2 ms … 272.3 ms    13 runs

Benchmark 2: pip3 list
  Time (mean ± σ):     271.7 ms ±   4.6 ms    [User: 191.9 ms, System: 40.0 ms]
  Range (min … max):   264.7 ms … 281.4 ms    10 runs

Summary
  brew list ran
    1.28 ± 0.14 times faster than pip3 list
```

---

While we're here, also add the `HOMEBREW_CASKROOM` environment variable
to make things a bit cleaner and use `--caskroom` in documentation.

Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2024-05-17 12:38:16 +09:00
Colin DeanandGitHub 60c778c3e1 docs: Common-Issues: eliminate unnecessary list reference 2024-02-16 11:04:55 -05:00
455d0eb764 Apply suggestions from code review
Co-authored-by: Eric Knibbe <enk3@outlook.com>
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2024-02-16 10:54:12 -05:00
Colin DeanandGitHub 32d0d333a6 Update Common-Issues.md: One last attempt at whitespace fixes
…before I drop into a codespace to fight mdl
2024-02-15 17:13:51 -05:00
eba4121bf1 Apply suggestions from code review
Co-authored-by: Patrick Linnane <patrick@linnane.io>
2024-02-15 17:06:14 -05:00
Colin DeanandGitHub 417fbd69f6 Update Common-Issues.md: Fixes whitespace 2024-02-15 14:18:48 -05:00
Colin DeanandGitHub 9b340b3c99 Common-Issues: Documents resolving dual installations from Migration Assistant copies
This is an extract and refactor of the linked Discussions post from @gromgit.
2024-02-15 14:05:40 -05:00
Eric Knibbe 9372edf38f docs: re-case titles 2023-09-11 02:26:37 -04:00
Amy GraceandMike McQuaid edf022d94e docs: update formula and cask URLs to new sharded format 2023-08-26 14:54:19 +01:00
EricFromCanada 42e91e8668 docs: add Table of Contents to selected pages 2022-12-30 00:45:30 -05:00
EricFromCanada 9cc4766d33 docs: hyperlink updates
plus some reformatting
2022-12-06 12:52:03 -05:00
EricFromCanada 67f6f29675 docs: section 1 wording/formatting fixes 2022-10-20 09:35:42 -04:00
EricFromCanada bbac622d1b docs: mention "path not in the working tree" error 2022-10-20 09:14:33 -04:00
neutricandGitHub 07e813a3b3 docs/Common-Issues.md: fix variable notation 2021-12-27 03:06:37 +01:00
Sean Molenaar 820e8303df docs: add common cask issues 2021-12-22 17:20:24 +01:00
EricFromCanada 2e3bc0b4a3 Update Common-Issues.md 2021-12-02 22:58:56 -05:00
EricFromCanada 77efcdf8fb Add & remove line breaks 2021-12-02 22:58:31 -05:00
XuehaiPan 3f96d963f7 style: fix inconsistent code style for shell scripts 2021-09-15 14:59:01 +08:00
Mike McQuaid b3603b5de8 docs/Common-Issues: remove Oxford comma.
Not sure why CI didn't catch this the first time.
2021-05-05 10:08:21 +01:00
6837f9c039 Update docs/Common-Issues.md
I think this is a substantial improvement and does what I hoped, helps folks help themselves if--say--they just want to get emacs working; next time they'll have the technique in their pocket too.

Co-authored-by: Rylan Polster <rslpolster@gmail.com>
2021-04-01 15:51:00 -04:00
cacologyandGitHub 341904099b Correct sentence spacing 2021-02-13 15:21:56 -05:00
James P. Ascher ef393db926 reinstallation instructions for build failures 2021-02-13 14:37:54 -05:00
Mike McQuaid 1aa8ad09e2 Deprecate macOS versions below Mavericks
And remove all dead/unneeded code.
2019-01-27 12:27:47 +00:00
EricFromCanada 31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
Mike McQuaid 190e665bb1 Revert "docs: use short links."
This reverts commit e63a2ee8de.

Closes #3832.
2018-02-23 19:52:00 +00:00
Mike McQuaid e63a2ee8de docs: use short links. 2018-02-22 19:25:44 +00:00
Mike McQuaid 977c3323d2 docs.brew.sh updates
- Remove no longer needed `acme-challenge` file
- Set title, description, social image, logo, etc. for SEO
- Use extensionless permalinks (old links still work)
- Cleanup `_config.yml`
- Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
Mike McQuaid baa61f5a6e Use https for all docs.brew.sh links.
May as well use the more secure link when possible.
2017-07-27 15:59:37 +01:00
EricFromCanada dc7f74210a docs: code example reformatting
Add labeled fences to most code blocks, monospace terms where
appropriate, omit "$" when referring to variables
2017-03-25 22:53:33 -04:00
EricFromCanada ab4d1a1574 docs: grammar edits, sentence-case secondary headings
Also changes some heading levels so only one primary
heading appears per page.
2017-03-19 14:03:39 -04:00
EricFromCanada 20bb0aae80 Fix broken or inactive URLs
Bare URLs are auto-linked on GitHub but not on docs.brew.sh, so I added
angle brackets around them where appropriate. Also converted
Markdown-linked URLs for clarity.
2017-02-23 12:09:01 -05:00
Jonathan Chang 9a6cd9b83f docs: fix titles on docs.brew.sh 2017-01-04 16:16:00 -06:00
Mike McQuaid b85ee1cb8f Update documentation links. 2016-09-20 10:41:42 +01:00