77 Commits

Author SHA1 Message Date
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 Grace
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 McQuaid
16234637ca
docs/FAQ: tweak wording. 2023-06-27 09:55:52 +01:00
gtnbssn
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 McQuaid
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
Sanjito Kurniawan
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 McQuaid
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
Mike McQuaid
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
Michael Cho
b44ecaceb7
docs: fix cask doc urls to use docs.brew.sh 2021-06-25 13:20:40 -07:00
Mike McQuaid
d73351251c
Deprecate, disable, delete code for next major/minor version.
Do the usual dance for bumping our major/minor version.
2021-04-09 09:30:36 +01:00
Sean Molenaar
0aed1fc62e
Docs: Migrate casks FAQ 2021-02-09 13:11:45 +01:00
Shaun Jackman
ef755182bb
Merge pull request #9279 from sjackman/sj/fq-linux
FAQ: Default installation prefix on Linux
2020-11-27 11:30:20 -08:00
Shaun Jackman
ab1b313378 Revise docs/FAQ.md 2020-11-27 10:32:05 -08:00
Shaun Jackman
ac7cb8ca6c
Revise docs/FAQ.md
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2020-11-27 10:29:27 -08:00
Shaun Jackman
c3c8c7c668 Revise docs/FAQ.md 2020-11-26 10:28:02 -08:00
Shaun Jackman
8846779d83
Revise docs/FAQ.md
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2020-11-26 10:17:14 -08:00
Shaun Jackman
85a7947956 FAQ: Why specifically /home/linuxbrew/.linuxbrew 2020-11-25 16:18:14 -08:00
Jonathan Chang
d90c34ef51 docs: explain why upgrade upgrades unrelated stuff 2020-11-25 17:46:10 +11:00
Shaun Jackman
a4cfe9d651 Revise docs/FAQ.md 2020-11-24 13:58:08 -08:00
Shaun Jackman
a89dc612bc
Revise docs/FAQ.md
Co-authored-by: Issy Long <issyl0@github.com>
2020-11-24 13:54:19 -08:00
Shaun Jackman
66dccb3b14 FAQ: Default installation prefix on Linux
Why does Homebrew on Linux recommend that I install to
/home/linuxbrew/.linuxbrew?
2020-11-24 10:43:05 -08:00
Jonathan Chang
c68bf84e21 docs: update FAQ with current Homebrew behavior 2020-09-09 19:21:22 +10:00
Mike McQuaid
ac0665daff
Refer to default branch in links with HEAD
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 11:38:40 +01:00
Peter Lewis
68fc0398ca
'Why haven’t you pulled my pull request?' change
I propose changing 'Why haven’t you pulled my pull request?' to 'Why haven’t you merged my pull request?' as, unless I'm missing a trick, this wording would fit more appropriately with what the question trying to ask?
2020-06-22 17:08:27 +01:00
Mike McQuaid
6e60d3fb59
docs: point to homebrew/install repository.
This saves duplicating the (un)install instructions in multiple places.
2020-04-15 16:16:21 +01:00
Issy Long
d43aba643d
FAQ: Replace Max's pronoun with his name
- For some reason, the documented way of disabling a style for a
  specific section of Markdown text[1] didn't work for disabling the
  pronoun lint here. This is about the only place we have a legitimate
  need for it. Instead, sadly, squash this linting error by using his
  name.
- Also adjust the sentence for further clarity in light of this.

[1] - https://errata-ai.github.io/vale/config/#ignoring-parts-of-your-documents
2019-12-18 16:09:06 +00:00
Mike McQuaid
a6115f8bb4
FAQ: update cleanup text. 2019-07-28 15:22:18 +01:00
James Cuzella
d8caacde95
Update FAQ entry: Homebrew automatic brew cleanup behavior change 2019-07-03 14:37:46 -06:00
Mike McQuaid
eed1444d61
Update deprecations and cleanup
- Move `odeprecated` to `odisabled`
- Remove `odisabled`
- Enable automatic cleanup on install/reinstall/upgrade.
2019-01-23 21:57:40 +00:00