admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid fbdec8738d
Warn more when building from source 
We warn sometimes when we tell people to build from source and it's
not supported but we don't actually warn non-developers when invoking
the various install commands so: let's start doing so.

While we're here, also update the existing messaging to reflect the fact
we're on Mastodon now too and we don't want maintainers being
individually bothered about errors either.

I've tried to balance having messages here vs. having them be so long
at the beginning of installation that they will be missed or be overly
obnoxious.
2023-02-17 16:10:38 +00:00
..
.bundle
Don't force Ruby platform.
2023-02-08 10:03:45 +01:00
api
api: use formulae.brew.sh for cask-source API again.
2023-02-16 12:05:38 +00:00
cask
fix: add better keys and fuller values to influxDB analytics
2023-02-15 14:12:05 +01:00
cli
dev-cmd/contributions: CSV output of queried repos; shorter sentence
2023-02-15 12:47:10 +00:00
cmd
Warn more when building from source
2023-02-17 16:10:38 +00:00
compat
Remove odisabled for 3.6.0
2022-08-23 11:25:02 +01:00
completions
Bash completions: warn and exit if POSIX mode detected
2023-02-16 16:04:30 +00:00
data/spdx
spdx: update license data.
2022-12-01 00:17:04 +00:00
debrew
…
dev-cmd
workflows/tests: faster, more reliable tests.
2023-02-17 15:26:18 +00:00
extend
Merge pull request #14653 from danielnachun/libquadmath_linkage
2023-02-17 06:02:29 +00:00
language
python: reinstate pip's --no-binary
2022-12-19 23:25:53 -08:00
livecheck
livecheck_version: only split on commas in cask version
2023-02-12 15:32:32 -08:00
manpages
…
os
os/mac/xcode: do not recommend softwareupdate CLI
2022-10-30 18:16:08 +00:00
requirements
Enable typing in Requirement classes
2023-02-15 14:22:03 +00:00
rubocops
Disable FormulaCop
2023-02-16 15:51:20 -08:00
shims
shims/super/cc: unset RUBYLIB
2022-11-30 03:50:38 +00:00
sorbet
sorbet: Update RBI files.
2023-02-17 00:29:59 +00:00
standalone
Remove sitedir from LOAD_PATH
2022-10-24 19:42:49 +01:00
startup
Universally apply Ruby disable options
2022-11-05 01:58:12 +00:00
test
workflows/tests: faster, more reliable tests.
2023-02-17 15:26:18 +00:00
unpack_strategy
brew style --fix
2023-01-02 19:18:51 +00:00
utils
utils/analytics: make on_request a proper boolean.
2023-02-16 17:51:42 +00:00
vendor
brew vendor-gems: commit updates.
2023-02-16 18:10:22 +00:00
version
version/null: fix major_minor(_patch) type signature
2022-10-07 19:21:11 +01:00
yard
sorbet: Bump some files from typed: false to typed: true
2022-10-11 01:09:03 +01:00
.parlour
…
.rspec_parallel
workflows/tests: faster, more reliable tests.
2023-02-17 15:26:18 +00:00
.rubocop.yml
Further adjust HOMEBREW_AUTO_UPDATE_SECS
2023-02-15 17:37:12 +00:00
.simplecov
workflows/tests: faster, more reliable tests.
2023-02-17 15:26:18 +00:00
.yardopts
…
api.rb
api: avoid unnecessary file write operation
2023-02-16 16:23:13 +00:00
ast_constants.rb
…
brew.rb
Warn more when building from source
2023-02-17 16:10:38 +00:00
brew.sh
Further adjust HOMEBREW_AUTO_UPDATE_SECS
2023-02-15 17:37:12 +00:00
build_environment.rb
Freeze formula definition once first instance is created
2022-08-31 20:40:42 +01:00
build_options.rb
…
build.rb
Prevent require executing some scripts
2022-09-08 01:44:31 +01:00
bundle_version.rb
…
cache_store.rb
rubydoc: fixes for output
2022-11-11 16:16:54 -05:00
cask_dependent.rb
cask_dependent: fix incorrect requirement logic
2022-08-31 19:17:52 +01:00
cask.rb
…
caveats.rb
Allow defining service run command per platform
2023-01-19 11:36:37 +01:00
checksum.rb
…
cleaner.rb
…
cleanup.rb
Remove active_support Time extensions
2023-02-04 13:51:35 -08:00
commands.rb
Set HOMEBREW_NO_INSTALL_FROM_API for certain commands
2023-02-06 16:17:04 +01:00
compilers.rb
glibc related cleanup
2022-08-23 12:42:02 +01:00
completions.rb
…
completions.rbi
…
context.rb
…
cxxstdlib.rb
…
debrew.rb
…
default_prefix.rb
add require extend/os
2023-01-24 21:45:18 +09:00
dependable.rb
Resolve dependable_spec violation
2023-01-22 17:26:44 -08:00
dependencies_helpers.rb
…
dependencies_helpers.rbi
…
dependencies.rb
cask_dependent: fix incorrect requirement logic
2022-08-31 19:17:52 +01:00
dependencies.rbi
…
dependency_collector.rb
formulary: support requirements, aliases etc from API
2023-02-14 03:32:56 +00:00
dependency.rb
Resolve dependable_spec violation
2023-01-22 17:26:44 -08:00
deprecate_disable.rb
…
description_cache_store.rb
description*: fix argument handling of eval_all.
2022-12-08 09:57:12 +00:00
descriptions.rb
Stop including/extending search.rb
2022-12-17 11:08:13 -08:00
development_tools.rb
tests: test on Ubuntu 18.04.
2022-11-09 14:45:43 +00:00
diagnostic.rb
Warn more when building from source
2023-02-17 16:10:38 +00:00
download_strategy.rb
brew style --fix
2023-02-06 13:50:39 -05:00
env_config.rb
Merge pull request #14646 from MikeMcQuaid/auto_update_secs
2023-02-15 18:08:27 +00:00
env_config.rbi
Enabling typing in Homebrew::API module
2023-02-13 21:33:04 -08:00
exceptions.rb
internal messaging fixes
2023-02-10 23:17:16 -05:00
fetch.rb
…
formula_assertions.rb
…
formula_auditor.rb
Disallow references to PRs that are closed but not merged
2023-02-15 16:18:48 +08:00
formula_cellar_checks.rb
reset formula_cellar_checks
2023-01-26 21:41:01 +09:00
formula_creator.rb
formula_creator: use tool-agnostic meson commands
2022-12-08 10:10:36 -08:00
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
Warn more when building from source
2023-02-17 16:10:38 +00:00
formula_pin.rb
…
formula_support.rb
…
formula_text_auditor.rb
rubocop: check for closed issues in comments
2023-02-08 09:30:07 +01:00
formula_versions.rb
…
formula.rb
Overhaul Formula/Cask JSON generation
2023-02-14 14:19:40 +00:00
formula.rbi
…
formulary.rb
formulary: fix git clone handling for API formulae
2023-02-15 05:31:23 +00:00
Gemfile
Stop including *flight block source in cask API
2023-02-13 21:22:18 -08:00
Gemfile.lock
build(deps): bump rubocop-capybara in /Library/Homebrew
2023-02-16 18:05:31 +00:00
github_packages.rb
github_packages: improve schema debugging.
2023-02-10 09:05:10 +00:00
github_releases.rb
…
global.rb
analytics: refactor InfluxDB/Google handling.
2023-02-15 16:34:50 +00:00
global.rbi
…
hardware.rb
dev-cmd/unbottled: simulate target tag
2022-11-16 00:07:31 +00:00
help.rb
…
help.rbi
…
ignorable.rb
brew style --fix
2023-01-02 19:18:51 +00:00
install_renamed.rb
…
install.rb
Better support source builds under API mode
2023-02-06 13:27:36 +00:00
install.rbi
…
installed_dependents.rb
…
items.sh
items.sh: return early when no Taps directory
2022-12-19 09:28:12 -08:00
keg_relocate.rb
install glibc/gcc automatically if too old.
2022-08-25 11:04:37 +01:00
keg.rb
add linux's binary_executable_or_library_files to keg
2023-01-26 21:41:45 +09:00
lazy_object.rb
…
linkage_cache_store.rb
…
linkage_checker.rb
linkage_checker: ignore broken linkage with LLVM libc++.
2022-09-19 12:37:32 +08:00
linuxbrew-core-migration.rb
minor typo fixes
2022-11-06 22:50:07 -05:00
livecheck.rb
Extract latest_version string to a constant
2022-12-19 18:15:51 -05:00
locale.rb
…
lock_file.rb
…
macos_versions.rb
…
manpages.rb
update-maintainers/manpages: not all PLC are maintainers.
2023-02-02 17:09:25 +00:00
manpages.rbi
add manpage.rb to generating homebrew manual
2022-11-08 20:33:30 +09:00
messages.rb
…
metafiles.rb
…
migrator.rb
…
missing_formula.rb
Only optimize for the core tap
2022-11-17 21:15:43 -08:00
mktemp.rb
fix debug-symbols
2022-08-13 23:30:20 -10:00
official_taps.rb
official_taps: Add cask-fonts, cask-drivers taps
2022-08-03 17:52:54 +01:00
options.rb
Options: Add #to_s method
2023-01-19 12:40:50 -05:00
os.rb
Fix supported version check
2023-02-02 19:58:03 -08:00
patch.rb
internal messaging fixes
2023-02-10 23:17:16 -05:00
PATH.rb
minor typo fixes
2022-11-06 22:50:07 -05:00
pkg_version.rb
…
postinstall.rb
Prevent require executing some scripts
2022-09-08 01:44:31 +01:00
prefix.sh
prefix.sh: support API mode
2023-02-14 05:51:11 +00:00
readall.rb
Simulate all OS/arch combinations in brew readall
2022-10-10 23:56:37 -04:00
README.md
…
reinstall.rb
…
requirement.rb
Resolve dependable_spec violation
2023-01-22 17:26:44 -08:00
requirements.rb
…
resource_auditor.rb
ResourceAuditor: Fix #audit_head_branch error
2022-10-17 13:28:20 -04:00
resource.rb
internal messaging fixes
2023-02-10 23:17:16 -05:00
rubocops.rb
…
sandbox.rb
brew style --fix
2022-12-13 11:37:06 +00:00
search.rb
Fix brew search for HOMEBREW_INSTALL_FROM_API
2023-01-23 13:32:54 -05:00
searchable.rb
…
service.rb
Allow defining service run command per platform
2023-01-19 11:36:37 +01:00
service.rbi
Allow defining service run command per platform
2023-01-19 11:36:37 +01:00
settings.rb
…
settings.rbi
…
simulate_system.rb
Move SimulateSystem check to extend/os
2022-11-29 23:13:50 -08:00
software_spec.rb
Preliminary compatibility fixes for Ruby 3
2022-10-11 02:53:27 +01:00
standalone.rb
…
startup.rb
…
style.rb
Update package/scripts/postinstall
2022-12-23 19:36:13 +01:00
system_command.rb
system_command: fix typo.
2023-02-14 13:02:59 +00:00
system_config.rb
Fix error when showing brew config JSON update time
2023-02-05 16:07:00 +01:00
tab.rb
Include loaded_from_api key in Tab
2022-09-14 22:23:01 -04:00
tap_auditor.rb
formula_auditor: create a versioned formula dependent conflict allowlist
2022-08-18 15:40:54 +08:00
tap_constants.rb
Load cask from API with fullname
2023-01-31 19:39:10 -08:00
tap.rb
tap: return the default_remote if not installed.
2023-02-16 12:25:28 +00:00
test.rb
Prevent require executing some scripts
2022-09-08 01:44:31 +01:00
uninstall.rb
…
uninstall.rbi
…
unlink.rb
…
unpack_strategy.rb
…
unpack_strategy.rbi
…
unversioned_cask_checker.rb
unversioned_cask_checker: check installer artifacts
2022-12-05 14:26:38 +11:00
upgrade.rb
Enable typing in Homebrew::Upgrade
2023-02-15 14:24:58 +00:00
upgrade.rbi
Enable typing in Homebrew::Upgrade
2023-02-15 14:24:58 +00:00
utils.rb
cmd/edit: stop double warning
2023-02-11 00:16:11 -08:00
version.rb
version: fix bad regexps in version parsers
2023-02-01 10:48:45 +08:00
version.rbi
…
warnings.rb
…
warnings.rbi
…

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!