Class: Formula Abstract
- Inherits:
-
Object
- Object
- Formula
- Extended by:
- APIHashable, BuildEnvironment::DSL, Cachable, Forwardable, OnSystem::MacOSAndLinux, Predicable
- Includes:
- Context, FileUtils, Homebrew::Livecheck::Constants, OnSystem::MacOSAndLinux, Utils::Inreplace, Utils::Shebang, Utils::Shell
- Defined in:
- extend/os/linux/formula.rb,
formula.rb
Overview
A formula provides instructions and metadata for Homebrew to install a piece
of software. Every Homebrew formula is a Formula.
All subclasses of Formula (and all Ruby classes) have to be named
UpperCase
and not-use-dashes
.
A formula specified in this-formula.rb
should have a class named
ThisFormula
. Homebrew does enforce that the name of the file and the class
correspond.
Make sure you check with brew search
that the name is free!
class Wget < Formula
homepage "https://www.gnu.org/software/wget/"
url "https://ftp.gnu.org/gnu/wget/wget-1.15.tar.gz"
sha256 "52126be8cf1bddd7536886e74c053ad7d0ed2aa89b4b630f76785bac21695fcd"
def install
system "./configure", "--prefix=#{prefix}"
system "make", "install"
end
end
Constant Summary
Constants included from Homebrew::Livecheck::Constants
Homebrew::Livecheck::Constants::LATEST_VERSION
Constants included from Utils::Shell
Utils::Shell::SHELL_PROFILE_MAP, Utils::Shell::UNSAFE_SHELL_CHAR
Class Attribute Summary collapse
-
.bottle(&block) ⇒ void
Adds a Formula.bottle SoftwareSpec.
-
.deprecated_option(hash) ⇒ Object
Deprecated options are used to rename options and migrate users who used them to newer ones.
-
.deprecation_date ⇒ Object
readonly
The date that this Formula was or becomes deprecated.
-
.deprecation_reason ⇒ nil, ...
readonly
The reason for deprecation of a Formula.
-
.desc ⇒ Object
writeonly
A one-line description of the software.
-
.disable_date ⇒ Object
readonly
The date that this Formula was or becomes disabled.
-
.disable_reason ⇒ String, Symbol
readonly
The reason this Formula is disabled.
-
.head(val = nil, specs = {}, &block) ⇒ Object
Adds a Formula.head SoftwareSpec.
-
.homepage ⇒ Object
writeonly
The homepage for the software.
-
.license(args = nil) ⇒ Object
The SPDX ID of the open-source license that the formula uses.
-
.livecheck(&block) ⇒ Object
Livecheck can be used to check for newer versions of the software.
-
.mirror(val) ⇒ Object
Additional URLs for the Formula.stable version of the formula.
-
.option(name, description = "") ⇒ Object
Options can be used as arguments to
brew install
. -
.revision ⇒ Object
writeonly
Used for creating new Homebrew versions of software without new upstream versions.
-
.service(&block) ⇒ Object
Service can be used to define services.
-
.sha256(val) ⇒ Object
To verify the cached download’s integrity and security we verify the SHA-256 hash matches what we’ve declared in the Formula.
-
.stable(&block) ⇒ Object
Allows adding Formula.depends_on and Patches just to the Formula.stable SoftwareSpec.
-
.url(val, specs = {}) ⇒ Object
The URL used to download the source for the Formula.stable version of the formula.
-
.version(val = nil) ⇒ Object
The version string for the Formula.stable version of the formula.
-
.version_scheme ⇒ Object
writeonly
Used for creating new Homebrew version schemes.
Instance Attribute Summary collapse
-
#alias_name ⇒ Object
readonly
The name of the alias that was used to identify this Formula.
-
#alias_path ⇒ Object
readonly
The path to the alias that was used to identify this Formula.
-
#build ⇒ BuildOptions
readonly
The BuildOptions for this Formula.
-
#buildpath ⇒ Object
readonly
The current working directory during builds.
-
#follow_installed_alias ⇒ Boolean
(also: #follow_installed_alias?)
Whether this formula should be considered outdated if the target of the alias it was installed with has since changed.
-
#full_alias_name ⇒ Object
readonly
The fully-qualified alias referring to this Formula.
-
#full_name ⇒ Object
readonly
The fully-qualified name of this Formula.
-
#name ⇒ Object
readonly
The name of this Formula.
-
#path ⇒ Object
readonly
The full path to this Formula.
-
#revision ⇒ Object
readonly
Used for creating new Homebrew versions of software without new upstream versions.
-
#testpath ⇒ Object
readonly
The current working directory during tests.
-
#version_scheme ⇒ Object
readonly
Used to change version schemes for packages.
Class Method Summary collapse
-
.[](name) ⇒ Object
-
.conflicts_with(*names) ⇒ Object
One or more formulae that conflict with this one and why.
-
.cxxstdlib_check(check_type) ⇒ Object
Pass
:skip
to this method to disable post-install stdlib checking. -
.depends_on(dep) ⇒ Object
The dependencies for this formula.
-
.deprecate!(date:, because:) ⇒ Object
Deprecates a Formula (on the given date) so a warning is shown on each installation.
-
.deprecated? ⇒ Boolean
Whether this Formula is deprecated (i.e. warns on installation).
-
.disable!(date:, because:) ⇒ Object
Disables a Formula (on the given date) so it cannot be installed.
-
.disabled? ⇒ Boolean
Whether this Formula is disabled (i.e. cannot be installed).
-
.fails_with(compiler, &block) ⇒ Object
Marks the Formula as failing with a particular compiler so it will fall back to others.
-
.freeze ⇒ Object
-
.go_resource(name, &block) ⇒ Object
-
.ignore_missing_libraries(*libs) ⇒ Object
Permit links to certain libraries that don’t exist.
-
.inherited(child) ⇒ Object
Initialise instance variables for each subclass.
-
.installed_with_alias_path(alias_path) ⇒ Object
-
.keg_only(reason, explanation = "") ⇒ Object
Software that will not be symlinked into the
brew --prefix
and will only live in its Cellar. -
.link_overwrite(*paths) ⇒ Object
Permit overwriting certain files while linking.
-
.livecheckable? ⇒ Boolean
Whether a livecheck specification is defined or not.
-
.needs(*standards) ⇒ Object
Marks the Formula as needing a certain standard, so Homebrew will fall back to other compilers if the default compiler does not implement that standard.
-
.patch(strip = :p1, src = nil, &block) ⇒ Object
External patches can be declared using resource-style blocks.
-
.plist_options(options) ⇒ Object
deprecated
Deprecated.
Please use Homebrew::Service#require_root instead.
-
.pour_bottle?(only_if: nil, &block) ⇒ Boolean
Defines whether the Formula’s bottle can be used on the given Homebrew installation.
-
.resource(name, klass = Resource, &block) ⇒ Object
Additional downloads can be defined as Formula.resources and accessed in the install method.
-
.service? ⇒ Boolean
Whether a service specification is defined or not.
-
.skip_clean(*paths) ⇒ Object
Skip cleaning paths in a formula.
-
.test(&block) ⇒ Boolean
A test is required for new formulae and makes us happy.
-
.uses_from_macos(dep, bounds = {}) ⇒ Object
Indicates use of dependencies provided by macOS.
Instance Method Summary collapse
-
#active_log_prefix ⇒ String
The prefix, if any, to use in filenames for logging current activity.
-
#add_global_deps_to_spec(spec) ⇒ void
-
#alias_changed? ⇒ Boolean
Has the alias used to install the formula changed, or are different formulae already installed with this alias?.
-
#aliases ⇒ Object
All aliases for the formula.
-
#any_installed_prefix ⇒ Object
-
#any_installed_version ⇒ Object
Returns the PkgVersion for this formula if it is installed.
-
#bash_completion ⇒ Object
The directory where the formula’s Bash completion files should be installed.
-
#bin ⇒ Object
The directory where the formula’s binaries should be installed.
-
#bottle_hash ⇒ Object
Returns the bottle information for a formula.
-
#bottle_tab_attributes ⇒ Hash
-
#caveats ⇒ String?
Warn the user about any Homebrew-specific issues or quirks for this package.
-
#current_installed_alias_target ⇒ Object
-
#deprecated? ⇒ Boolean
Whether this Formula is deprecated (i.e. warns on installation).
-
#deprecation_date ⇒ Object
The date that this Formula was or becomes deprecated.
-
#deprecation_reason ⇒ String, Symbol
The reason this Formula is deprecated.
-
#desc ⇒ Object
The description of the software.
-
#deuniversalize_machos(*targets) ⇒ void
-
#disable_date ⇒ Object
The date that this Formula was or becomes disabled.
-
#disable_reason ⇒ String, Symbol
The reason this Formula is disabled.
-
#disabled? ⇒ Boolean
Whether this Formula is disabled (i.e. cannot be installed).
-
#doc ⇒ Object
The directory where the formula’s documentation should be installed.
-
#elisp ⇒ Object
The directory where Emacs Lisp files should be installed, with the formula name appended to avoid linking conflicts.
-
#etc ⇒ Object
The directory where the formula’s configuration files should be installed.
-
#fetch_bottle_tab ⇒ void
-
#fetch_patches ⇒ Object
-
#fish_completion ⇒ Object
The directory where the formula’s fish completion files should be installed.
-
#fish_function ⇒ Object
The directory where the formula’s fish function files should be installed.
-
#frameworks ⇒ Object
The directory where the formula’s Frameworks should be installed.
-
#full_installed_alias_name ⇒ Object
-
#full_installed_specified_name ⇒ Object
The name (including tap) specified to install this formula.
-
#full_specified_name ⇒ Object
The name (including tap) specified to find this formula.
-
#generate_completions_from_executable(*commands, base_name: name, shells: [:bash, :zsh, :fish], shell_parameter_format: nil) ⇒ void
Generate shell completions for a formula for bash, zsh, and fish, using the formula’s executable.
-
#head_version_outdated?(version, fetch_head: false) ⇒ Boolean
-
#homepage ⇒ Object
The homepage for the software.
-
#include ⇒ Object
The directory where the formula’s headers should be installed.
-
#info ⇒ Object
The directory where the formula’s info files should be installed.
-
#inreplace(paths, before = nil, after = nil, audit_result = true) ⇒ Object
Sometimes we have to change a bit before we install.
-
#install ⇒ Object
This method is overridden in Formula subclasses to provide the installation instructions.
-
#installed_alias_name ⇒ String?
-
#installed_alias_path ⇒ Object
The alias path that was used to install this formula, if it exists.
-
#installed_alias_target_changed? ⇒ Boolean
Has the target of the alias used to install this formula changed? Returns false if the formula wasn’t installed with an alias.
-
#installed_specified_name ⇒ Object
The name specified to install this formula.
-
#keg_only? ⇒ Boolean
Rarely, you don’t want your library symlinked into the main prefix.
-
#kext_prefix ⇒ Object
The directory where the formula’s kernel extensions should be installed.
-
#latest_formula ⇒ Object
If the alias has changed value, return the new formula.
-
#latest_head_prefix ⇒ Object
-
#latest_head_version ⇒ Object
-
#launchd_service_path ⇒ Pathname
The generated launchd Formula.service file path.
-
#lib ⇒ Object
The directory where the formula’s libraries should be installed.
-
#libexec ⇒ Object
The directory where the formula’s binaries should be installed.
-
#license ⇒ Object
The SPDX ID of the software license.
-
#linked? ⇒ Boolean
Is the formula linked?.
-
#linked_version ⇒ PkgVersion?
PkgVersion of the linked keg for the formula.
-
#livecheck ⇒ Object
The livecheck specification for the software.
-
#livecheckable? ⇒ Object
Is a livecheck specification defined for the software?.
-
#loader_path ⇒ String
-
#man ⇒ Object
The root directory where the formula’s manual pages should be installed.
-
#man1 ⇒ Object
The directory where the formula’s man1 pages should be installed.
-
#man2 ⇒ Object
The directory where the formula’s man2 pages should be installed.
-
#man3 ⇒ Object
The directory where the formula’s man3 pages should be installed.
-
#man4 ⇒ Object
The directory where the formula’s man4 pages should be installed.
-
#man5 ⇒ Object
The directory where the formula’s man5 pages should be installed.
-
#man6 ⇒ Object
The directory where the formula’s man6 pages should be installed.
-
#man7 ⇒ Object
The directory where the formula’s man7 pages should be installed.
-
#man8 ⇒ Object
The directory where the formula’s man8 pages should be installed.
-
#migration_needed? ⇒ Boolean
-
#missing_dependencies(hide: nil) ⇒ Object
Returns a list of formulae depended on by this formula that aren’t installed.
-
#mkdir(name, &block) ⇒ Object
A version of
FileUtils.mkdir
that also changes to that folder in a block. -
#mktemp(prefix = name, opts = {}, &block) ⇒ Object
Create a temporary directory then yield.
-
#new_formula_available? ⇒ Boolean
-
#old_installed_formulae ⇒ Object
-
#oldname ⇒ Object
An old name for the formula.
-
#opt_bin ⇒ Pathname
-
#opt_elisp ⇒ Pathname
-
#opt_frameworks ⇒ Pathname
-
#opt_include ⇒ Pathname
-
#opt_lib ⇒ Pathname
-
#opt_libexec ⇒ Pathname
-
#opt_pkgshare ⇒ Pathname
-
#opt_prefix ⇒ Pathname
A stable path for this formula, when installed.
-
#opt_sbin ⇒ Pathname
-
#opt_share ⇒ Pathname
-
#option_defined? ⇒ Object
If a named option is defined for the currently active SoftwareSpec.
-
#optlinked? ⇒ Boolean
Is the formula linked to
opt
?. -
#pkg_version ⇒ PkgVersion
The PkgVersion for this formula with Formula.version and #revision information.
-
#pkgetc ⇒ Object
A subdirectory of
etc
with the formula name suffixed. -
#pkgshare ⇒ Object
The directory where the formula’s shared files should be installed, with the name of the formula appended to avoid linking conflicts.
-
#plist ⇒ Object
deprecated
Deprecated.
Please use Homebrew::Service instead.
-
#plist_name ⇒ String
The generated launchd #plist service name.
-
#plist_path ⇒ Pathname
The generated launchd #plist file path.
-
#post_install ⇒ void
Can be overridden to run commands on both source and bottle installation.
-
#pour_bottle? ⇒ Boolean
Indicates that this formula supports bottles.
-
#prefix(version = pkg_version) ⇒ Object
The directory in the cellar that the formula is installed to.
-
#prefix_linked?(version = pkg_version) ⇒ Boolean
If a formula’s linked keg points to the prefix.
-
#resource ⇒ Object
A named Resource for the currently active SoftwareSpec.
-
#resources ⇒ Object
The Resources for the currently active SoftwareSpec.
-
#rpath(source: bin, target: lib) ⇒ String
Executable/Library RPATH according to platform conventions.
-
#runtime_installed_formula_dependents ⇒ Object
-
#sbin ⇒ Object
The directory where the formula’s
sbin
binaries should be installed. -
#service ⇒ Object
The service specification of the software.
-
#service? ⇒ Object
Is a service specification defined for the software?.
-
#service_name ⇒ String
The generated service name.
-
#share ⇒ Object
The directory where the formula’s shared files should be installed.
-
#shared_library(name, version = nil) ⇒ String
-
#skip_cxxstdlib_check? ⇒ Boolean
-
#specified_name ⇒ Object
The name specified to find this formula.
-
#specified_path ⇒ Object
The path that was specified to find this formula.
-
#std_cabal_v2_args ⇒ Array<String>
Standard parameters for cabal-v2 builds.
-
#std_cargo_args(root: prefix, path: ".") ⇒ Array<String, Pathname>
Standard parameters for cargo builds.
-
#std_cmake_args(install_prefix: prefix, install_libdir: "lib", find_framework: "LAST") ⇒ Array<String>
Standard parameters for CMake builds.
-
#std_configure_args ⇒ Array<String>
Standard parameters for configure builds.
-
#std_go_args(output: bin/name, ldflags: nil) ⇒ Array<String>
Standard parameters for Go builds.
-
#std_meson_args ⇒ Array<String>
Standard parameters for meson builds.
-
#supersedes_an_installed_formula? ⇒ Boolean
Is this formula the target of an alias used to install an old formula?.
-
#system(cmd, *args) ⇒ void
To call out to the system, we use the
system
method and we prefer you give the args separately as in the line below, otherwise a subshell has to be opened first. -
#systemd_service_path ⇒ Pathname
The generated systemd Formula.service file path.
-
#systemd_timer_path ⇒ Pathname
The generated systemd timer file path.
-
#time ⇒ Time
Creates a new
Time
object for use in the formula as the build time. -
#to_s ⇒ Object
-
#update_head_version ⇒ Object
-
#var ⇒ Object
The directory where the formula’s variable files should be installed.
-
#version ⇒ Object
The version for the currently active SoftwareSpec.
-
#versioned_formula? ⇒ Boolean
If this is a
@
-versioned formula. -
#versioned_formulae ⇒ Array<Formula>
Returns any
@
-versioned Formula objects for any Formula (including versioned formulae). -
#versioned_formulae_names ⇒ Array<String>
Returns any
@
-versioned formulae names for any formula (including versioned formulae). -
#with_logging(log_type) ⇒ Object
Runs a block with the given log type in effect for its duration.
-
#xcodebuild(*args) ⇒ void
Runs
xcodebuild
without Homebrew’s compiler environment variables set. -
#zsh_completion ⇒ Object
The directory where the formula’s zsh completion files should be installed.
-
#zsh_function ⇒ Object
The directory where the formula’s zsh function files should be installed.
Methods included from OnSystem::MacOSAndLinux
Methods included from BuildEnvironment::DSL
Methods included from Cachable
Methods included from Predicable
Methods included from APIHashable
generated_hash!, generating_hash!, generating_hash?
Methods included from Context
current, current=, #debug?, #quiet?, #verbose?, #with_context
Methods included from Utils::Shell
csh_quote, export_value, from_path, parent, preferred, preferred_path, prepend_path_in_profile, profile, set_variable_in_profile, sh_quote
Methods included from Utils::Shebang
Methods included from Utils::Inreplace
Class Attribute Details
.bottle(&block) ⇒ void
This method returns an undefined value.
Adds a bottle SoftwareSpec. This provides a pre-built binary package built by the Homebrew maintainers for you. It will be installed automatically if there is a binary package for your platform and you haven’t passed or previously used any options on this formula.
If you maintain your own repository, you can add your own bottle links. You can ignore this block entirely if submitting to Homebrew/homebrew-core. It’ll be handled for you by the Brew Test Bot.
bottle do
root_url "https://example.com" # Optional root to calculate bottle URLs.
rebuild 1 # Marks the old bottle as outdated without bumping the version/revision of the formula.
# Optionally specify the HOMEBREW_CELLAR in which the bottles were built.
sha256 cellar: "/brew/Cellar", catalina: "ef65c759c5097a36323fa9c77756468649e8d1980a3a4e05695c05e39568967c"
sha256 cellar: :any, mojave: "28f4090610946a4eb207df102d841de23ced0d06ba31cb79e040d883906dcd4f"
sha256 high_sierra: "91dd0caca9bd3f38c439d5a7b6f68440c4274945615fae035ff0a369264b8a2f"
end
Homebrew maintainers aim to bottle all formulae that require compilation.
Formulae that can be installed without compilation should be tagged with:
bottle :unneeded
Formulae which should not be bottled should be tagged with:
bottle :disable, "reasons"
2971 2972 2973 |
# File 'formula.rb', line 2971 def bottle(&block) stable.bottle(&block) end |
.deprecated_option(hash) ⇒ Object
Deprecated options are used to rename options and migrate users who used
them to newer ones. They are mostly used for migrating non-with
options
(e.g. enable-debug
) to with
options (e.g. with-debug
).
deprecated_option "enable-debug" => "with-debug"
3118 3119 3120 |
# File 'formula.rb', line 3118 def deprecated_option(hash) specs.each { |spec| spec.deprecated_option(hash) } end |
.deprecation_date ⇒ Object (readonly)
The date that this Formula was or becomes deprecated.
Returns nil
if no date is specified.
3394 3395 3396 |
# File 'formula.rb', line 3394 def deprecation_date @deprecation_date end |
.deprecation_reason ⇒ nil, ... (readonly)
The reason for deprecation of a Formula.
3400 3401 3402 |
# File 'formula.rb', line 3400 def deprecation_reason @deprecation_reason end |
.desc=(value) ⇒ Object (writeonly)
A one-line description of the software. Used by users to get an overview
of the software and Homebrew maintainers.
Shows when running brew info
.
desc "Example formula"
2780 |
# File 'formula.rb', line 2780 attr_rw :desc |
.disable_date ⇒ Object (readonly)
The date that this Formula was or becomes disabled.
Returns nil
if no date is specified.
3434 3435 3436 |
# File 'formula.rb', line 3434 def disable_date @disable_date end |
.disable_reason ⇒ String, Symbol (readonly)
The reason this Formula is disabled.
Returns nil
if no reason was provided or the formula is not disabled.
3440 3441 3442 |
# File 'formula.rb', line 3440 def disable_reason @disable_reason end |
.head(val = nil, specs = {}, &block) ⇒ Object
Adds a head SoftwareSpec.
This can be installed by passing the --HEAD
option to allow
installing software directly from a branch of a version-control repository.
If called as a method this provides just the url for the SoftwareSpec.
If a block is provided you can also add depends_on and Patches just to the head SoftwareSpec.
The download strategies (e.g. :using =>
) are the same as for url.
master
is the default branch and doesn’t need stating with a branch:
parameter.
head "https://we.prefer.https.over.git.example.com/.git"
head "https://example.com/.git", branch: "name_of_branch"
or (if autodetect fails):
head "https://hg.is.awesome.but.git.has.won.example.com/", using: :hg
3020 3021 3022 3023 3024 3025 3026 3027 3028 |
# File 'formula.rb', line 3020 def head(val = nil, specs = {}, &block) if block @head.instance_eval(&block) elsif val @head.url(val, specs) else @head end end |
.homepage=(value) ⇒ Object (writeonly)
The homepage for the software. Used by users to get more information
about the software and Homebrew maintainers as a point of contact for
e.g. submitting patches.
Can be opened with running brew home
.
homepage "https://www.example.com"
2820 |
# File 'formula.rb', line 2820 attr_rw :homepage |
.license(args = nil) ⇒ Object
The SPDX ID of the open-source license that the formula uses.
Shows when running brew info
.
Use :any_of
, :all_of
or :with
to describe complex license expressions.
:any_of
should be used when the user can choose which license to use.
:all_of
should be used when the user must use all licenses.
:with
should be used to specify a valid SPDX exception.
Add +
to an identifier to indicate that the formulae can be
licensed under later versions of the same license.
license "BSD-2-Clause"
license "EPL-1.0+"
license any_of: ["MIT", "GPL-2.0-only"]
license all_of: ["MIT", "GPL-2.0-only"]
license "GPL-2.0-only" => { with: "LLVM-exception" }
license :public_domain
license any_of: [
"MIT",
:public_domain,
all_of: ["0BSD", "Zlib", "Artistic-1.0+"],
"Apache-2.0" => { with: "LLVM-exception" },
]
2805 2806 2807 2808 2809 2810 2811 |
# File 'formula.rb', line 2805 def license(args = nil) if args.nil? @licenses else @licenses = args end end |
.livecheck(&block) ⇒ Object
Livecheck can be used to check for newer versions of the software.
This method evaluates the DSL specified in the livecheck block of the
Formula (if it exists) and sets the instance variables of a Livecheck
object accordingly. This is used by brew livecheck
to check for newer
versions of the software.
livecheck do
skip "Not maintained"
url "https://example.com/foo/releases"
regex /foo-(\d+(?:\.\d+)+)\.tar/
end
3297 3298 3299 3300 3301 3302 |
# File 'formula.rb', line 3297 def livecheck(&block) return @livecheck unless block @livecheckable = true @livecheck.instance_eval(&block) end |
.mirror(val) ⇒ Object
Additional URLs for the stable version of the formula. These are only used if the url fails to download. It’s optional and there can be more than one. Generally we add them when the main url is unreliable. If url is really unreliable then we may swap the mirror and url.
mirror "https://in.case.the.host.is.down.example.com"
mirror "https://in.case.the.mirror.is.down.example.com
2927 2928 2929 |
# File 'formula.rb', line 2927 def mirror(val) stable.mirror(val) end |
.option(name, description = "") ⇒ Object
Options can be used as arguments to brew install
.
To switch features on/off: "with-something"
or "with-otherthing"
.
To use other software: "with-other-software"
or "without-foo"
.
Note that for depends_on that are :optional
or :recommended
, options
are generated automatically.
There are also some special options:
:universal
: build a universal binary/library (e.g. on newer Intel Macs this means a combined x86_64/x86 binary/library).
option "with-spam", "The description goes here without a dot at the end"
option "with-qt", "Text here overwrites what's autogenerated by 'depends_on "qt" => :optional'"
option :universal
3109 3110 3111 |
# File 'formula.rb', line 3109 def option(name, description = "") specs.each { |spec| spec.option(name, description) } end |
.revision=(value) ⇒ Object (writeonly)
Used for creating new Homebrew versions of software without new upstream
versions. For example, if we bump the major version of a library that this
Formula depends_on then we may need to update the revision
of this
Formula to install a new version linked against the new library version.
0
if unset.
revision 1
2869 |
# File 'formula.rb', line 2869 attr_rw :revision |
.service(&block) ⇒ Object
Service can be used to define services.
This method evaluates the DSL specified in the service block of the
Formula (if it exists) and sets the instance variables of a Service
object accordingly. This is used by brew install
to generate a service file.
service do
run [opt_bin/"foo"]
end
3313 3314 3315 3316 3317 |
# File 'formula.rb', line 3313 def service(&block) return @service_block unless block @service_block = block end |
.sha256(val) ⇒ Object
To verify the cached download’s integrity and security we verify the
SHA-256 hash matches what we’ve declared in the Formula. To quickly fill
this value you can leave it blank and run brew fetch --force
and it’ll
tell you the currently valid value.
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7"
2939 2940 2941 |
# File 'formula.rb', line 2939 def sha256(val) stable.sha256(val) end |
.stable(&block) ⇒ Object
Allows adding depends_on and Patches just to the stable SoftwareSpec. This is required instead of using a conditional. It is preferable to also pull the url and sha256 into the block if one is added.
stable do
url "https://example.com/foo-1.0.tar.gz"
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7"
depends_on "libxml2"
depends_on "libffi"
end
3002 3003 3004 3005 3006 |
# File 'formula.rb', line 3002 def stable(&block) return @stable unless block @stable.instance_eval(&block) end |
.url(val, specs = {}) ⇒ Object
The URL used to download the source for the stable version of the formula.
We prefer https
for security and proxy reasons.
If not inferable, specify the download strategy with using: ...
.
:git
,:hg
,:svn
,:bzr
,:fossil
,:cvs
,:curl
(normal file download, will also extract):nounzip
(without extracting):post
(download via an HTTP POST)
url "https://packed.sources.and.we.prefer.https.example.com/archive-1.2.3.tar.bz2"
url "https://some.dont.provide.archives.example.com",
using: :git,
tag: "1.2.3",
revision: "db8e4de5b2d6653f66aea53094624468caad15d2"
2904 2905 2906 |
# File 'formula.rb', line 2904 def url(val, specs = {}) stable.url(val, specs) end |
.version(val = nil) ⇒ Object
The version string for the stable version of the formula. The version is autodetected from the URL and/or tag so only needs to be declared if it cannot be autodetected correctly.
version "1.2-final"
2914 2915 2916 |
# File 'formula.rb', line 2914 def version(val = nil) stable.version(val) end |
.version_scheme=(value) ⇒ Object (writeonly)
Used for creating new Homebrew version schemes. For example, if we want
to change version scheme from one to another, then we may need to update
version_scheme
of this Formula to be able to use new version scheme,
e.g. to move from 20151020 scheme to 1.0.0 we need to increment
version_scheme
. Without this, the prior scheme will always equate to a
higher version.
0
if unset.
version_scheme 1
2881 |
# File 'formula.rb', line 2881 attr_rw :version_scheme |
Instance Attribute Details
#alias_name ⇒ Object (readonly)
The name of the alias that was used to identify this Formula.
e.g. another-name-for-this-formula
85 86 87 |
# File 'formula.rb', line 85 def alias_name @alias_name end |
#alias_path ⇒ Object (readonly)
The path to the alias that was used to identify this Formula.
e.g. /usr/local/Library/Taps/homebrew/homebrew-core/Aliases/another-name-for-this-formula
81 82 83 |
# File 'formula.rb', line 81 def alias_path @alias_path end |
#build ⇒ BuildOptions
The BuildOptions for this Formula. Lists the arguments passed and any options in the Formula. Note that these may differ at different times during the installation of a Formula. This is annoying but the result of state that we’re trying to eliminate.
170 171 172 |
# File 'formula.rb', line 170 def build @build end |
#buildpath ⇒ Object (readonly)
The current working directory during builds.
Will only be non-nil
inside #install.
149 150 151 |
# File 'formula.rb', line 149 def buildpath @buildpath end |
#follow_installed_alias ⇒ Boolean Also known as: follow_installed_alias?
Whether this formula should be considered outdated if the target of the alias it was installed with has since changed. Defaults to true.
176 177 178 |
# File 'formula.rb', line 176 def follow_installed_alias @follow_installed_alias end |
#full_alias_name ⇒ Object (readonly)
The fully-qualified alias referring to this Formula.
For core formula it’s the same as #alias_name.
e.g. homebrew/tap-name/another-name-for-this-formula
95 96 97 |
# File 'formula.rb', line 95 def full_alias_name @full_alias_name end |
#full_name ⇒ Object (readonly)
90 91 92 |
# File 'formula.rb', line 90 def full_name @full_name end |
#name ⇒ Object (readonly)
The name of this Formula.
e.g. this-formula
77 78 79 |
# File 'formula.rb', line 77 def name @name end |
#path ⇒ Object (readonly)
The full path to this Formula.
e.g. /usr/local/Library/Taps/homebrew/homebrew-core/Formula/this-formula.rb
99 100 101 |
# File 'formula.rb', line 99 def path @path end |
#revision ⇒ Object (readonly)
Used for creating new Homebrew versions of software without new upstream versions.
141 142 143 |
# File 'formula.rb', line 141 def revision @revision end |
#testpath ⇒ Object (readonly)
The current working directory during tests.
Will only be non-nil
inside test.
153 154 155 |
# File 'formula.rb', line 153 def testpath @testpath end |
#version_scheme ⇒ Object (readonly)
Used to change version schemes for packages.
145 146 147 |
# File 'formula.rb', line 145 def version_scheme @version_scheme end |
Class Method Details
.[](name) ⇒ Object
1933 1934 1935 |
# File 'formula.rb', line 1933 def self.[](name) Formulary.factory(name) end |
.conflicts_with(*names) ⇒ Object
One or more formulae that conflict with this one and why.
conflicts_with "imagemagick", because: "both install `convert` binaries"
3177 3178 3179 3180 |
# File 'formula.rb', line 3177 def conflicts_with(*names) opts = names.last.is_a?(Hash) ? names.pop : {} names.each { |name| conflicts << FormulaConflict.new(name, opts[:because]) } end |
.cxxstdlib_check(check_type) ⇒ Object
Pass :skip
to this method to disable post-install stdlib checking.
3211 3212 3213 |
# File 'formula.rb', line 3211 def cxxstdlib_check(check_type) define_method(:skip_cxxstdlib_check?) { true } if check_type == :skip end |
.depends_on(dep) ⇒ Object
The dependencies for this formula. Use strings for the names of other
formulae. Homebrew provides some :special
Requirements for stuff
that needs extra handling (often changing some ENV vars or
deciding whether to use the system provided version).
:build
means this dependency is only needed during build.
depends_on "cmake" => :build
:test
means this dependency is only needed during testing.
depends_on "node" => :test
:recommended
dependencies are built by default.
But a --without-...
option is generated to opt-out.
depends_on "readline" => :recommended
:optional
dependencies are NOT built by default unless the
auto-generated --with-...
option is passed.
depends_on "glib" => :optional
If you need to specify that another formula has to be built with/out
certain options (note, no --
needed before the option):
depends_on "zeromq" => "with-pgm"
depends_on "qt" => ["with-qtdbus", "developer"] # Multiple options.
Optional and enforce that “boost” is built using --with-c++11
.
depends_on "boost" => [:optional, "with-c++11"]
If a dependency is only needed in certain cases:
depends_on "sqlite" if MacOS.version >= :catalina
depends_on xcode: :build # If the formula really needs full Xcode to compile.
depends_on macos: :mojave # Needs at least macOS Mojave (10.14) to run.
It is possible to only depend on something if
build.with?
or build.without? "another_formula"
:
depends_on "postgresql" if build.without? "sqlite"
3083 3084 3085 |
# File 'formula.rb', line 3083 def depends_on(dep) specs.each { |spec| spec.depends_on(dep) } end |
.deprecate!(date:, because:) ⇒ Object
Deprecates a Formula (on the given date) so a warning is shown on each installation. If the date has not yet passed the formula will not be deprecated.
deprecate! date: "2020-08-27", because: :unmaintained
deprecate! date: "2020-08-27", because: "has been replaced by foo"
3374 3375 3376 3377 3378 3379 3380 |
# File 'formula.rb', line 3374 def deprecate!(date:, because:) @deprecation_date = Date.parse(date) return if @deprecation_date > Date.today @deprecation_reason = because @deprecated = true end |
.deprecated? ⇒ Boolean
Whether this Formula is deprecated (i.e. warns on installation). Defaults to false.
3386 3387 3388 |
# File 'formula.rb', line 3386 def deprecated? @deprecated == true end |
.disable!(date:, because:) ⇒ Object
Disables a Formula (on the given date) so it cannot be installed. If the date has not yet passed the formula will be deprecated instead of disabled.
disable! date: "2020-08-27", because: :does_not_build
disable! date: "2020-08-27", because: "has been replaced by foo"
3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 |
# File 'formula.rb', line 3409 def disable!(date:, because:) @disable_date = Date.parse(date) if @disable_date > Date.today @deprecation_reason = because @deprecated = true return end @disable_reason = because @disabled = true end |
.disabled? ⇒ Boolean
Whether this Formula is disabled (i.e. cannot be installed). Defaults to false.
3426 3427 3428 |
# File 'formula.rb', line 3426 def disabled? @disabled == true end |
.fails_with(compiler, &block) ⇒ Object
Marks the Formula as failing with a particular compiler so it will fall back to others. For Apple compilers, this should be in the format:
fails_with :clang do
build 600
cause "multiple configure and compile errors"
end
The block may be omitted, and if present the build may be omitted; if so, then the compiler will not be allowed for all versions.
major_version
should be the major release number only, for instance
‘7’ for the GCC 7 series (7.0, 7.1, etc.).
If version
or the block is omitted, then the compiler will
not be allowed for all compilers in that series.
For example, if a bug is only triggered on GCC 7.1 but is not encountered on 7.2:
fails_with :gcc => '7' do
version '7.1'
end
3236 3237 3238 |
# File 'formula.rb', line 3236 def fails_with(compiler, &block) specs.each { |spec| spec.fails_with(compiler, &block) } end |
.freeze ⇒ Object
2750 2751 2752 2753 2754 2755 2756 2757 2758 |
# File 'formula.rb', line 2750 def freeze specs.each(&:freeze) @livecheck.freeze @conflicts.freeze @skip_clean_paths.freeze @link_overwrite_paths.freeze @allowed_missing_libraries.freeze super end |
.go_resource(name, &block) ⇒ Object
3043 3044 3045 |
# File 'formula.rb', line 3043 def go_resource(name, &block) specs.each { |spec| spec.go_resource(name, &block) } end |
.ignore_missing_libraries(*libs) ⇒ Object
Permit links to certain libraries that don’t exist. Available on Linux only.
3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 |
# File 'formula.rb', line 3454 def ignore_missing_libraries(*libs) odeprecated "ignore_missing_libraries" unless Homebrew::SimulateSystem.simulating_or_running_on_linux? raise FormulaSpecificationError, "#{__method__} is available on Linux only" end libraries = libs.flatten if libraries.any? { |x| !x.is_a?(String) && !x.is_a?(Regexp) } raise FormulaSpecificationError, "#{__method__} can handle Strings and Regular Expressions only" end allowed_missing_libraries.merge(libraries) end |
.inherited(child) ⇒ Object
Initialise instance variables for each subclass. These need to be initialised before the class is frozen, and some DSL may never be called so it can’t be done lazily.
2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 |
# File 'formula.rb', line 2725 def inherited(child) super child.instance_eval do # Ensure this is synced with `freeze` @stable = SoftwareSpec.new(flags: build_flags) @head = HeadSoftwareSpec.new(flags: build_flags) @livecheck = Livecheck.new(self) @conflicts = [] @skip_clean_paths = Set.new @link_overwrite_paths = Set.new @allowed_missing_libraries = Set.new end end |
.installed_with_alias_path(alias_path) ⇒ Object
1878 1879 1880 1881 1882 |
# File 'formula.rb', line 1878 def self.installed_with_alias_path(alias_path) return [] if alias_path.nil? installed.select { |f| f.installed_alias_path == alias_path } end |
.keg_only(reason, explanation = "") ⇒ Object
Software that will not be symlinked into the brew --prefix
and will
only live in its Cellar. Other formulae can depend on it and Homebrew
will add the necessary includes, libraries, and other paths while
building that other formula.
Keg-only formulae are not in your PATH and are not seen by compilers if you build your own software outside of Homebrew. This way, we don’t shadow software provided by macOS.
keg_only :provided_by_macos
keg_only :versioned_formulae
keg_only "because I want it so"
3206 3207 3208 |
# File 'formula.rb', line 3206 def keg_only(reason, explanation = "") @keg_only_reason = KegOnlyReason.new(reason, explanation) end |
.link_overwrite(*paths) ⇒ Object
Permit overwriting certain files while linking.
Sometimes we accidentally install files outside prefix. Once we fix that, users will get a link conflict error. Overwrite those files with:
link_overwrite "bin/foo", "lib/bar"
link_overwrite "share/man/man1/baz-*"
3448 3449 3450 3451 |
# File 'formula.rb', line 3448 def link_overwrite(*paths) paths.flatten! link_overwrite_paths.merge(paths) end |
.livecheckable? ⇒ Boolean
Whether a livecheck specification is defined or not. It returns true when a livecheck block is present in the Formula and false otherwise, and is used by livecheck.
2825 2826 2827 |
# File 'formula.rb', line 2825 def livecheckable? @livecheckable == true end |
.needs(*standards) ⇒ Object
Marks the Formula as needing a certain standard, so Homebrew will fall back to other compilers if the default compiler does not implement that standard.
We generally prefer to depends_on a desired compiler and to
explicitly use that compiler in a formula’s #install block,
rather than implicitly finding a suitable compiler with needs
.
3249 3250 3251 |
# File 'formula.rb', line 3249 def needs(*standards) specs.each { |spec| spec.needs(*standards) } end |
.patch(strip = :p1, src = nil, &block) ⇒ Object
External patches can be declared using resource-style blocks.
patch do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
A strip level of -p1
is assumed. It can be overridden using a symbol
argument:
patch :p0 do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
Patches can be declared in stable and head blocks. This form is preferred over using conditionals.
stable do
patch do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
end
Embedded (__END__
) patches are declared like so:
patch :DATA
patch :p0, :DATA
Patches can also be embedded by passing a string. This makes it possible to provide multiple embedded patches while making only some of them conditional.
patch :p0, "..."
3153 3154 3155 |
# File 'formula.rb', line 3153 def patch(strip = :p1, src = nil, &block) specs.each { |spec| spec.patch(strip, src, &block) } end |
.plist_options(options) ⇒ Object
Please use Homebrew::Service#require_root instead.
Defines launchd plist handling.
Does your plist need to be loaded at startup?
startup: true
Or only when necessary or desired by the user?
manual: "foo"
Or perhaps you’d like to give the user a choice? Ooh fancy.
startup: true, manual: "foo start"
3169 3170 3171 3172 3173 |
# File 'formula.rb', line 3169 def () odeprecated "plist_options", "service.require_root" @plist_startup = [:startup] @plist_manual = [:manual] end |
.pour_bottle?(only_if: nil, &block) ⇒ Boolean
Defines whether the Formula’s bottle can be used on the given Homebrew installation.
For example, if the bottle requires the Xcode CLT to be installed a Formula would declare:
pour_bottle? do
reason "The bottle needs the Xcode CLT to be installed."
satisfy { MacOS::CLT.installed? }
end
If satisfy
returns false
then a bottle will not be used and instead
the Formula will be built from source and reason
will be printed.
Alternatively, a preset reason can be passed as a symbol:
pour_bottle? only_if: :clt_installed
3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 |
# File 'formula.rb', line 3334 def pour_bottle?(only_if: nil, &block) @pour_bottle_check = PourBottleCheck.new(self) if only_if.present? && block.present? raise ArgumentError, "Do not pass both a preset condition and a block to `pour_bottle?`" end block ||= case only_if when :clt_installed lambda do |_| on_macos do T.cast(self, PourBottleCheck).reason(+<<~EOS) The bottle needs the Apple Command Line Tools to be installed. You can install them, if desired, with: xcode-select --install EOS T.cast(self, PourBottleCheck).satisfy { MacOS::CLT.installed? } end end when :default_prefix lambda do |_| T.cast(self, PourBottleCheck).reason(+<<~EOS) The bottle (and many others) needs to be installed into #{Homebrew::DEFAULT_PREFIX}. EOS T.cast(self, PourBottleCheck).satisfy { HOMEBREW_PREFIX.to_s == Homebrew::DEFAULT_PREFIX } end else raise ArgumentError, "Invalid preset `pour_bottle?` condition" if only_if.present? end @pour_bottle_check.instance_eval(&block) end |
.resource(name, klass = Resource, &block) ⇒ Object
Additional downloads can be defined as resources and accessed in the install method. Resources can also be defined inside a stable or head block. This mechanism replaces ad-hoc “subformula” classes.
resource "additional_files" do
url "https://example.com/additional-stuff.tar.gz"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
3037 3038 3039 3040 3041 |
# File 'formula.rb', line 3037 def resource(name, klass = Resource, &block) specs.each do |spec| spec.resource(name, klass, &block) unless spec.resource_defined?(name) end end |
.service? ⇒ Boolean
Whether a service specification is defined or not. It returns true when a service block is present in the Formula and false otherwise, and is used by service.
2832 2833 2834 |
# File 'formula.rb', line 2832 def service? @service_block.present? end |
.skip_clean(*paths) ⇒ Object
Skip cleaning paths in a formula.
Sometimes the formula cleaner breaks things. Preserve cleaned paths with:
skip_clean "bin/foo", "lib/bar"
Keep .la files with:
skip_clean :la
3189 3190 3191 3192 3193 |
# File 'formula.rb', line 3189 def skip_clean(*paths) paths.flatten! # Specifying :all is deprecated and will become an error skip_clean_paths.merge(paths) end |
.test(&block) ⇒ Boolean
A test is required for new formulae and makes us happy. The block will create, run in and delete a temporary directory.
We want tests that don’t require any user input
and test the basic functionality of the application.
For example, foo build-foo input.foo
is a good test
and foo --version
or foo --help
are bad tests.
However, a bad test is better than no test at all.
(testpath/"test.file").write <<~EOS
writing some test file, if you need to
EOS
assert_equal "OK", shell_output("test_command test.file").strip
Need complete control over stdin, stdout?
require "open3"
Open3.popen3("#{bin}/example", "argument") do |stdin, stdout, _|
stdin.write("some text")
stdin.close
assert_equal "result", stdout.read
end
The test will fail if it returns false, or if an exception is raised.
Failed assertions and failed system
commands will raise exceptions.
3281 3282 3283 |
# File 'formula.rb', line 3281 def test(&block) define_method(:test, &block) end |
.uses_from_macos(dep, bounds = {}) ⇒ Object
Indicates use of dependencies provided by macOS.
On macOS this is a no-op (as we use the provided system libraries) unless
:since
specifies a minimum macOS version.
On Linux this will act as depends_on.
3091 3092 3093 |
# File 'formula.rb', line 3091 def uses_from_macos(dep, bounds = {}) specs.each { |spec| spec.uses_from_macos(dep, bounds) } end |
Instance Method Details
#active_log_prefix ⇒ String
The prefix, if any, to use in filenames for logging current activity.
958 959 960 961 962 963 964 |
# File 'formula.rb', line 958 def active_log_prefix if active_log_type "#{active_log_type}." else "" end end |
#add_global_deps_to_spec(spec) ⇒ void
This method returns an undefined value.
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'extend/os/linux/formula.rb', line 29 def add_global_deps_to_spec(spec) return unless DevelopmentTools.needs_build_formulae? @global_deps ||= begin dependency_collector = spec.dependency_collector = Set.new([ name, *aliases, *versioned_formulae_names, ]) [ dependency_collector.gcc_dep_if_needed(), dependency_collector.glibc_dep_if_needed(), ].compact.freeze end @global_deps.each { |dep| spec.dependency_collector.add(dep) } end |
#alias_changed? ⇒ Boolean
Has the alias used to install the formula changed, or are different formulae already installed with this alias?
1441 1442 1443 |
# File 'formula.rb', line 1441 def alias_changed? installed_alias_target_changed? || supersedes_an_installed_formula? end |
#aliases ⇒ Object
All aliases for the formula.
504 505 506 507 508 509 510 511 512 |
# File 'formula.rb', line 504 def aliases @aliases ||= if tap tap.alias_reverse_table[full_name].to_a.map do |a| a.split("/").last end else [] end end |
#any_installed_prefix ⇒ Object
1995 1996 1997 1998 1999 2000 2001 |
# File 'formula.rb', line 1995 def any_installed_prefix if optlinked? && opt_prefix.exist? opt_prefix elsif (latest_installed_prefix = installed_prefixes.last) latest_installed_prefix end end |
#any_installed_version ⇒ Object
Returns the PkgVersion for this formula if it is installed.
If not, return nil
.
2005 2006 2007 |
# File 'formula.rb', line 2005 def any_installed_version any_installed_keg&.version end |
#bash_completion ⇒ Object
The directory where the formula’s Bash completion files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
922 923 924 |
# File 'formula.rb', line 922 def bash_completion prefix/"etc/bash_completion.d" end |
#bin ⇒ Object
The directory where the formula’s binaries should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Need to install into the #bin but the makefile doesn’t mkdir -p prefix/bin
?
bin.mkpath
No make install
available?
bin.install "binary1"
694 695 696 |
# File 'formula.rb', line 694 def bin prefix/"bin" end |
#bottle_hash ⇒ Object
Returns the bottle information for a formula
2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 |
# File 'formula.rb', line 2255 def bottle_hash bottle_spec = stable.bottle_specification hash = { "rebuild" => bottle_spec.rebuild, "root_url" => bottle_spec.root_url, "files" => {}, } bottle_spec.collector.each_tag do |tag| tag_spec = bottle_spec.collector.specification_for(tag) os_cellar = tag_spec.cellar os_cellar = os_cellar.inspect if os_cellar.is_a?(Symbol) checksum = tag_spec.checksum.hexdigest filename = Bottle::Filename.create(self, tag, bottle_spec.rebuild) path, = Utils::Bottles.path_resolved_basename(bottle_spec.root_url, name, checksum, filename) url = "#{bottle_spec.root_url}/#{path}" hash["files"][tag.to_sym] = { "cellar" => os_cellar, "url" => url, "sha256" => checksum, } end hash end |
#bottle_tab_attributes ⇒ Hash
2628 2629 2630 2631 2632 |
# File 'formula.rb', line 2628 def bottle_tab_attributes return {} unless bottled? T.must(bottle).tab_attributes end |
#caveats ⇒ String?
Warn the user about any Homebrew-specific issues or quirks for this package. These should not contain setup instructions that would apply to installation through a different package manager on a different OS.
def caveats
<<~EOS
Are optional. Something the user must be warned about?
EOS
end
def caveats
s = <<~EOS
Print some important notice to the user when `brew info [formula]` is
called or when brewing a formula.
This is optional. You can use all the vars like #{version} here.
EOS
s += "Some issue only on older systems" if MacOS.version < :el_capitan
s
end
1191 1192 1193 |
# File 'formula.rb', line 1191 def caveats nil end |
#current_installed_alias_target ⇒ Object
1421 1422 1423 |
# File 'formula.rb', line 1421 def current_installed_alias_target Formulary.factory(installed_alias_name) if installed_alias_path end |
#deprecated? ⇒ Boolean
Whether this Formula is deprecated (i.e. warns on installation). Defaults to false.
1258 |
# File 'formula.rb', line 1258 delegate deprecated?: :"self.class" |
#deprecation_date ⇒ Object
The date that this Formula was or becomes deprecated.
Returns nil
if no date is specified.
1265 |
# File 'formula.rb', line 1265 delegate deprecation_date: :"self.class" |
#deprecation_reason ⇒ String, Symbol
The reason this Formula is deprecated.
Returns nil
if no reason is specified or the formula is not deprecated.
1272 |
# File 'formula.rb', line 1272 delegate deprecation_reason: :"self.class" |
#desc ⇒ Object
The description of the software.
396 |
# File 'formula.rb', line 396 delegate desc: :"self.class" |
#deuniversalize_machos(*targets) ⇒ void
This method returns an undefined value.
26 |
# File 'extend/os/linux/formula.rb', line 26 def deuniversalize_machos(*targets); end |
#disable_date ⇒ Object
The date that this Formula was or becomes disabled.
Returns nil
if no date is specified.
1286 |
# File 'formula.rb', line 1286 delegate disable_date: :"self.class" |
#disable_reason ⇒ String, Symbol
The reason this Formula is disabled.
Returns nil
if no reason is specified or the formula is not disabled.
1293 |
# File 'formula.rb', line 1293 delegate disable_reason: :"self.class" |
#disabled? ⇒ Boolean
Whether this Formula is disabled (i.e. cannot be installed). Defaults to false.
1279 |
# File 'formula.rb', line 1279 delegate disabled?: :"self.class" |
#doc ⇒ Object
The directory where the formula’s documentation should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
701 702 703 |
# File 'formula.rb', line 701 def doc share/"doc"/name end |
#elisp ⇒ Object
The directory where Emacs Lisp files should be installed, with the formula name appended to avoid linking conflicts.
To install an Emacs mode included with a software package:
elisp.install "contrib/emacs/example-mode.el"
858 859 860 |
# File 'formula.rb', line 858 def elisp prefix/"share/emacs/site-lisp"/name end |
#etc ⇒ Object
The directory where the formula’s configuration files should be installed.
Anything using etc.install
will not overwrite other files on e.g. upgrades
but will write a new file named *.default
.
This directory is not inside the HOMEBREW_CELLAR
so it persists
across upgrades.
883 884 885 |
# File 'formula.rb', line 883 def etc (HOMEBREW_PREFIX/"etc").extend(InstallRenamed) end |
#fetch_bottle_tab ⇒ void
This method returns an undefined value.
2621 2622 2623 2624 2625 |
# File 'formula.rb', line 2621 def fetch_bottle_tab return unless bottled? T.must(bottle).fetch_tab end |
#fetch_patches ⇒ Object
2616 2617 2618 |
# File 'formula.rb', line 2616 def fetch_patches patchlist.select(&:external?).each(&:fetch) end |
#fish_completion ⇒ Object
The directory where the formula’s fish completion files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
938 939 940 |
# File 'formula.rb', line 938 def fish_completion share/"fish/vendor_completions.d" end |
#fish_function ⇒ Object
The directory where the formula’s fish function files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
914 915 916 |
# File 'formula.rb', line 914 def fish_function share/"fish/vendor_functions.d" end |
#frameworks ⇒ Object
The directory where the formula’s Frameworks should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
This is not symlinked into HOMEBREW_PREFIX
.
866 867 868 |
# File 'formula.rb', line 866 def frameworks prefix/"Frameworks" end |
#full_installed_alias_name ⇒ Object
318 319 320 |
# File 'formula.rb', line 318 def full_installed_alias_name full_name_with_optional_tap(installed_alias_name) end |
#full_installed_specified_name ⇒ Object
The name (including tap) specified to install this formula.
349 350 351 |
# File 'formula.rb', line 349 def full_installed_specified_name full_installed_alias_name || full_name end |
#full_specified_name ⇒ Object
The name (including tap) specified to find this formula.
339 340 341 |
# File 'formula.rb', line 339 def full_specified_name full_alias_name || full_name end |
#generate_completions_from_executable(*commands, base_name: name, shells: [:bash, :zsh, :fish], shell_parameter_format: nil) ⇒ void
This method returns an undefined value.
Generate shell completions for a formula for bash, zsh, and fish, using the formula’s executable.
to use for generating the completion scripts.
to the executable
. Takes either a String representing a prefix, or one of [:flag, :arg, :none, :click].
Defaults to plainly passing the shell.
translates to
(bash_completion/”foo”).write Utils.safe_popen_read({ “SHELL” => “bash” }, bin/”foo”, “completions”, “bash”)
(zsh_completion/”_foo”).write Utils.safe_popen_read({ “SHELL” => “zsh” }, bin/”foo”, “completions”, “zsh”)
(fish_completion/”foo.fish”).write Utils.safe_popen_read({ “SHELL” => “fish” }, bin/”foo”, “completions”, “fish”)
translates to
(bash_completion/”bar”).write Utils.safe_popen_read({ “SHELL” => “bash” }, bin/”foo”, “completions”, “bash”)
(zsh_completion/”_bar”).write Utils.safe_popen_read({ “SHELL” => “zsh” }, bin/”foo”, “completions”, “zsh”)
translates to
(bash_completion/”foo”).write Utils.safe_popen_read({ “SHELL” => “bash” }, bin/”foo”, “completions”, “–bash”)
translates to
(bash_completion/”foo”).write Utils.safe_popen_read({ “SHELL” => “bash” }, bin/”foo”, “completions”, “–shell=bash”)
translates to
(bash_completion/”foo”).write Utils.safe_popen_read({ “SHELL” => “bash” }, bin/”foo”, “completions”)
translates to
(zsh_completion/”_foo”).write Utils.safe_popen_read({ “SHELL” => “zsh”, “_FOO_COMPLETE” => “zsh_source” }, bin/”foo”)
translates to
(bash_completion/”foo”).write Utils.safe_popen_read({ “SHELL” => “bash” }, bin/”foo”, “completions”, “–selected-shell=bash”)
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 |
# File 'formula.rb', line 1752 def generate_completions_from_executable(*commands, base_name: name, shells: [:bash, :zsh, :fish], shell_parameter_format: nil) completion_script_path_map = { bash: bash_completion/base_name, zsh: zsh_completion/"_#{base_name}", fish: fish_completion/"#{base_name}.fish", } shells.each do |shell| popen_read_env = { "SHELL" => shell.to_s } script_path = completion_script_path_map[shell] shell_parameter = if shell_parameter_format.nil? shell.to_s elsif shell_parameter_format == :flag "--#{shell}" elsif shell_parameter_format == :arg "--shell=#{shell}" elsif shell_parameter_format == :none nil elsif shell_parameter_format == :click prog_name = File.basename(commands.first.to_s).upcase.tr("-", "_") popen_read_env["_#{prog_name}_COMPLETE"] = "#{shell}_source" nil else "#{shell_parameter_format}#{shell}" end popen_read_args = %w[] popen_read_args << commands popen_read_args << shell_parameter if shell_parameter.present? popen_read_args.flatten! = {} [:err] = :err unless ENV["HOMEBREW_STDERR"] script_path.dirname.mkpath script_path.write Utils.safe_popen_read(popen_read_env, *popen_read_args, **) end end |
#head_version_outdated?(version, fetch_head: false) ⇒ Boolean
596 597 598 599 600 601 602 603 604 605 606 607 608 609 |
# File 'formula.rb', line 596 def head_version_outdated?(version, fetch_head: false) tab = Tab.for_keg(prefix(version)) return true if tab.version_scheme < version_scheme return true if stable && tab.stable_version && tab.stable_version < stable.version return false unless fetch_head return false unless head&.downloader.is_a?(VCSDownloadStrategy) downloader = head.downloader with_context quiet: true do downloader.commit_outdated?(version.version.commit) end end |
#homepage ⇒ Object
The homepage for the software.
406 |
# File 'formula.rb', line 406 delegate homepage: :"self.class" |
#include ⇒ Object
The directory where the formula’s headers should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
include.install "example.h"
711 712 713 |
# File 'formula.rb', line 711 def include prefix/"include" end |
#info ⇒ Object
The directory where the formula’s info files should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
718 719 720 |
# File 'formula.rb', line 718 def info share/"info" end |
#inreplace(paths, before = nil, after = nil, audit_result = true) ⇒ Object
Sometimes we have to change a bit before we install. Mostly we
prefer a patch, but if you need the prefix of
this formula in the patch you have to resort to inreplace
,
because in the patch you don’t have access to any variables
defined by the formula, as only HOMEBREW_PREFIX
is available
in the embedded patch.
inreplace
supports regular expressions:
inreplace "somefile.cfg", /look[for]what?/, "replace by #{bin}/tool"
inreplace
supports blocks:
inreplace "Makefile" do |s|
s.gsub! "/usr/local", HOMEBREW_PREFIX.to_s
end
2371 2372 2373 2374 2375 2376 |
# File 'formula.rb', line 2371 def inreplace(paths, before = nil, after = nil, audit_result = true) # rubocop:disable Style/OptionalBooleanParameter super(paths, before, after, audit_result) rescue Utils::Inreplace::Error => e onoe e.to_s raise BuildError.new(self, "inreplace", paths, {}) end |
#install ⇒ Object
This method is overridden in Formula subclasses to provide the installation instructions. The sources (from url) are downloaded, hash-checked and then Homebrew changes into a temporary directory where the archive is unpacked or repository cloned.
def install
system "./configure", "--prefix=#{prefix}"
system "make", "install"
end
2351 |
# File 'formula.rb', line 2351 def install; end |
#installed_alias_name ⇒ String?
314 315 316 |
# File 'formula.rb', line 314 def installed_alias_name File.basename(installed_alias_path) if installed_alias_path end |
#installed_alias_path ⇒ Object
The alias path that was used to install this formula, if it exists. Can differ from #alias_path, which is the alias used to find the formula, and is specified to this instance.
305 306 307 308 309 310 311 |
# File 'formula.rb', line 305 def installed_alias_path path = build.source["path"] if build.is_a?(Tab) return unless path&.match?(%r{#{HOMEBREW_TAP_DIR_REGEX}/Aliases}o) return unless File.symlink?(path) path end |
#installed_alias_target_changed? ⇒ Boolean
Has the target of the alias used to install this formula changed? Returns false if the formula wasn’t installed with an alias.
1427 1428 1429 1430 1431 1432 |
# File 'formula.rb', line 1427 def installed_alias_target_changed? target = current_installed_alias_target return false unless target target.name != name end |
#installed_specified_name ⇒ Object
The name specified to install this formula.
344 345 346 |
# File 'formula.rb', line 344 def installed_specified_name installed_alias_name || name end |
#keg_only? ⇒ Boolean
Rarely, you don’t want your library symlinked into the main prefix.
See gettext.rb
for an example.
1198 1199 1200 1201 1202 |
# File 'formula.rb', line 1198 def keg_only? return false unless keg_only_reason keg_only_reason.applicable? end |
#kext_prefix ⇒ Object
The directory where the formula’s kernel extensions should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
This is not symlinked into HOMEBREW_PREFIX
.
874 875 876 |
# File 'formula.rb', line 874 def kext_prefix prefix/"Library/Extensions" end |
#latest_formula ⇒ Object
If the alias has changed value, return the new formula. Otherwise, return self.
1447 1448 1449 |
# File 'formula.rb', line 1447 def latest_formula installed_alias_target_changed? ? current_installed_alias_target : self end |
#latest_head_prefix ⇒ Object
591 592 593 594 |
# File 'formula.rb', line 591 def latest_head_prefix head_version = latest_head_version prefix(head_version) if head_version end |
#latest_head_version ⇒ Object
580 581 582 583 584 585 586 587 588 589 |
# File 'formula.rb', line 580 def latest_head_version head_versions = installed_prefixes.map do |pn| pn_pkgversion = PkgVersion.parse(pn.basename.to_s) pn_pkgversion if pn_pkgversion.head? end.compact head_versions.max_by do |pn_pkgversion| [Tab.for_keg(prefix(pn_pkgversion)).source_modified_time, pn_pkgversion.revision] end end |
#launchd_service_path ⇒ Pathname
The generated launchd service file path.
1028 1029 1030 |
# File 'formula.rb', line 1028 def launchd_service_path opt_prefix/"#{plist_name}.plist" end |
#lib ⇒ Object
The directory where the formula’s libraries should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
lib.install "example.dylib"
728 729 730 |
# File 'formula.rb', line 728 def lib prefix/"lib" end |
#libexec ⇒ Object
The directory where the formula’s binaries should be installed.
This is not symlinked into HOMEBREW_PREFIX
.
It is commonly used to install files that we do not wish to be
symlinked into HOMEBREW_PREFIX
from one of the other directories and
instead manually create symlinks or wrapper scripts into e.g. #bin.
libexec.install "foo.jar"
bin.write_jar_script libexec/"foo.jar", "foo"
740 741 742 |
# File 'formula.rb', line 740 def libexec prefix/"libexec" end |
#license ⇒ Object
The SPDX ID of the software license.
401 |
# File 'formula.rb', line 401 delegate license: :"self.class" |
#linked? ⇒ Boolean
Is the formula linked?
638 639 640 |
# File 'formula.rb', line 638 def linked? linked_keg.symlink? end |
#linked_version ⇒ PkgVersion?
PkgVersion of the linked keg for the formula.
656 657 658 659 660 |
# File 'formula.rb', line 656 def linked_version return unless linked? Keg.for(linked_keg).version end |
#livecheck ⇒ Object
The livecheck specification for the software.
411 |
# File 'formula.rb', line 411 delegate livecheck: :"self.class" |
#livecheckable? ⇒ Object
Is a livecheck specification defined for the software?
416 |
# File 'formula.rb', line 416 delegate livecheckable?: :"self.class" |
#loader_path ⇒ String
21 22 23 |
# File 'extend/os/linux/formula.rb', line 21 def loader_path "$ORIGIN" end |
#man ⇒ Object
The root directory where the formula’s manual pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Often one of the more specific man
functions should be used instead,
e.g. #man1.
749 750 751 |
# File 'formula.rb', line 749 def man share/"man" end |
#man1 ⇒ Object
The directory where the formula’s man1 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
man1.install "example.1"
759 760 761 |
# File 'formula.rb', line 759 def man1 man/"man1" end |
#man2 ⇒ Object
The directory where the formula’s man2 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
766 767 768 |
# File 'formula.rb', line 766 def man2 man/"man2" end |
#man3 ⇒ Object
The directory where the formula’s man3 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
man3.install "man.3"
776 777 778 |
# File 'formula.rb', line 776 def man3 man/"man3" end |
#man4 ⇒ Object
The directory where the formula’s man4 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
783 784 785 |
# File 'formula.rb', line 783 def man4 man/"man4" end |
#man5 ⇒ Object
The directory where the formula’s man5 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
790 791 792 |
# File 'formula.rb', line 790 def man5 man/"man5" end |
#man6 ⇒ Object
The directory where the formula’s man6 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
797 798 799 |
# File 'formula.rb', line 797 def man6 man/"man6" end |
#man7 ⇒ Object
The directory where the formula’s man7 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
804 805 806 |
# File 'formula.rb', line 804 def man7 man/"man7" end |
#man8 ⇒ Object
The directory where the formula’s man8 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
811 812 813 |
# File 'formula.rb', line 811 def man8 man/"man8" end |
#migration_needed? ⇒ Boolean
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'formula.rb', line 1369 def migration_needed? return false unless oldname return false if rack.exist? old_rack = HOMEBREW_CELLAR/oldname return false unless old_rack.directory? return false if old_rack.subdirs.empty? tap == Tab.for_keg(old_rack.subdirs.min).tap end |
#missing_dependencies(hide: nil) ⇒ Object
Returns a list of formulae depended on by this formula that aren’t installed.
2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 |
# File 'formula.rb', line 2066 def missing_dependencies(hide: nil) hide ||= [] runtime_formula_dependencies.select do |f| hide.include?(f.name) || f.installed_prefixes.empty? end # If we're still getting unavailable formulae at this stage the best we can # do is just return no results. rescue FormulaUnavailableError [] end |
#mkdir(name, &block) ⇒ Object
A version of FileUtils.mkdir
that also changes to that folder in
a block.
2597 2598 2599 2600 2601 2602 |
# File 'formula.rb', line 2597 def mkdir(name, &block) result = FileUtils.mkdir_p(name) return result unless block FileUtils.chdir(name, &block) end |
#mktemp(prefix = name, opts = {}, &block) ⇒ Object
Create a temporary directory then yield. When the block returns,
recursively delete the temporary directory. Passing opts[:retain]
or calling do |staging| ... staging.retain!
in the block will skip
the deletion and retain the temporary directory’s contents.
2591 2592 2593 |
# File 'formula.rb', line 2591 def mktemp(prefix = name, opts = {}, &block) Mktemp.new(prefix, opts).run(&block) end |
#new_formula_available? ⇒ Boolean
1417 1418 1419 |
# File 'formula.rb', line 1417 def new_formula_available? installed_alias_target_changed? && !latest_formula.latest_version_installed? end |
#old_installed_formulae ⇒ Object
1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'formula.rb', line 1451 def old_installed_formulae # If this formula isn't the current target of the alias, # it doesn't make sense to say that other formulae are older versions of it # because we don't know which came first. return [] if alias_path.nil? || installed_alias_target_changed? self.class.installed_with_alias_path(alias_path).reject { |f| f.name == name } end |
#oldname ⇒ Object
An old name for the formula.
496 497 498 499 500 501 |
# File 'formula.rb', line 496 def oldname @oldname ||= if tap formula_renames = tap.formula_renames formula_renames.to_a.rassoc(name).first if formula_renames.value?(name) end end |
#opt_elisp ⇒ Pathname
1105 1106 1107 |
# File 'formula.rb', line 1105 def opt_elisp opt_prefix/"share/emacs/site-lisp"/name end |
#opt_frameworks ⇒ Pathname
1110 1111 1112 |
# File 'formula.rb', line 1110 def opt_frameworks opt_prefix/"Frameworks" end |
#opt_include ⇒ Pathname
1075 1076 1077 |
# File 'formula.rb', line 1075 def opt_include opt_prefix/"include" end |
#opt_libexec ⇒ Pathname
1085 1086 1087 |
# File 'formula.rb', line 1085 def opt_libexec opt_prefix/"libexec" end |
#opt_pkgshare ⇒ Pathname
1100 1101 1102 |
# File 'formula.rb', line 1100 def opt_pkgshare opt_prefix/"share"/name end |
#opt_prefix ⇒ Pathname
A stable path for this formula, when installed. Contains the formula name but no version number. Only the active version will be linked here if multiple versions are installed.
This is the preferred way to refer to a formula in plists or from another formula, as the path is stable even when the software is updated.
args << "--with-readline=#{Formula["readline"].opt_prefix}" if build.with? "readline"
1065 1066 1067 |
# File 'formula.rb', line 1065 def opt_prefix HOMEBREW_PREFIX/"opt"/name end |
#opt_sbin ⇒ Pathname
1090 1091 1092 |
# File 'formula.rb', line 1090 def opt_sbin opt_prefix/"sbin" end |
#opt_share ⇒ Pathname
1095 1096 1097 |
# File 'formula.rb', line 1095 def opt_share opt_prefix/"share" end |
#option_defined? ⇒ Object
If a named option is defined for the currently active SoftwareSpec.
550 |
# File 'formula.rb', line 550 delegate option_defined?: :active_spec |
#optlinked? ⇒ Boolean
Is the formula linked to opt
?
643 644 645 |
# File 'formula.rb', line 643 def optlinked? opt_prefix.symlink? end |
#pkg_version ⇒ PkgVersion
The PkgVersion for this formula with version and #revision information.
448 449 450 |
# File 'formula.rb', line 448 def pkg_version PkgVersion.new(version, revision) end |
#pkgetc ⇒ Object
A subdirectory of etc
with the formula name suffixed.
e.g. $HOMEBREW_PREFIX/etc/openssl@1.1
Anything using pkgetc.install
will not overwrite other files on
e.g. upgrades but will write a new file named *.default
.
891 892 893 |
# File 'formula.rb', line 891 def pkgetc (HOMEBREW_PREFIX/"etc"/name).extend(InstallRenamed) end |
#pkgshare ⇒ Object
The directory where the formula’s shared files should be installed,
with the name of the formula appended to avoid linking conflicts.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
pkgshare.install "examples"
849 850 851 |
# File 'formula.rb', line 849 def pkgshare prefix/"share"/name end |
#plist ⇒ Object
Please use Homebrew::Service instead.
This method can be overridden to provide a plist.
def plist; <<~EOS
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>#{plist_name}</string>
<key>ProgramArguments</key>
<array>
<string>#{opt_bin}/example</string>
<string>--do-this</string>
</array>
<key>RunAtLoad</key>
<true />
<key>KeepAlive</key>
<true />
<key>StandardErrorPath</key>
<string>/dev/null</string>
<key>StandardOutPath</key>
<string>/dev/null</string>
</dict>
</plist>
EOS
end
1003 1004 1005 |
# File 'formula.rb', line 1003 def plist nil end |
#plist_name ⇒ String
The generated launchd #plist service name.
1009 1010 1011 |
# File 'formula.rb', line 1009 def plist_name "homebrew.mxcl.#{name}" end |
#plist_path ⇒ Pathname
The generated launchd #plist file path.
1021 1022 1023 1024 |
# File 'formula.rb', line 1021 def plist_path odeprecated "formula.plist_path", "formula.launchd_service_path" launchd_service_path end |
#post_install ⇒ void
This method returns an undefined value.
Can be overridden to run commands on both source and bottle installation.
1130 |
# File 'formula.rb', line 1130 def post_install; end |
#pour_bottle? ⇒ Boolean
Indicates that this formula supports bottles. (Not necessarily that one
should be used in the current installation run.)
Can be overridden to selectively disable bottles from formulae.
Defaults to true so overridden version does not have to check if bottles
are supported.
Replaced by pour_bottle?’s satisfy
method if it is specified.
1121 1122 1123 |
# File 'formula.rb', line 1121 def pour_bottle? true end |
#prefix(version = pkg_version) ⇒ Object
The directory in the cellar that the formula is installed to. This directory points to #opt_prefix if it exists and if ##prefix is not called from within the same formula’s #install or #post_install methods. Otherwise, return the full path to the formula’s versioned cellar.
627 628 629 630 631 632 633 634 635 |
# File 'formula.rb', line 627 def prefix(version = pkg_version) versioned_prefix = versioned_prefix(version) if !@prefix_returns_versioned_prefix && version == pkg_version && versioned_prefix.directory? && Keg.new(versioned_prefix).optlinked? opt_prefix else versioned_prefix end end |
#prefix_linked?(version = pkg_version) ⇒ Boolean
If a formula’s linked keg points to the prefix.
648 649 650 651 652 |
# File 'formula.rb', line 648 def prefix_linked?(version = pkg_version) return false unless linked? linked_keg.resolved_path == versioned_prefix(version) end |
#resource ⇒ Object
A named Resource for the currently active SoftwareSpec. Additional downloads can be defined as #resources. Resource#stage will create a temporary directory and yield to a block.
resource("additional_files").stage { bin.install "my/extra/tool" }
493 |
# File 'formula.rb', line 493 delegate resource: :active_spec |
#resources ⇒ Object
The Resources for the currently active SoftwareSpec.
516 |
# File 'formula.rb', line 516 def_delegator :"active_spec.resources", :values, :resources |
#rpath(source: bin, target: lib) ⇒ String
Executable/Library RPATH according to platform conventions.
Optionally specify a source
or target
depending on the location
of the file containing the RPATH command and where its target is located.
rpath #=> "@loader_path/../lib"
rpath(target: frameworks) #=> "@loader_path/../Frameworks"
rpath(source: libexec/"bin") #=> "@loader_path/../../lib"
1629 1630 1631 1632 1633 1634 1635 |
# File 'formula.rb', line 1629 def rpath(source: bin, target: lib) unless target.to_s.start_with?(HOMEBREW_PREFIX) raise "rpath `target` should only be used for paths inside HOMEBREW_PREFIX!" end "#{loader_path}/#{target.relative_path_from(source)}" end |
#runtime_installed_formula_dependents ⇒ Object
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 |
# File 'formula.rb', line 2047 def runtime_installed_formula_dependents # `any_installed_keg` and `runtime_dependencies` `select`s ensure # that we don't end up with something `Formula#runtime_dependencies` can't # read from a `Tab`. Formula.cache[:runtime_installed_formula_dependents] ||= {} Formula.cache[:runtime_installed_formula_dependents][full_name] ||= Formula.installed .select(&:any_installed_keg) .select(&:runtime_dependencies) .select do |f| f.runtime_formula_dependencies.any? do |dep| full_name == dep.full_name rescue name == dep.name end end end |
#sbin ⇒ Object
The directory where the formula’s sbin
binaries should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Generally we try to migrate these to #bin instead.
819 820 821 |
# File 'formula.rb', line 819 def sbin prefix/"sbin" end |
#service ⇒ Object
The service specification of the software.
1045 1046 1047 1048 1049 |
# File 'formula.rb', line 1045 def service return unless service? @service ||= Homebrew::Service.new(self, &self.class.service) end |
#service? ⇒ Object
Is a service specification defined for the software?
421 |
# File 'formula.rb', line 421 delegate service?: :"self.class" |
#service_name ⇒ String
The generated service name.
1015 1016 1017 |
# File 'formula.rb', line 1015 def service_name "homebrew.#{name}" end |
#share ⇒ Object
The directory where the formula’s shared files should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Need a custom directory?
(share/"concept").mkpath
Installing something into another custom directory?
(share/"concept2").install "ducks.txt"
Install ./example_code/simple/ones
to share/demos
:
(share/"demos").install "example_code/simple/ones"
Install ./example_code/simple/ones
to share/demos/examples
:
(share/"demos").install "example_code/simple/ones" => "examples"
838 839 840 |
# File 'formula.rb', line 838 def share prefix/"share" end |
#shared_library(name, version = nil) ⇒ String
11 12 13 14 15 16 17 18 |
# File 'extend/os/linux/formula.rb', line 11 def shared_library(name, version = nil) suffix = if version == "*" || (name == "*" && version.blank?) "{,.*}" elsif version.present? ".#{version}" end "#{name}.so#{suffix}" end |
#skip_cxxstdlib_check? ⇒ Boolean
1296 1297 1298 |
# File 'formula.rb', line 1296 def skip_cxxstdlib_check? false end |
#specified_name ⇒ Object
The name specified to find this formula.
334 335 336 |
# File 'formula.rb', line 334 def specified_name alias_name || name end |
#specified_path ⇒ Object
The path that was specified to find this formula.
323 324 325 326 327 328 329 330 331 |
# File 'formula.rb', line 323 def specified_path default_specified_path = Pathname(alias_path) if alias_path.present? default_specified_path ||= path return default_specified_path if default_specified_path.presence&.exist? return local_bottle_path if local_bottle_path.presence&.exist? default_specified_path end |
#std_cabal_v2_args ⇒ Array<String>
Standard parameters for cabal-v2 builds.
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'formula.rb', line 1575 def std_cabal_v2_args env = T.cast(ENV, T.any(Stdenv, Superenv)) # cabal-install's dependency-resolution backtracking strategy can # easily need more than the default 2,000 maximum number of # "backjumps," since Hackage is a fast-moving, rolling-release # target. The highest known needed value by a formula was 43,478 # for git-annex, so 100,000 should be enough to avoid most # gratuitous backjumps build failures. ["--jobs=#{env.make_jobs}", "--max-backjumps=100000", "--install-method=copy", "--installdir=#{bin}"] end |
#std_cargo_args(root: prefix, path: ".") ⇒ Array<String, Pathname>
Standard parameters for cargo builds.
1525 1526 1527 |
# File 'formula.rb', line 1525 def std_cargo_args(root: prefix, path: ".") ["--locked", "--root", root, "--path", path] end |
#std_cmake_args(install_prefix: prefix, install_libdir: "lib", find_framework: "LAST") ⇒ Array<String>
Standard parameters for CMake builds.
Setting CMAKE_FIND_FRAMEWORK
to “LAST” tells CMake to search for our
libraries before trying to utilize Frameworks, many of which will be from
3rd party installs.
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 |
# File 'formula.rb', line 1541 def std_cmake_args(install_prefix: prefix, install_libdir: "lib", find_framework: "LAST") args = %W[ -DCMAKE_INSTALL_PREFIX=#{install_prefix} -DCMAKE_INSTALL_LIBDIR=#{install_libdir} -DCMAKE_BUILD_TYPE=Release -DCMAKE_FIND_FRAMEWORK=#{find_framework} -DCMAKE_VERBOSE_MAKEFILE=ON -Wno-dev -DBUILD_TESTING=OFF ] # Avoid false positives for clock_gettime support on 10.11. # CMake cache entries for other weak symbols may be added here as needed. args << "-DHAVE_CLOCK_GETTIME:INTERNAL=0" if MacOS.version == "10.11" && MacOS::Xcode.version >= "8.0" # Ensure CMake is using the same SDK we are using. args << "-DCMAKE_OSX_SYSROOT=#{MacOS.sdk_for_formula(self).path}" if MacOS.sdk_root_needed? args end |
#std_configure_args ⇒ Array<String>
Standard parameters for configure builds.
1519 1520 1521 |
# File 'formula.rb', line 1519 def std_configure_args ["--disable-debug", "--disable-dependency-tracking", "--prefix=#{prefix}", "--libdir=#{lib}"] end |
#std_go_args(output: bin/name, ldflags: nil) ⇒ Array<String>
Standard parameters for Go builds.
1567 1568 1569 1570 1571 |
# File 'formula.rb', line 1567 def std_go_args(output: bin/name, ldflags: nil) args = ["-trimpath", "-o=#{output}"] args += ["-ldflags=#{Array(ldflags).join(" ")}"] if ldflags args end |
#std_meson_args ⇒ Array<String>
Standard parameters for meson builds.
1589 1590 1591 |
# File 'formula.rb', line 1589 def std_meson_args ["--prefix=#{prefix}", "--libdir=#{lib}", "--buildtype=release", "--wrap-mode=nofallback"] end |
#supersedes_an_installed_formula? ⇒ Boolean
Is this formula the target of an alias used to install an old formula?
1435 1436 1437 |
# File 'formula.rb', line 1435 def supersedes_an_installed_formula? old_installed_formulae.any? end |
#system(cmd, *args) ⇒ void
This method returns an undefined value.
To call out to the system, we use the system
method and we prefer
you give the args separately as in the line below, otherwise a subshell
has to be opened first.
system "./bootstrap.sh", "--arg1", "--prefix=#{prefix}"
For CMake and other build systems we have some necessary defaults in e.g. #std_cmake_args:
system "cmake", ".", *std_cmake_args
If the arguments given to configure
(or make
or cmake
) are depending
on options defined above, we usually make a list first and then
use the args << if <condition>
to append each:
args = ["--with-option1", "--with-option2"]
args << "--without-gcc" if ENV.compiler == :clang
# Most software still uses `configure` and `make`.
# Check with `./configure --help` for what our options are.
system "./configure", "--disable-debug", "--disable-dependency-tracking",
"--disable-silent-rules", "--prefix=#{prefix}",
*args # our custom arg list (needs `*` to unpack)
# If there is a "make install" available, please use it!
system "make", "install"
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 |
# File 'formula.rb', line 2447 def system(cmd, *args) verbose_using_dots = Homebrew::EnvConfig.verbose_using_dots? # remove "boring" arguments so that the important ones are more likely to # be shown considering that we trim long ohai lines to the terminal width pretty_args = args.dup unless verbose? case cmd when "./configure" pretty_args -= %w[--disable-dependency-tracking --disable-debug --disable-silent-rules] when "cargo" pretty_args -= std_cargo_args when "cmake" pretty_args -= std_cmake_args when "go" pretty_args -= std_go_args end end pretty_args.each_index do |i| pretty_args[i] = "import setuptools..." if pretty_args[i].to_s.start_with? "import setuptools" end ohai "#{cmd} #{pretty_args * " "}".strip @exec_count ||= 0 @exec_count += 1 logfn = format("#{logs}/#{active_log_prefix}%02<exec_count>d.%<cmd_base>s", exec_count: @exec_count, cmd_base: File.basename(cmd).split.first) logs.mkpath File.open(logfn, "w") do |log| log.puts Time.now, "", cmd, args, "" log.flush if verbose? rd, wr = IO.pipe begin pid = fork do rd.close log.close exec_cmd(cmd, args, wr, logfn) end wr.close if verbose_using_dots last_dot = Time.at(0) while (buf = rd.gets) log.puts buf # make sure dots printed with interval of at least 1 min. next unless (Time.now - last_dot) > 60 print "." $stdout.flush last_dot = Time.now end puts else while (buf = rd.gets) log.puts buf puts buf end end ensure rd.close end else pid = fork do exec_cmd(cmd, args, log, logfn) end end Process.wait(T.must(pid)) $stdout.flush unless $CHILD_STATUS.success? log_lines = Homebrew::EnvConfig.fail_log_lines log.flush if !verbose? || verbose_using_dots puts "Last #{log_lines} lines from #{logfn}:" Kernel.system "/usr/bin/tail", "-n", log_lines.to_s, logfn end log.puts require "system_config" require "build_environment" env = ENV.to_hash SystemConfig.dump_verbose_config(log) log.puts BuildEnvironment.dump env, log raise BuildError.new(self, cmd, args, env) end end end |
#systemd_service_path ⇒ Pathname
The generated systemd service file path.
1034 1035 1036 |
# File 'formula.rb', line 1034 def systemd_service_path opt_prefix/"#{service_name}.service" end |
#systemd_timer_path ⇒ Pathname
The generated systemd timer file path.
1040 1041 1042 |
# File 'formula.rb', line 1040 def systemd_timer_path opt_prefix/"#{service_name}.timer" end |
#time ⇒ Time
Creates a new Time
object for use in the formula as the build time.
1646 1647 1648 1649 1650 1651 1652 |
# File 'formula.rb', line 1646 def time if ENV["SOURCE_DATE_EPOCH"].present? Time.at(ENV["SOURCE_DATE_EPOCH"].to_i).utc else Time.now.utc end end |
#to_s ⇒ Object
1507 1508 1509 |
# File 'formula.rb', line 1507 def to_s name end |
#update_head_version ⇒ Object
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
# File 'formula.rb', line 430 def update_head_version return unless head? return unless head.downloader.is_a?(VCSDownloadStrategy) return unless head.downloader.cached_location.exist? path = if ENV["HOMEBREW_ENV"] ENV.fetch("PATH") else PATH.new(ORIGINAL_PATHS) end with_env(PATH: path) do head.version.update_commit(head.downloader.last_commit) end end |
#var ⇒ Object
The directory where the formula’s variable files should be installed.
This directory is not inside the HOMEBREW_CELLAR
so it persists
across upgrades.
898 899 900 |
# File 'formula.rb', line 898 def var HOMEBREW_PREFIX/"var" end |
#version ⇒ Object
The version for the currently active SoftwareSpec. The version is autodetected from the URL and/or tag so only needs to be declared if it cannot be autodetected correctly.
428 |
# File 'formula.rb', line 428 delegate version: :active_spec |
#versioned_formula? ⇒ Boolean
If this is a @
-versioned formula.
454 455 456 |
# File 'formula.rb', line 454 def versioned_formula? name.include?("@") end |
#versioned_formulae ⇒ Array<Formula>
Returns any @
-versioned Formula objects for any Formula (including versioned formulae).
480 481 482 483 484 485 486 |
# File 'formula.rb', line 480 def versioned_formulae versioned_formulae_names.map do |name| Formula[name] rescue FormulaUnavailableError nil end.compact.sort_by(&:version).reverse end |
#versioned_formulae_names ⇒ Array<String>
Returns any @
-versioned formulae names for any formula (including versioned formulae).
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
# File 'formula.rb', line 460 def versioned_formulae_names versioned_paths = if tap # Faster path, due to `tap.versioned_formula_files` caching. name_prefix = "#{name.gsub(/(@[\d.]+)?$/, "")}@" tap.versioned_formula_files.select do |file| file.basename.to_s.start_with?(name_prefix) end else Pathname.glob(path.to_s.gsub(/(@[\d.]+)?\.rb$/, "@*.rb")) end versioned_paths.map do |versioned_path| next if versioned_path == path versioned_path.basename(".rb").to_s end.compact.sort end |
#with_logging(log_type) ⇒ Object
Runs a block with the given log type in effect for its duration.
967 968 969 970 971 972 973 |
# File 'formula.rb', line 967 def with_logging(log_type) old_log_type = @active_log_type @active_log_type = log_type yield ensure @active_log_type = old_log_type end |
#xcodebuild(*args) ⇒ void
This method returns an undefined value.
Runs xcodebuild
without Homebrew’s compiler environment variables set.
2606 2607 2608 2609 2610 2611 2612 2613 2614 |
# File 'formula.rb', line 2606 def xcodebuild(*args) removed = ENV.remove_cc_etc begin T.unsafe(self).system("xcodebuild", *args) ensure ENV.update(removed) end end |
#zsh_completion ⇒ Object
The directory where the formula’s zsh completion files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
930 931 932 |
# File 'formula.rb', line 930 def zsh_completion share/"zsh/site-functions" end |
#zsh_function ⇒ Object
The directory where the formula’s zsh function files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
906 907 908 |
# File 'formula.rb', line 906 def zsh_function share/"zsh/site-functions" end |