admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid bc0f5ee62a
Library/Homebrew: move stdin ruby scripts to files under utils. 
This avoids can avoid UID/EUID related issues with Ruby scripts passed
over `stdin` clashing with Ruby security features.

It's also just a bit nicer to have Ruby scripts in files instead.

While we're here:
- refactor some shared logic into a new `setup-gem-home-bundle-gemfile`
  function in `ruby.sh`
- do some general cleanup of `lock.sh`
- prioritise `flock` over `python` in `lock.sh`
2024-05-02 10:33:42 +01:00
..
.bundle
…
api
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cask
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cli
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
cmd
Library/Homebrew: move stdin ruby scripts to files under utils.
2024-05-02 10:33:42 +01:00
completions
…
data/spdx
…
debrew
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dev-cmd
Library/Homebrew: move stdin ruby scripts to files under utils.
2024-05-02 10:33:42 +01:00
extend
Remove disabled extend.
2024-04-30 11:01:12 +02:00
language
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
livecheck
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
manpages
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
os
Merge pull request #17149 from alebcay/elf-expand-origin
2024-04-28 01:14:54 +08:00
requirements
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
rubocops
Optimise more command handling/speed
2024-04-30 12:48:29 +01:00
shims
shims/super/cc: avoid passing -oso_prefix during configure
2024-04-28 12:42:04 +08:00
sorbet
Various improvements for brew command
2024-04-30 11:38:19 +01:00
standalone
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
startup
startup/bootsnap: improve syntax.
2024-04-29 17:42:34 +01:00
test
Merge pull request #17190 from trail-of-forks/remove-cert-identity
2024-04-30 16:13:41 +01:00
unpack_strategy
…
utils
Library/Homebrew: move stdin ruby scripts to files under utils.
2024-05-02 10:33:42 +01:00
vendor
Merge pull request #17180 from Homebrew/dependabot/bundler/Library/Homebrew/rubocop-sorbet-0.8.3
2024-04-29 19:21:43 +01:00
version
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
yard
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
.parlour
…
.rspec_parallel
…
.rubocop.yml
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
.simplecov
…
.yardopts
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
abstract_command.rb
Individually namespace args for each command
2024-04-21 16:51:31 -07: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
fixup comment
2024-04-30 10:52:36 -04:00
attrable.rb
…
attrable.rbi
…
brew_irbrc
…
brew.rb
analytics: support command and test-bot analytics.
2024-04-25 17:38:04 +01:00
brew.sh
Library/Homebrew: move stdin ruby scripts to files under utils.
2024-05-02 10:33:42 +01:00
build_environment.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
build_options.rb
Make documentation @api private by default.
2024-04-26 19:04: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
checksum.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cleaner.rb
…
cleanup.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02: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
Make documentation @api private by default.
2024-04-26 19:04:20 +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
Hide #inspect in docs.
2024-04-26 13:20:05 +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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dependencies_helpers.rbi
…
dependencies.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dependencies.rbi
…
dependency_collector.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dependency.rb
Make documentation @api private by default.
2024-04-26 19:04: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
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
download_strategy.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
download_strategy.rbi
…
downloadable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
env_config.rb
Merge pull request #17081 from alebcay/formula-offline-phases
2024-04-23 08:30:10 +01:00
exceptions.rb
fix: Display a warning but continue execution when dumping an exception and unable to find related issues
2024-04-29 11:47:01 -07:00
exceptions.rbi
…
fetch.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_assertions.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_assertions.rbi
…
formula_auditor.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_cellar_checks.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_cellar_checks.rbi
…
formula_creator.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +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
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
formula_path.sh
…
formula_pin.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_support.rb
Hide #to_s in docs.
2024-04-26 14:04:55 +02:00
formula_text_auditor.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_versions.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
formula.rbi
…
formulary.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
formulary.rbi
…
Gemfile
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
Gemfile.lock
Merge pull request #17180 from Homebrew/dependabot/bundler/Library/Homebrew/rubocop-sorbet-0.8.3
2024-04-29 19:21:43 +01:00
git_repository.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
github_packages.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
github_releases.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
github_runner_matrix.rb
…
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
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02: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
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
lazy_object.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
linkage_cache_store.rb
…
linkage_checker.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
livecheck.rb
…
locale.rb
Make documentation @api private by default.
2024-04-26 19:04: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
macos_version.rbi
…
manpages.rb
Call Homebrew.install_bundler_gems! more consistently.
2024-04-30 10:39:35 +01:00
messages.rb
…
metafiles.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
migrator.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
missing_formula.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
mktemp.rb
Hide #to_s in docs.
2024-04-26 14:04:55 +02:00
official_taps.rb
…
options.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
options.rbi
…
os.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
patch.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
PATH.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
pkg_version.rb
Make documentation @api private by default.
2024-04-26 19:04: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
requirements.rb
…
resource_auditor.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
resource.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
rubocops.rb
…
sandbox.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
Hide #to_s in docs.
2024-04-26 14:04:55 +02:00
source_location.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
standalone.rb
…
startup.rb
…
style.rb
Call Homebrew.install_bundler_gems! more consistently.
2024-04-30 10:39:35 +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
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
tap_auditor.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
tap_constants.rb
…
tap.rb
Remove disabled extend.
2024-04-30 11:01:12 +02: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
utils.rb
…
version.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
version.rbi
…
warnings.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +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!