2459 Commits

Author SHA1 Message Date
Mike McQuaid
3392226a10
Include more Ruby metadata files
- include `.ruby-version` and in the project root (and unignore in
  `.gitignore`) to improve editor support which expects these files
- use the `.ruby-version` in `docs/Gemfile` to use a consistent Ruby
  version here
- remove hardcoded Ruby versions from `workflows/docs` in favour of
  using the `.ruby-version` file instead
- use more consistent configuration in `workflows/docs` to match
  `workflows/tests`
2024-05-23 16:29:14 +01:00
Patrick Linnane
7362c9c727
docs: clarify upstream taps
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-21 19:00:54 -07:00
BrewTestBot
0243cafdbe
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-05-20 15:36:56 +00:00
Leo Heitmann Ruiz
5c515aa679 Add --force to tap instructions 2024-05-19 14:01:29 +02:00
Mike McQuaid
0c1766510a
env_config: add HOMEBREW_BUNDLE_USER_CACHE.
Used to configure `BUNDLE_USER_CACHE`.
2024-05-18 00:08:42 +09:00
Mike McQuaid
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
Patrick Linnane
97030b7992
Merge pull request #17318 from Homebrew/feat/docs/linux_sandbox 2024-05-16 11:00:59 -07:00
Sean Molenaar
09dcca0f9b
Update Homebrew-on-Linux.md
Co-authored-by: Adrian Ho <the.gromgit@gmail.com>
2024-05-16 20:50:13 +03:00
Sean Molenaar
4072122be1
Update Homebrew-on-Linux.md
Co-authored-by: Patrick Linnane <patrick@linnane.io>
2024-05-16 20:15:19 +03:00
Sean Molenaar
e1ea47a41a
feat: note that Homebrew does not have a sandbox on Linux 2024-05-16 18:32:48 +02:00
Patrick Linnane
773dbfa92a
docs: update for Homebrew/cask-fonts deprecation
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-16 09:21:14 -07:00
Mike McQuaid
a37864da0f
Add HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK
This fits the use-case I've heard multiple times where people want to
rely exclusively on their artifact provider.

Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2024-05-14 21:45:37 +09:00
Eric Knibbe
e1f8b622ff
docs: add webrick gem, generation info 2024-05-13 14:13:07 -04:00
Eric Knibbe
7fa82cccf3
docs: rename README.md to index.md 2024-05-13 14:09:44 -04: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
Mike McQuaid
3d114161b3
Enable HOMEBREW_AUTOREMOVE by autoremove_default
Enabled `HOMEBREW_AUTOREMOVE` by default, and added
`HOMEBREW_NO_AUTOREMOVE` to disable it.

Co-authored-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2024-05-09 13:47:52 +01:00
BrewTestBot
3c2865015d
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-05-07 07:48:54 +00:00
Bevan Kay
a52b179164
docs linting 2024-05-03 23:02:37 +10:00
Bevan Kay
7239bcc04b
docs/cask-cookbook: provide token examples for versioned/development casks 2024-05-03 22:54:07 +10:00
Patrick Linnane
92a43a6465
Cask-Cookbook: remove outdated URL
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-02 17:13:20 -07:00
Patrick Linnane
e4f7618545
docs: update for Homebrew/cask-versions deprecation
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-02 14:40:07 -07:00
Razvan Azamfirei
4f6f6cea52
documentation: remove homebrew/cask-versions 2024-05-02 17:07:55 -04:00
Markus Reiter
480e264d9a
Lint Ruby docs. 2024-05-01 11:35:21 +02:00
BrewTestBot
3c0240b6c0
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-30 14:33:46 +00:00
Mike McQuaid
4ffcd8a110
Various improvements for brew command
- Add a (large) speedup by moving some logic to Bash for the typical
  case of a normal or dev-cmd, Bash or Ruby command.
- Make `brew command` a non-developer command, I don't think it makes
  sense to consider it something needed for developing Homebrew.
