admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid 21d8f82056
Add/use HOMEBREW_INSTALL_FROM_API_UNSUPPORTED 
When we're automatically setting `HOMEBREW_NO_INSTALL_FROM_API`
when on an old macOS version or with a non-default prefix (e.g. cases
where you're going to be mostly building from source).

My initial plan was to set
`HOMEBREW_AUTOMATICALLY_SET_NO_INSTALL_FROM_API` in these cases but
it's used differently enough it made sense to add another internal
variable instead: `HOMEBREW_INSTALL_FROM_API_UNSUPPORTED`.

At the moment this is only used to avoid printing the "You have set
`HOMEBREW_NO_INSTALL_FROM_API`" message inside `brew update` but may
make sense to use in other places over time.

Ideally, we'll get rid of these automatic sets of
`HOMEBREW_NO_INSTALL_FROM_API` and perhaps even the variable entirely.
2023-07-27 12:36:54 +01:00
..
.bundle
…
api
Download tap_migrations.json files from the API
2023-07-05 17:18:12 +01:00
cask
Merge pull request #15754 from MikeMcQuaid/cask_url_class
2023-07-25 16:04:48 +01:00
cli
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
cmd
Add/use HOMEBREW_INSTALL_FROM_API_UNSUPPORTED
2023-07-27 12:36:54 +01:00
completions
completions/fish: fix cask references for Linux
2023-04-19 13:03:56 +02:00
data/spdx
spdx: update license data.
2023-06-19 00:12:59 +00:00
debrew
…
dev-cmd
Merge pull request #15725 from razvanazamfirei/bump-cask-pr-arch
2023-07-25 15:52:36 +01:00
extend
Implement ruby-macho TODOs
2023-07-26 11:15:19 +08:00
language
formula: add std_pip_args
2023-07-19 20:02:47 -07:00
livecheck
Add type to Formula attrs
2023-07-24 14:12:36 -07:00
manpages
…
os
Implement ruby-macho TODOs
2023-07-26 11:15:19 +08:00
requirements
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
rubocops
Merge pull request #15614 from carlocab/quictls-cop
2023-07-18 10:44:09 +01:00
shims
shims/mac/super/make: use standard exec routines
2023-07-12 23:21:00 +01:00
sorbet
Update RBI files for minitest.
2023-07-26 19:01:58 +00:00
standalone
…
startup
dev-cmd/update-maintainers: write JSON of maintainers
2023-05-29 21:30:47 +08:00
test
Merge pull request #15725 from razvanazamfirei/bump-cask-pr-arch
2023-07-25 15:52:36 +01:00
unpack_strategy
unpack_strategy/zip: avoid loading formulae unnecessarily
2023-05-31 00:06:55 +08:00
utils
analytics: fix @ in formulae names with --github-packages-downloads
2023-07-26 16:46:23 +01:00
vendor
brew vendor-gems: commit updates.
2023-07-26 18:56:31 +00:00
version
Merge HeadVersion and NullVersion into Version.
2023-05-09 01:13:54 +02:00
yard
Minor YARD improvements
2023-04-05 10:06:45 -07:00
.parlour
…
.rspec_parallel
…
.rubocop.yml
Finish renaming GithubRelease to GithubReleases
2023-05-16 16:08:18 -04:00
.simplecov
…
.yardopts
Minor YARD improvements
2023-04-05 10:06:45 -07:00
api.rb
Download tap_migrations.json files from the API
2023-07-05 17:18:12 +01:00
ast_constants.rb
Rename OS::Mac::Version to MacOSVersion.
2023-05-09 05:08:38 +02:00
brew_irbrc
…
brew.rb
…
brew.sh
Add/use HOMEBREW_INSTALL_FROM_API_UNSUPPORTED
2023-07-27 12:36:54 +01:00
build_environment.rb
brew style --fix
2023-04-24 20:42:39 -07:00
build_options.rb
…
build.rb
build: don't add implicit dependencies to build environment
2023-07-04 13:40:59 +01:00
bump_version_parser.rb
rename class and reorganize files
2023-07-25 06:41:38 -04:00
bundle_version.rb
Fix BundleVersion comparison.
2023-05-16 14:23:15 +02:00
cache_store.rb
…
cask_dependent.rb
…
cask.rb
Implement cask renames.
2023-05-12 21:17:30 +02:00
caveats.rb
service: add custom service name DSL
2023-05-13 14:53:01 -07:00
checksum.rb
…
cleaner.rb
…
cleanup.rb
cleanup: handle GitHub Actions artifacts
2023-05-17 21:11:16 +08:00
commands.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
compilers.rb
brew style --fix
2023-04-24 20:42:39 -07:00
completions.rb
brew style --fix
2023-04-24 20:42:39 -07:00
context.rb
…
cxxstdlib.rb
brew style --fix
2023-04-24 20:42:39 -07:00
debrew.rb
brew style --fix
2023-04-24 20:42:39 -07:00
default_prefix.rb
…
dependable.rb
Introduce tag for implicit dependencies
2023-07-04 13:40:58 +01:00
dependencies_helpers.rb
Remove TapDependency
2023-07-04 13:31:58 +01:00
dependencies_helpers.rbi
…
dependencies.rb
Introduce UsesFromMacOSDependency
2023-07-04 13:40:55 +01:00
dependencies.rbi
Enable types in extensions, etc.
2023-04-01 18:56:42 -07:00
dependency_collector.rb
Introduce tag for implicit dependencies
2023-07-04 13:40:58 +01:00
dependency.rb
various: fix miscellaneous typos
2023-07-18 08:52:49 -07:00
deprecate_disable.rb
…
description_cache_store.rb
…
descriptions.rb
…
development_tools.rb
brew style --fix
2023-04-24 20:42:39 -07:00
diagnostic.rb
diagnostic: don't complain about missing homebrew/cask.
2023-07-18 10:31:51 +01:00
download_strategy.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
download_strategy.rbi
…
downloadable.rb
Fix DownloadError erroring itself
2023-05-02 02:09:53 +01:00
env_config.rb
Add/use HOMEBREW_INSTALL_FROM_API_UNSUPPORTED
2023-07-27 12:36:54 +01:00
env_config.rbi
sorbet: Autobump sigils via Spoom
2023-07-05 00:31:35 +00:00
exceptions.rb
Corrects an uncaught spelling error
2023-07-17 10:33:48 -04:00
exceptions.rbi
…
fetch.rb
Fix tests on generic OS.
2023-05-17 15:26:46 +02:00
formula_assertions.rb
…
formula_assertions.rbi
…
formula_auditor.rb
Add type to Formula attrs
2023-07-24 14:12:36 -07:00
formula_cellar_checks.rb
service: add custom service name DSL
2023-05-13 14:53:01 -07:00
formula_cellar_checks.rbi
…
formula_creator.rb
formula_creator: require version before creating
2023-07-23 00:05:43 -04:00
formula_free_port.rb
…
formula_info.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
formula_installer.rb
Fix cases of core taps being unnecessarily installed
2023-07-13 20:33:31 +01:00
formula_path.sh
…
formula_pin.rb
…
formula_support.rb
brew style --fix
2023-04-24 20:42:39 -07:00
formula_text_auditor.rb
…
formula_versions.rb
Add --os=all and --arch=all options.
2023-05-17 15:26:46 +02:00
formula.rb
formula: fix std_cargo_args type error
2023-07-25 20:41:16 -07:00
formula.rbi
Remove methods from formula.rbi.
2023-05-20 19:28:29 +02:00
formulary.rb
Add type to Formula attrs
2023-07-24 14:12:36 -07:00
formulary.rbi
…
Gemfile
Vendor mechanize gem outside Gemfile
2023-04-24 14:03:55 +01:00
Gemfile.lock
build(deps): bump minitest from 5.18.1 to 5.19.0 in /Library/Homebrew
2023-07-26 18:52:04 +00:00
git_repository.rb
brew style --fix
2023-04-24 20:42:39 -07:00
github_packages.rb
github_packages: ensure only OCI format is uploaded
2023-07-22 19:45:18 +01:00
github_releases.rb
brew style --fix
2023-04-24 20:42:39 -07:00
github_runner_matrix.rb
github_runner_matrix: remove GITHUB_RUN_ATTEMPT
2023-05-29 22:36:00 +08:00
github_runner.rb
Rename OS::Mac::Version to MacOSVersion.
2023-05-09 05:08:38 +02:00
global.rb
Use HOMEBREW_CELLAR_PLACEHOLDER
2023-07-18 10:59:27 +01:00
global.rbi
…
hardware.rb
Wording
2023-06-24 11:09:28 +01:00
help.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
ignorable.rb
Enable typing in Ignorable
2023-03-31 08:35:20 -07:00
ignorable.rbi
Enable typing in Ignorable
2023-03-31 08:35:20 -07:00
install_renamed.rb
…
install.rb
Support multiple oldnames for formulae
2023-04-27 05:15:43 +01:00
installed_dependents.rb
brew style --fix
2023-04-24 20:42:39 -07:00
items.sh
items.sh: use regex for find_exclude_filter
2023-05-25 01:49:25 -07:00
keg_relocate.rb
brew style --fix
2023-04-24 20:42:39 -07:00
keg.rb
Support multiple oldnames for formulae
2023-04-27 05:15:43 +01:00
lazy_object.rb
…
linkage_cache_store.rb
…
linkage_checker.rb
Merge pull request #15571 from gerlero/relocate-relative-names
2023-07-11 04:38:26 +08:00
linux_runner_spec.rb
brew style --fix
2023-04-24 20:42:39 -07:00
linuxbrew-core-migration.rb
…
livecheck.rb
Type livecheck.rb.
2023-05-06 03:27:42 +02:00
locale.rb
brew style --fix
2023-04-24 20:42:39 -07:00
lock_file.rb
…
macos_runner_spec.rb
Merge pull request #15309 from carlocab/longer-big-sur-timeout
2023-04-25 17:52:51 +08:00
macos_version.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
macos_version.rbi
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
manpages.rb
brew style --fix
2023-04-24 20:42:39 -07:00
messages.rb
brew style --fix
2023-04-24 20:42:39 -07:00
metafiles.rb
…
migrator.rb
Implement cask renames.
2023-05-12 21:17:30 +02:00
missing_formula.rb
rm popen sigs
2023-03-30 17:22:02 -07:00
mktemp.rb
brew style --fix
2023-04-24 20:42:39 -07:00
official_taps.rb
homebrew-cask-drivers: deprecate official tap
2023-06-08 08:12:59 -04:00
options.rb
brew style --fix
2023-04-24 20:42:39 -07:00
options.rbi
…
os.rb
Rename OS::Mac::Version to MacOSVersion.
2023-05-09 05:08:38 +02:00
patch.rb
Refactor formula, cask and Ruby source downloads to use shared code
2023-04-27 23:23:07 +01:00
PATH.rb
brew style --fix
2023-04-24 20:42:39 -07:00
pkg_version.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
pkg_version.rbi
…
postinstall.rb
…
readall.rb
Add --os and --arch flags to readall.
2023-05-20 20:11:31 +02:00
README.md
…
reinstall.rb
…
requirement.rb
various: fix miscellaneous typos
2023-07-18 08:52:49 -07:00
requirements.rb
…
resource_auditor.rb
Disable false positive
2023-04-25 09:26:24 -07:00
resource.rb
Fix type errors.
2023-05-09 01:13:55 +02:00
rubocops.rb
Include T::Sig in Module
2023-04-24 20:42:38 -07:00
sandbox.rb
brew style --fix
2023-04-24 20:42:39 -07:00
search.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
service.rb
Use HOMEBREW_CELLAR_PLACEHOLDER
2023-07-18 10:59:27 +01:00
service.rbi
…
settings.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
simulate_system.rb
various: fix miscellaneous typos
2023-07-18 08:52:49 -07:00
software_spec.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
source_location.rb
Add cask URL location to audit problems.
2023-05-21 16:17:16 +02:00
standalone.rb
…
startup.rb
…
style.rb
Add cask URL location to audit problems.
2023-05-21 16:17:16 +02:00
system_command.rb
sudo: change sudo_user to sudo_as_root.
2023-04-28 11:22:54 -07:00
system_config.rb
brew style --fix
2023-04-24 20:42:39 -07:00
tab.rb
tab: fix typing of versions
2023-05-11 12:33:27 +01:00
tap_auditor.rb
tap_auditor: fix API data getting mixed in
2023-07-04 16:08:53 +01:00
tap_constants.rb
Refactor formula, cask and Ruby source downloads to use shared code
2023-04-27 23:23:07 +01:00
tap.rb
docs: assume core repositories are untapped
2023-07-24 09:55:56 -04:00
test_runner_formula.rb
Add SimulateSystem::with.
2023-05-14 01:45:04 +02:00
test.rb
…
uninstall.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
unlink.rb
…
unpack_strategy.rb
brew style --fix
2023-04-24 20:42:39 -07:00
unpack_strategy.rbi
…
unversioned_cask_checker.rb
brew style --fix
2023-04-24 20:42:39 -07:00
upgrade.rb
…
upgrade.rbi
…
url.rb
Refactor formula, cask and Ruby source downloads to use shared code
2023-04-27 23:23:07 +01:00
utils.rb
brew style --fix
2023-04-24 20:42:39 -07:00
version.rb
Fix type errors when HOMEBREW_SORBET_RUNTIME=1
2023-07-18 10:22:51 -07:00
version.rbi
…
warnings.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07: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!