82 Commits

Author SHA1 Message Date
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
botantony
da98aca4f3
docs/installation: replace Tips N' Tricks with Tips and Tricks
Signed-off-by: botantony <antonsm21@gmail.com>
2025-04-27 22:43:06 +02:00
Mike McQuaid
04e77dd43d
docs/Tips-and-Tricks: rename from weird filename.
macOS likes the new one better.
2025-04-25 09:46:29 +01:00
Patrick Linnane
e53688c7ce
Installation: Update OCLP note
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2025-04-13 09:55:02 -07:00
Patrick Linnane
76b3cf0334
docs: clarify OCLP support status
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2025-04-12 16:45:44 -07:00
Benjamin Bergman
b378ec91fe
Fix typo in Installation.md 2025-03-14 13:25:21 -05:00
Colin Dean
eab6e9f7f3
Use suggested post-installation steps
Thanks, @jvns!
2025-02-18 12:08:21 -05:00
Colin Dean
1733a78133
Prevent copying w/o reading by removing valid envvars and noting dirs
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2025-02-14 10:25:32 -05:00
Colin Dean
33fde6faec
Lowercases a link fragment to satisfy checks 2025-02-13 15:12:03 -05:00
Colin Dean
1ad0f550b1 Adds post-installation steps to installation with extend version in tips
Inspired by @jvns' [post][1], I realized that I've had this problem on multiple teams, where someone missed the step at the end and didn't know how to recover. Typically, I've provided a version like what I've added to the Tips 'n' Tricks page so that I didn't have to think about what OS-arch pair my users are using.

I've tested the loader added to tips and tricks with both bash and zsh and it passes both shellcheck and shfmt in posix mode.

[1]: https://mastodon.social/@b0rk@jvns.ca/113997565198024027
2025-02-13 19:50:10 +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
Patrick Linnane
1bc1ff9a55
Update docs/Installation.md
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2024-11-12 12:51:28 -08:00
Patrick Linnane
034cdc9ebb
Installation: note that OpenCore is not supported
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-11-12 12:43:09 -08:00
Francois-Xavier Coudert
4ab19e09da
Make Sequoia supported 2024-09-11 09:00:37 +01:00
Brendan Shanks
fced907a63
docs/Installation: Use the documented --strip-components tar argument
`--strip-components` is the documented tar option, `--strip` only works because tar (both BSD and GNU) does partial matching on long options.
2024-05-10 08:39:17 -07:00
Michael Cho
2cbeb10b4a
docs/Installation: use HEAD similar to install repo README.md
Signed-off-by: Michael Cho <michael@michaelcho.dev>
2024-04-15 13:00:30 -04:00
Bo Anderson
2cefdd0284
doc/Installation: make clear the env configs are advanced settings
Co-authored-by: Kevin <apainintheneck@gmail.com>
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-11-29 15:43:22 +00:00
nstrauss
e0ac5459b3
Improve Mac package for enterprise install scenarios
- Allow specifying user through `/var/tmp/.homebrew_pkg_user.plist`
- Improve permission handling
- Correctly write API cache
- Add `preinstall` script to fail if we can't get a valid user

Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-10-06 11:53:00 +01:00
Francois-Xavier Coudert
c3a2c40aa8 Make Sonoma supported 2023-09-24 11:12:05 +02:00
Eric Knibbe
7718c5ad61
docs: improve links & formatting 2023-09-05 00:54:26 -04:00
Issy Long
32bbe6d5de
Ignore <a name= HTML tags on the Installation page in anchor tag linting 2023-09-01 01:01:59 +01:00
Mike McQuaid
1481eac57c
brew.sh: don't set HOMEBREW_NO_INSTALL_FROM_API automatically.
My understanding is that now https://github.com/Homebrew/brew/pull/15778
has been merged this should now work fine on both older macOS versions
and non-default prefixes so let's try this again.
2023-08-15 11:42:02 +01:00
Mike McQuaid
bb67181b50
Merge pull request #15755 from MikeMcQuaid/document_pkg_installer
docs/Installation: document macOS .pkg installer.
2023-07-27 12:03:51 +01:00
Carlo Cabrera
e576fe0062
Revert "brew.sh: don't set HOMEBREW_NO_INSTALL_FROM_API automatically."
https://github.com/Homebrew/brew/pull/15765#issuecomment-1652856355

