admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid 2b363b904c
brew.sh: cache HOMEBREW_VERSION on disk. 
This is a (relatively, for this Bash script) expensive operation that
can be trivially cached so: let's do so.

Speedup on my machine:

```
$ hyperfine "brew --version" "HOMEBREW_VERSION_CACHE=1 brew --version"
Benchmark 1: brew --version
  Time (mean ± σ):     173.4 ms ±   5.1 ms    [User: 28.7 ms, System: 67.0 ms]
  Range (min … max):   167.3 ms … 182.9 ms    15 runs

Benchmark 2: HOMEBREW_VERSION_CACHE=1 brew --version
  Time (mean ± σ):     145.9 ms ±   4.0 ms    [User: 22.4 ms, System: 33.9 ms]
  Range (min … max):   140.0 ms … 154.5 ms    17 runs

Summary
  HOMEBREW_VERSION_CACHE=1 brew --version ran
    1.19 ± 0.05 times faster than brew --version
```

Co-authored-by: Bo Anderson <mail@boanderson.me>
2024-05-14 15:46:32 +09:00
..
.bundle
…
api
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cask
Merge pull request #17265 from krehel/cask-font-fixes
2024-05-10 16:59:48 +01:00
cli
cli/named_args: address review feedback
2024-05-08 18:13:35 -07:00
cmd
extend/kernel: add sigs to opoo/onoe/ofail
2024-05-10 14:12:19 +01:00
completions
…
data/spdx
…
debrew
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dev-cmd
SBOM: more fixes.
2024-05-13 07:36:51 +01:00
extend
various: fix minor typos
2024-05-13 14:30:06 -07:00
language
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
livecheck
livecheck/livecheck: fix passing an alternative url
2024-05-08 15:02:43 +10:00
manpages
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
os
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
requirements
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
rubocops
rubocops/urls: remove dead link
2024-05-06 22:57:23 -04:00
shims
compilers: add gcc-14
2024-05-02 09:40:09 +02:00
sorbet
Update RBI files for regexp_parser.
2024-05-11 16:54:21 +00:00
standalone
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
startup
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
test
Merge pull request #17222 from Homebrew/intel-runner-tag
2024-05-12 02:19:47 +08:00
unpack_strategy
…
utils
github.rb: fix grammar
2024-05-13 14:57:08 -07:00
vendor
Merge pull request #17278 from Homebrew/dependabot/bundler/Library/Homebrew/multi-a73eca0838
2024-05-12 02:14:30 +08:00
version
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
yard
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
.parlour
…
.rspec_parallel
…
.rubocop.yml
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
.simplecov
…
.yardopts
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
abstract_command.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
api.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
ast_constants.rb
ast_constants: enforce {allow,deny}_network_access! order
2024-04-22 22:48:08 -04:00
attestation.rb
Merge pull request #17220 from woodruffw-forks/ww/refine-gh-auth
2024-05-06 08:38:07 +01:00
attrable.rb
…
attrable.rbi
…
brew_irbrc
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
brew.rb
analytics: support command and test-bot analytics.
2024-04-25 17:38:04 +01:00
brew.sh
brew.sh: cache HOMEBREW_VERSION on disk.
2024-05-14 15:46:32 +09:00
build_environment.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
build_options.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
build.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
bump_version_parser.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
bundle_version.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cache_store.rb
…
cask_dependent.rb
…
cask.rb
…
caveats.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
checksum.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cleaner.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
cleanup.rb
fix no autoremove suggestion typo
2024-05-09 20:14:16 -07:00
command_path.sh
Optimise more command handling/speed
2024-04-30 12:48:29 +01:00
commands.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
compilers.rb
compilers: add gcc-14
2024-05-02 09:40:09 +02:00
completions.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
context.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cxxstdlib.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
debrew.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dependable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dependencies_helpers.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
dependencies_helpers.rbi
…
dependencies.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
dependencies.rbi
…
dependency_collector.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
dependency.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
deprecate_disable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
description_cache_store.rb
…
descriptions.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
development_tools.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
diagnostic.rb
extend/kernel: make opoo/odie/etc. print GitHub Actions notes.
2024-05-09 14:43:53 +01:00
download_strategy.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
download_strategy.rbi
…
downloadable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
env_config.rb
Enable HOMEBREW_AUTOREMOVE by autoremove_default
2024-05-09 13:47:52 +01:00
exceptions.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
exceptions.rbi
…
fetch.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
formula_assertions.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
formula_assertions.rbi
…
formula_auditor.rb
Replace FormulaTextAuditor usage
2024-05-04 22:14:55 +01:00
formula_cellar_checks.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
formula_cellar_checks.rbi
…
formula_creator.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
formula_free_port.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_info.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_installer.rb
SBOM: more fixes.
2024-05-13 07:36:51 +01:00
formula_path.sh
…
formula_pin.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_support.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
formula_versions.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula.rb
formula: this was nilable before so remove it.
2024-05-13 07:42:20 +01:00
formula.rbi
…
formulary.rb
Fix internal formula json v3 frozen hash parsing bug
2024-05-01 21:36:37 -07:00
formulary.rbi
…
Gemfile
feat: add generated SPDX file on bottling
2024-05-07 20:33:22 +02:00
Gemfile.lock
Merge pull request #17278 from Homebrew/dependabot/bundler/Library/Homebrew/multi-a73eca0838
2024-05-12 02:14:30 +08:00
git_repository.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
github_packages.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
github_releases.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
github_runner_matrix.rb
Merge pull request #17222 from Homebrew/intel-runner-tag
2024-05-12 02:19:47 +08:00
github_runner.rb
…
global.rb
Explicitly mark non-private APIs.
2024-04-22 21:16:49 +02:00
global.rbi
…
hardware.rb
Explicitly mark non-private APIs.
2024-04-22 21:16:49 +02:00
help.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
ignorable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
ignorable.rbi
…
install_renamed.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
install.rb
Revert "Create '.keepme' files in directories"
2024-05-10 08:26:31 +01:00
installed_dependents.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
items.sh
…
keg_relocate.rb
…
keg.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
lazy_object.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
linkage_cache_store.rb
…
linkage_checker.rb
linkage_checker: test indirect dependencies.
2024-05-14 12:12:19 +09:00
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
livecheck.rb
…
locale.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
lock_file.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
macos_runner_spec.rb
…
macos_version.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
macos_version.rbi
…
manpages.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
messages.rb
…
metafiles.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
migrator.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
missing_formula.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
mktemp.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
official_taps.rb
homebrew/cask-versions: remove
2024-05-02 16:59:33 -04:00
options.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
options.rbi
…
os.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
patch.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
PATH.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
pkg_version.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
pkg_version.rbi
…
postinstall.rb
…
readall.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
README.md
…
reinstall.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
requirement.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
requirements.rb
…
resource_auditor.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
resource.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
rubocops.rb
…
sandbox.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
sbom.rb
SBOM: more fixes.
2024-05-13 07:36:51 +01:00
search.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
service.rb
…
service.rbi
…
settings.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
simulate_system.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
software_spec.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
source_location.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
standalone.rb
…
startup.rb
…
style.rb
extend/kernel: make opoo/odie/etc. print GitHub Actions notes.
2024-05-09 14:43:53 +01:00
system_command.rb
Explicitly mark non-public APIs.
2024-04-23 19:10:45 +02:00
system_config.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
tab.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
tap_auditor.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
tap_constants.rb
homebrew/cask-versions: remove
2024-05-02 16:59:33 -04:00
tap.rb
tap: adjust font cask path
2024-05-12 08:58:35 -07:00
test_runner_formula.rb
…
test.rb
…
uninstall.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
unlink.rb
…
unpack_strategy.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
unpack_strategy.rbi
…
unversioned_cask_checker.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
upgrade.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
upgrade.rbi
…
url.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
utils.rb
…
version.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
version.rbi
…
warnings.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00

README.md

Homebrew Ruby API

This is the API for Homebrew.

The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private.

You may also find the Formula Cookbook and Ruby Style Guide helpful in creating formulae.

Good luck!