- Update the manpage/tests/RBI accordingly.

Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2024-04-30 11:38:19 +01:00
mohawk2
cba3943ade
Cookbook document what Operation not permitted means 2024-04-29 14:30:15 +01:00
BrewTestBot
61c6295fd5
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-26 18:23:27 +00:00
Mike McQuaid
28c3215dba
analytics: support command and test-bot analytics.
These are used to analyse which commands are used and the
success/failure rate of official taps using `brew test-bot`.
2024-04-25 17:38:04 +01:00
Mike McQuaid
378c71d805
Merge pull request #17139 from Homebrew/cmd-docs
Update External-Commands docs for new command abstraction
2024-04-24 08:49:37 +01:00
Mike McQuaid
e9b668df35
docs/External-Commands: fix spelling.
Co-authored-by: Kevin <apainintheneck@gmail.com>
2024-04-24 08:40:00 +01:00
BrewTestBot
20ea418356
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-24 00:05:51 +00:00
Douglas Eichelberger
5772ba12b4 Update External-Commands docs for new command abstraction 2024-04-23 14:53:22 -07:00
Mike McQuaid
966454c97d
Merge pull request #17125 from Homebrew/brew-list-manual-auto
cmd/list: support listing formulae installed on request or automatically
2024-04-23 09:10:37 +01:00
Ruoyu Zhong
0084791616
Update manpage and completions 2024-04-23 15:57:15 +08:00
BrewTestBot
9deefb4b17
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-23 07:30:48 +00:00
BrewTestBot
0e01fd5865
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-22 12:38:11 +00:00
Ruoyu Zhong
a6268a19d6
Update manpage and completions 2024-04-22 12:01:46 +08:00
Issy Long
073e739005
Use the debug gem from portable Ruby
- This is cleaner than vendoring a whole bunch of new gems and pinning `psych`.
- Thanks for the pointer, Bo!
- It doesn't work, though?

```
❯ brew tests --only=migrator --debug
Error: cannot load such file -- debug/debug.so
Warning: Removed Sorbet lines from backtrace!
Rerun with `--verbose` to see the original backtrace
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug/frame_info.rb:16:in `require'
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug/frame_info.rb:16:in `rescue in <module:DEBUGGER__>'
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug/frame_info.rb:13:in `<module:DEBUGGER__>'
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug/frame_info.rb:3:in `<top (required)>'
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug/session.rb:31:in `require_relative'
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug/session.rb:31:in `<top (required)>'
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug.rb:3:in `require_relative'
/opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/lib/ruby/gems/3.1.0/gems/debug-1.6.3/lib/debug.rb:3:in `<top (required)>'
/opt/homebrew/Library/Homebrew/dev-cmd/tests.rb:48:in `require'
/opt/homebrew/Library/Homebrew/dev-cmd/tests.rb:48:in `run'
/opt/homebrew/Library/Homebrew/brew.rb:89:in `<main>'
```
2024-04-17 23:26:40 +01:00
Issy Long
11c1960729
Remove byebug since it doesn't work in tests anymore
- Byebug was introduced in [2020](https://github.com/Homebrew/brew/pull/7577) for hooking into tests for debugging.
- It does not work anymore in so far as it does not stop at breakpoints when following the instructions to trigger them in tests.
2024-04-17 22:24:21 +01:00
Carlo Cabrera
2548b75132
Merge pull request #17099 from Homebrew/sponsors-maintainers-man-completions 2024-04-18 00:59:55 +08:00
Ruoyu Zhong
c98629560d
Update manpage and completions 2024-04-18 00:47:05 +08:00
BrewTestBot
8feae3645a
Update maintainers.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-17 16:40:30 +00:00
Ruoyu Zhong
135db8c559
Update manpage and completions 2024-04-17 06:15:18 +08:00
Ruoyu Zhong
d6d1b7d4e9
Update manpage and completions 2024-04-17 03:37:42 +08:00
BrewTestBot
3951cfe347
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-16 00:05:54 +00: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
Michael Cho
89a3ecda15
docs(Python): reapply suggestions and update outdated info
* Reapply dropped commit in https://github.com/Homebrew/brew/pull/16643
* Change bindings example as `protobuf` no longer has any
* Remove `name "foo"` in example
* Replace `Language::Python.setup_install_args` example with `pip`
* Add some hints for CMake and autotools scripts given common issue of
  incorrect Python selection due to allowing multiple Python deps
* Add note that `.pth` files should be avoided due to contamination

Co-authored-by: Eric Knibbe <enk3@outlook.com>
Signed-off-by: Michael Cho <michael@michaelcho.dev>
2024-04-14 21:42:25 -04:00
BrewTestBot
00ac453d2e
Update manpage and completions.
Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-04-12 14:53:39 +00:00
Issy Long
4f85192a6b
Merge pull request #17074 from Homebrew/envconfig-alphabetize
Alphabetize `EnvConfig::ENVS`
2024-04-11 20:33:34 +01:00
Issy Long
dd5ea99f58
Alphabetize EnvConfig::ENVS and regenerate docs 2024-04-11 17:58:08 +01:00