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
Colin Dean
80f201f9ee
Adds caching proxy example using HOMEBREW_ARTIFACT_DOMAIN
...
I brought this up several months ago and got a solution working that's been running on my work machine since early September without failure.
2025-01-22 00:34:37 -05:00
Michael Cho
a548a81040
docs: remove references to deprecated/disabled GCC formulae
2024-09-02 12:03:06 -04:00
Matthew Heller
c7653f5570
Apply suggestions from code review
...
Update instructions: Append to the file from the shell, and fix permissions if on macOS Intel.
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-10-10 12:00:50 -05:00
Matthew Heller
26ee0bade1
Local linter didn't care about newline at EOF but CI did care...
2023-10-10 01:55:32 -05:00
Matthew Heller
29b43e1dc9
Fixes for the linter.
2023-10-10 01:52:31 -05:00
Matthew Heller
95b19823b7
Tips-N'-Tricks: homebrew.man.conf for Terminal.app
...
Add instructions for fixing Terminal.app's "Open man Page" command by creating homebrew.man.conf.
2023-10-10 01:23:54 -05:00
Eric Knibbe
43c8fec557
docs: mark console output appropriately
2023-09-11 02:26:37 -04:00
Eric Knibbe
931f762598
docs+rubydoc: various grammar/wording fixes
2023-09-11 02:26:37 -04:00
Eric Knibbe
110e14937b
docs/Tips: add bundle, --adopt, VS Code plugins
2023-09-05 00:46:55 -04:00
Jeffrey Cafferata
fd5e6e3e47
Docs: Removed the Atom editor plugin because GitHub has archived the Atom project(s).
2023-03-01 15:55:44 +01:00
Rory O’Kane
21cb80cdc4
In Tips and Tricks doc, expand -s flag
...
Writing the long flag here helps the user understand what the command does. The short flag is more appropriate for interactive use of `brew`.
2022-03-03 18:00:56 -05:00
EricFromCanada
fd0ae2bd5c
Update Tips-N'-Tricks.md
2021-11-16 09:31:29 -05:00
EricFromCanada
c1531cd7b3
Add line breaks & indentation
2021-11-16 09:26:29 -05:00
XuehaiPan
3f96d963f7
style: fix inconsistent code style for shell scripts
2021-09-15 14:59:01 +08: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
Mike McQuaid
caae165eb2
Improve brew install --quiet
...
- Suppress (some more) warnings when doing `brew install --quiet`
- Clarify `man brew` output that we don't suppress all warnings
for all commands with `--quiet`
While I was doing this I noticed references to the (soon to be
deprecated) `brew switch` so:
- remove these references in `install` output
- remove a reference in the documentation
- add a comment to remind me to deprecate `brew diy`, too
Fixes #9179
2020-11-18 10:13:57 +00:00
Mike McQuaid
2e5272d04c
Deprecate/disable code for Homebrew 2.5.0.
...
Do the usual "disable deprecations" and "uncomment pending deprecations"
dance and delete/deprecate/disable relevant/related code.
2020-09-03 10:34:22 +01:00
Mike McQuaid
9a654897d4
manpage: no longer mention installing from a URL.
...
This is deprecated in #7660 .
2020-05-29 17:04:42 +01:00
Mike McQuaid
170c5493a4
Update deprecations
...
- Add some `odeprecated`
- Make some `odeprecated` now `odisabled`
- Remove `odisabled` code.
- Remove old update migrations
- Remove GCC 4.0 compiler
- Remove Tiger-only code
- Remove 32-bit-only code
- Remove use of LD64
- Remove GCC 4.3 - 4.8 support.
2019-01-08 19:13:46 +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
c1376f9f18
docs: various updates.
...
I read through the docs locally and made various fixes.
2018-09-06 15:07:00 +01:00
Mike McQuaid
190e665bb1
Revert "docs: use short links."
...
This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a.
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
022303f96c
Unify proxy documentation.
...
Specify under the list of environment variables how to set each of those
that we passthrough and use.
2017-11-30 14:05:06 +00: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
ca0071ffc9
Grammar fixes for docs
...
Fixes to spelling and punctuation for consistency and readability.
2017-02-23 12:20:07 -05:00
Mike McQuaid
a3bffe70bc
Use docs.brew.sh links.
2017-01-04 11:13:41 +00:00
Mike McQuaid
127e9def50
Cleanup documentation site
...
GitHub now nicely generates a documentation site for us at
http://brew.sh/brew based on our docs folder. Optimise the output of
this and the GitHub docs directory for readability and the various user
groupings.
2017-01-04 10:53:21 +00:00
Mike McQuaid
bc0aa4e64c
Add versions documentation.
2017-01-03 18:01:03 +00:00
Mike McQuaid
91c09c5b11
General documentation updates.
...
Mostly related to the newer ways we’re handling versions and the
incoming deprecation of devel-only, head-only and versions.
2017-01-02 18:29:00 +00:00
kaihaosw
30779c3283
add pcmpl-homebrew for homebrew emacs plugin
2016-09-27 15:33:39 +08:00
Mike McQuaid
b85ee1cb8f
Update documentation links.
2016-09-20 10:41:42 +01:00
Mike McQuaid
bd6fb88ddc
Rearrange repository files.
2016-09-20 10:41:42 +01:00