This reverts commit d9bc51f8171b49486a871a8bb12a2629df28a519.
2023-07-27 11:35:37 +08:00
Mike McQuaid
a6d12c69d2
docs/Installation: document macOS .pkg installer.
While we're here, also make the ARM prefix first.
2023-07-26 15:59:49 +01:00
Mike McQuaid
d9bc51f817
brew.sh: don't set HOMEBREW_NO_INSTALL_FROM_API automatically.
My understanding from conversations with Bo98 is that this should now
work fine on both older macOS versions and non-default prefixes.

Similarly, it's super confusing when this is set automatically and you
can't figure out why...
2023-07-26 15:36:04 +01:00
Eric Knibbe
b6c49b7a2d
docs: assume core repositories are untapped 2023-07-24 09:55:56 -04:00
Mike McQuaid
347934d452
docs/Installation: fix Mac OS X reference.
I shouldn't care but: the only versions where this is required are
Mac OS X versions.
2023-07-18 10:40:55 +01:00
Gabriel Gerlero
c68e060dd4
docs/Installation: Mac OS X -> macOS 2023-07-12 00:13:06 -03:00
Gabriel Gerlero
0e60c80fbf
docs/Installation: fix Apple Developer account link 2023-07-11 18:08:19 -03:00
Mike McQuaid
2a5d41d41b
Revert "Merge pull request #14547 from Homebrew/revert-14412-homebrew_install_from_api_default"
This reverts commit f4e60482791d2ff628efadfdbf0d14d9237d2d29, reversing
changes made to e26784f424061ca16987afcb21e036c66a298492.
2023-02-07 19:25:40 +01:00
Mike McQuaid
0575903868
Revert "HOMEBREW_INSTALL_FROM_API: make the default for everyone." 2023-02-07 15:13:23 +01:00
Mike McQuaid
5f6c69bca2
HOMEBREW_INSTALL_FROM_API: make the default for everyone.
- remove all places we check the flag so it's a no-op now
- flip the messaging to refer to `HOMEBREW_NO_INSTALL_FROM_API` where
  relevant
- adjust the documentation
2023-02-05 18:13:08 +01:00
Mike McQuaid
46fc4f9f1b
Don't allow HOMEBREW_INSTALL_FROM_API when building from source
When either being in a non-default prefix or being on an unsupported
macOS version we expect most things to be built from source. In that
environment, do not allow HOMEBREW_INSTALL_FROM_API to be set.

Fixes #14475
2023-02-02 14:49:34 +00:00
Patrick Linnane
01fa07d08a
Update docs/Installation.md
Co-authored-by: Bo Anderson <mail@boanderson.me>
2022-10-23 08:36:12 -07:00
Patrick Linnane
cc358c2cad
Fix minor version typo 2022-10-22 21:23:44 -07:00
EricFromCanada
67f6f29675
docs: section 1 wording/formatting fixes 2022-10-20 09:35:42 -04:00
Mike McQuaid
53b1c0f48e
Strengthen "don't create issues" language
We're still getting a non-trivial number of issues from configurations
we don't support and don't plan to.

Let people know that we know their experience will not be good and what
to expect if they file issues.

Co-authored-by: Eric Knibbe <enk3@outlook.com>
2022-10-20 11:39:20 +01:00
FX Coudert
8749e19e63
Update docs/Installation.md
Co-authored-by: Sean Molenaar <SMillerDev@users.noreply.github.com>
2022-10-19 11:48:13 +02:00
Francois-Xavier Coudert
e16afb305e Mark macOS Ventura as supported 2022-10-19 11:21:52 +02:00
Kid
71da3760fd
Update docs/Installation.md
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2022-09-18 20:22:30 +08:00
Kid
c2e7679937
Update docs/Installation.md
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2022-09-18 20:22:19 +08:00
Kid
2dba6257ec
docs: document HOMEBREW_INSTALL_FROM_API usage in installation 2022-09-18 19:24:09 +08:00
Mike McQuaid
1bb44979ee
Disable and delete code for 3.5.0
The next planned release will be 3.5.0 so let's fix things up for there.
2022-05-30 14:59:14 +01:00
EricFromCanada
9084cd21b1
Installation.md: add section for non-interactive installation 2022-02-11 09:25:40 -05:00
EricFromCanada
cb9db80157
Update Installation.md 2021-12-02 22:59:00 -05:00
Bo Anderson
c8752c91f0
Mark macOS Monterey as supported. 2021-10-19 16:57:39 +01:00
XuehaiPan
8398be5cde docs/Installation: update commands for untar-anywhere method 2021-09-29 19:59:49 +08:00