Class: Formula Abstract
- Inherits:
-
Object
- Object
- Formula
- Extended by:
- BuildEnvironment::DSL, Cachable, Forwardable, OnSystem::MacOSAndLinux, Predicable
- Includes:
- Context, FileUtils, 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 Utils::Shell
Utils::Shell::SHELL_PROFILE_MAP, Utils::Shell::UNSAFE_SHELL_CHAR
Class Attribute Summary collapse
-
.bottle(*args, &block) ⇒ Object
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.
-
.go_resource(name, &block) ⇒ Object
-
.ignore_missing_libraries(*libs) ⇒ Object
Permit links to certain libraries that don’t exist.
-
.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
Defines launchd plist handling.
-
.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.
-
#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
Replaces a universal binary with its native slice.
-
#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
-
#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?.
-
#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
This method can be overridden to provide a plist.
-
#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(v = pkg_version) ⇒ Object
The directory in the cellar that the formula is installed to.
-
#prefix_linked?(v = 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 ⇒ 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
Shared library names according to platform conventions.
-
#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_recursive_bottle_hash(top_level: true) ⇒ Object
private
Generate a hash to be used to install a formula from a JSON file.
-
#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 ⇒ Object
Returns any
@
-versioned formulae 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 Context
current, current=, #debug?, #quiet?, #verbose?, #with_context
Methods included from Utils::Shell
csh_quote, export_value, from_path, parent, preferred, 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(*args, &block) ⇒ Object
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"
2865 2866 2867 |
# File 'formula.rb', line 2865 def bottle(*args, &block) stable.bottle(*args, &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"
3013 3014 3015 |
# File 'formula.rb', line 3013 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.
3297 3298 3299 |
# File 'formula.rb', line 3297 def deprecation_date @deprecation_date end |
.deprecation_reason ⇒ nil, ... (readonly)
The reason for deprecation of a Formula.
3303 3304 3305 |
# File 'formula.rb', line 3303 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"
2687 |
# File 'formula.rb', line 2687 attr_rw :desc |
.disable_date ⇒ Object (readonly)
The date that this Formula was or becomes disabled.
Returns nil
if no date is specified.
3337 3338 3339 |
# File 'formula.rb', line 3337 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.
3343 3344 3345 |
# File 'formula.rb', line 3343 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
2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 |
# File 'formula.rb', line 2915 def head(val = nil, specs = {}, &block) @head ||= HeadSoftwareSpec.new(flags: build_flags) 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"
2727 |
# File 'formula.rb', line 2727 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" },
]
2712 2713 2714 2715 2716 2717 2718 |
# File 'formula.rb', line 2712 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
3199 3200 3201 3202 3203 3204 3205 |
# File 'formula.rb', line 3199 def livecheck(&block) @livecheck ||= Livecheck.new(self) 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
2822 2823 2824 |
# File 'formula.rb', line 2822 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
3004 3005 3006 |
# File 'formula.rb', line 3004 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
2764 |
# File 'formula.rb', line 2764 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 plist.
service do
run [opt_bin/"foo"]
end
3216 3217 3218 3219 3220 |
# File 'formula.rb', line 3216 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"
2834 2835 2836 |
# File 'formula.rb', line 2834 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 preferrable 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
2896 2897 2898 2899 2900 2901 |
# File 'formula.rb', line 2896 def stable(&block) @stable ||= SoftwareSpec.new(flags: build_flags) 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 inferrable, 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"
2799 2800 2801 |
# File 'formula.rb', line 2799 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"
2809 2810 2811 |
# File 'formula.rb', line 2809 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
2776 |
# File 'formula.rb', line 2776 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
82 83 84 |
# File 'formula.rb', line 82 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
78 79 80 |
# File 'formula.rb', line 78 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.
167 168 169 |
# File 'formula.rb', line 167 def build @build end |
#buildpath ⇒ Object (readonly)
The current working directory during builds.
Will only be non-nil
inside #install.
146 147 148 |
# File 'formula.rb', line 146 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.
173 174 175 |
# File 'formula.rb', line 173 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
92 93 94 |
# File 'formula.rb', line 92 def full_alias_name @full_alias_name end |
#full_name ⇒ Object (readonly)
87 88 89 |
# File 'formula.rb', line 87 def full_name @full_name end |
#name ⇒ Object (readonly)
The name of this Formula.
e.g. this-formula
74 75 76 |
# File 'formula.rb', line 74 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
96 97 98 |
# File 'formula.rb', line 96 def path @path end |
#revision ⇒ Object (readonly)
Used for creating new Homebrew versions of software without new upstream versions.
138 139 140 |
# File 'formula.rb', line 138 def revision @revision end |
#testpath ⇒ Object (readonly)
The current working directory during tests.
Will only be non-nil
inside test.
150 151 152 |
# File 'formula.rb', line 150 def testpath @testpath end |
#version_scheme ⇒ Object (readonly)
Used to change version schemes for packages.
142 143 144 |
# File 'formula.rb', line 142 def version_scheme @version_scheme end |
Class Method Details
.[](name) ⇒ Object
1893 1894 1895 |
# File 'formula.rb', line 1893 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"
3074 3075 3076 3077 |
# File 'formula.rb', line 3074 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.
3113 3114 3115 |
# File 'formula.rb', line 3113 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 with --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"
2979 2980 2981 |
# File 'formula.rb', line 2979 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"
3277 3278 3279 3280 3281 3282 3283 |
# File 'formula.rb', line 3277 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.
3289 3290 3291 |
# File 'formula.rb', line 3289 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"
3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 |
# File 'formula.rb', line 3312 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.
3329 3330 3331 |
# File 'formula.rb', line 3329 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
3138 3139 3140 |
# File 'formula.rb', line 3138 def fails_with(compiler, &block) specs.each { |spec| spec.fails_with(compiler, &block) } end |
.go_resource(name, &block) ⇒ Object
2939 2940 2941 |
# File 'formula.rb', line 2939 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.
3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 |
# File 'formula.rb', line 3362 def ignore_missing_libraries(*libs) 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 |
.installed_with_alias_path(alias_path) ⇒ Object
1838 1839 1840 1841 1842 |
# File 'formula.rb', line 1838 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"
3108 3109 3110 |
# File 'formula.rb', line 3108 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-*"
3351 3352 3353 3354 |
# File 'formula.rb', line 3351 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.
2732 2733 2734 |
# File 'formula.rb', line 2732 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
.
3151 3152 3153 |
# File 'formula.rb', line 3151 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, "..."
3048 3049 3050 |
# File 'formula.rb', line 3048 def patch(strip = :p1, src = nil, &block) specs.each { |spec| spec.patch(strip, src, &block) } end |
.plist_options(options) ⇒ Object
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"
3062 3063 3064 3065 |
# File 'formula.rb', line 3062 def () @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
3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 |
# File 'formula.rb', line 3237 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 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
2933 2934 2935 2936 2937 |
# File 'formula.rb', line 2933 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.
2739 2740 2741 |
# File 'formula.rb', line 2739 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
3086 3087 3088 3089 3090 |
# File 'formula.rb', line 3086 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.
3183 3184 3185 |
# File 'formula.rb', line 3183 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). On Linux this will act as depends_on.
2986 2987 2988 |
# File 'formula.rb', line 2986 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.
923 924 925 926 927 928 929 |
# File 'formula.rb', line 923 def active_log_prefix if active_log_type "#{active_log_type}." else "" end end |
#alias_changed? ⇒ Boolean
Has the alias used to install the formula changed, or are different formulae already installed with this alias?
1397 1398 1399 |
# File 'formula.rb', line 1397 def alias_changed? installed_alias_target_changed? || supersedes_an_installed_formula? end |
#aliases ⇒ Object
All aliases for the formula.
469 470 471 472 473 474 475 476 477 |
# File 'formula.rb', line 469 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
1950 1951 1952 1953 1954 1955 1956 |
# File 'formula.rb', line 1950 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
.
1960 1961 1962 |
# File 'formula.rb', line 1960 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.
887 888 889 |
# File 'formula.rb', line 887 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"
659 660 661 |
# File 'formula.rb', line 659 def bin prefix/"bin" end |
#bottle_hash ⇒ Object
Returns the bottle information for a formula
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 |
# File 'formula.rb', line 2195 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
2567 2568 2569 2570 2571 |
# File 'formula.rb', line 2567 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
1147 1148 1149 |
# File 'formula.rb', line 1147 def caveats nil end |
#current_installed_alias_target ⇒ Object
1377 1378 1379 |
# File 'formula.rb', line 1377 def current_installed_alias_target Formulary.factory(installed_alias_path) if installed_alias_path end |
#deprecated? ⇒ Boolean
Whether this Formula is deprecated (i.e. warns on installation). Defaults to false.
1214 |
# File 'formula.rb', line 1214 delegate deprecated?: :"self.class" |
#deprecation_date ⇒ Object
The date that this Formula was or becomes deprecated.
Returns nil
if no date is specified.
1221 |
# File 'formula.rb', line 1221 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.
1228 |
# File 'formula.rb', line 1228 delegate deprecation_reason: :"self.class" |
#desc ⇒ Object
The description of the software.
381 |
# File 'formula.rb', line 381 delegate desc: :"self.class" |
#deuniversalize_machos(*targets) ⇒ void
25 |
# File 'extend/os/linux/formula.rb', line 25 def deuniversalize_machos(*targets); end |
#disable_date ⇒ Object
The date that this Formula was or becomes disabled.
Returns nil
if no date is specified.
1242 |
# File 'formula.rb', line 1242 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.
1249 |
# File 'formula.rb', line 1249 delegate disable_reason: :"self.class" |
#disabled? ⇒ Boolean
Whether this Formula is disabled (i.e. cannot be installed). Defaults to false.
1235 |
# File 'formula.rb', line 1235 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.
666 667 668 |
# File 'formula.rb', line 666 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"
823 824 825 |
# File 'formula.rb', line 823 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.
848 849 850 |
# File 'formula.rb', line 848 def etc (HOMEBREW_PREFIX/"etc").extend(InstallRenamed) end |
#fetch_bottle_tab ⇒ void
This method returns an undefined value.
2560 2561 2562 2563 2564 |
# File 'formula.rb', line 2560 def fetch_bottle_tab return unless bottled? T.must(bottle).fetch_tab end |
#fetch_patches ⇒ Object
2555 2556 2557 |
# File 'formula.rb', line 2555 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.
903 904 905 |
# File 'formula.rb', line 903 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.
879 880 881 |
# File 'formula.rb', line 879 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
.
831 832 833 |
# File 'formula.rb', line 831 def frameworks prefix/"Frameworks" end |
#full_installed_alias_name ⇒ Object
303 304 305 |
# File 'formula.rb', line 303 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.
334 335 336 |
# File 'formula.rb', line 334 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.
324 325 326 |
# File 'formula.rb', line 324 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].
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
(bash_completion/”foo”).write Utils.safe_popen_read({ “SHELL” => “bash” }, bin/”foo”, “completions”, “–selected-shell=bash”)
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 |
# File 'formula.rb', line 1683 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| 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 "" else "#{shell_parameter_format}#{shell}" end popen_read_args = %w[] popen_read_args << commands popen_read_args << shell_parameter popen_read_args.flatten! script_path.dirname.mkpath script_path.write Utils.safe_popen_read({ "SHELL" => shell.to_s }, *popen_read_args) end end |
#head_version_outdated?(version, fetch_head: false) ⇒ Boolean
561 562 563 564 565 566 567 568 569 570 571 572 573 574 |
# File 'formula.rb', line 561 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.
391 |
# File 'formula.rb', line 391 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"
676 677 678 |
# File 'formula.rb', line 676 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.
683 684 685 |
# File 'formula.rb', line 683 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
2311 2312 2313 2314 2315 |
# File 'formula.rb', line 2311 def inreplace(paths, before = nil, after = nil, audit_result = true) # rubocop:disable Style/OptionalBooleanParameter super(paths, before, after, audit_result) rescue Utils::Inreplace::Error 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
2291 |
# File 'formula.rb', line 2291 def install; end |
#installed_alias_name ⇒ String?
299 300 301 |
# File 'formula.rb', line 299 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.
290 291 292 293 294 295 296 |
# File 'formula.rb', line 290 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.
1383 1384 1385 1386 1387 1388 |
# File 'formula.rb', line 1383 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.
329 330 331 |
# File 'formula.rb', line 329 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.
1154 1155 1156 1157 1158 |
# File 'formula.rb', line 1154 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
.
839 840 841 |
# File 'formula.rb', line 839 def kext_prefix prefix/"Library/Extensions" end |
#latest_formula ⇒ Object
If the alias has changed value, return the new formula. Otherwise, return self.
1403 1404 1405 |
# File 'formula.rb', line 1403 def latest_formula installed_alias_target_changed? ? current_installed_alias_target : self end |
#latest_head_prefix ⇒ Object
556 557 558 559 |
# File 'formula.rb', line 556 def latest_head_prefix head_version = latest_head_version prefix(head_version) if head_version end |
#latest_head_version ⇒ Object
545 546 547 548 549 550 551 552 553 554 |
# File 'formula.rb', line 545 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 |
#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"
693 694 695 |
# File 'formula.rb', line 693 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"
705 706 707 |
# File 'formula.rb', line 705 def libexec prefix/"libexec" end |
#license ⇒ Object
The SPDX ID of the software license.
386 |
# File 'formula.rb', line 386 delegate license: :"self.class" |
#linked? ⇒ Boolean
Is the formula linked?
603 604 605 |
# File 'formula.rb', line 603 def linked? linked_keg.symlink? end |
#linked_version ⇒ PkgVersion?
PkgVersion of the linked keg for the formula.
621 622 623 624 625 |
# File 'formula.rb', line 621 def linked_version return unless linked? Keg.for(linked_keg).version end |
#livecheck ⇒ Object
The livecheck specification for the software.
396 |
# File 'formula.rb', line 396 delegate livecheck: :"self.class" |
#livecheckable? ⇒ Object
Is a livecheck specification defined for the software?
401 |
# File 'formula.rb', line 401 delegate livecheckable?: :"self.class" |
#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.
714 715 716 |
# File 'formula.rb', line 714 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"
724 725 726 |
# File 'formula.rb', line 724 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.
731 732 733 |
# File 'formula.rb', line 731 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"
741 742 743 |
# File 'formula.rb', line 741 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.
748 749 750 |
# File 'formula.rb', line 748 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.
755 756 757 |
# File 'formula.rb', line 755 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.
762 763 764 |
# File 'formula.rb', line 762 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.
769 770 771 |
# File 'formula.rb', line 769 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.
776 777 778 |
# File 'formula.rb', line 776 def man8 man/"man8" end |
#migration_needed? ⇒ Boolean
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'formula.rb', line 1325 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.
2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 |
# File 'formula.rb', line 2021 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.
2536 2537 2538 2539 2540 2541 |
# File 'formula.rb', line 2536 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.
2530 2531 2532 |
# File 'formula.rb', line 2530 def mktemp(prefix = name, opts = {}, &block) Mktemp.new(prefix, opts).run(&block) end |
#new_formula_available? ⇒ Boolean
1373 1374 1375 |
# File 'formula.rb', line 1373 def new_formula_available? installed_alias_target_changed? && !latest_formula.latest_version_installed? end |
#old_installed_formulae ⇒ Object
1407 1408 1409 1410 1411 1412 1413 1414 |
# File 'formula.rb', line 1407 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.
461 462 463 464 465 466 |
# File 'formula.rb', line 461 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
1061 1062 1063 |
# File 'formula.rb', line 1061 def opt_elisp opt_prefix/"share/emacs/site-lisp"/name end |
#opt_frameworks ⇒ Pathname
1066 1067 1068 |
# File 'formula.rb', line 1066 def opt_frameworks opt_prefix/"Frameworks" end |
#opt_include ⇒ Pathname
1031 1032 1033 |
# File 'formula.rb', line 1031 def opt_include opt_prefix/"include" end |
#opt_libexec ⇒ Pathname
1041 1042 1043 |
# File 'formula.rb', line 1041 def opt_libexec opt_prefix/"libexec" end |
#opt_pkgshare ⇒ Pathname
1056 1057 1058 |
# File 'formula.rb', line 1056 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"
1021 1022 1023 |
# File 'formula.rb', line 1021 def opt_prefix HOMEBREW_PREFIX/"opt"/name end |
#opt_sbin ⇒ Pathname
1046 1047 1048 |
# File 'formula.rb', line 1046 def opt_sbin opt_prefix/"sbin" end |
#opt_share ⇒ Pathname
1051 1052 1053 |
# File 'formula.rb', line 1051 def opt_share opt_prefix/"share" end |
#option_defined? ⇒ Object
If a named option is defined for the currently active SoftwareSpec.
515 |
# File 'formula.rb', line 515 delegate option_defined?: :active_spec |
#optlinked? ⇒ Boolean
Is the formula linked to opt
?
608 609 610 |
# File 'formula.rb', line 608 def optlinked? opt_prefix.symlink? end |
#pkg_version ⇒ PkgVersion
The PkgVersion for this formula with version and #revision information.
433 434 435 |
# File 'formula.rb', line 433 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
.
856 857 858 |
# File 'formula.rb', line 856 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"
814 815 816 |
# File 'formula.rb', line 814 def pkgshare prefix/"share"/name end |
#plist ⇒ Object
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
966 967 968 |
# File 'formula.rb', line 966 def plist nil end |
#plist_name ⇒ String
The generated launchd #plist service name.
972 973 974 |
# File 'formula.rb', line 972 def plist_name "homebrew.mxcl.#{name}" end |
#plist_path ⇒ Pathname
The generated launchd #plist file path.
984 985 986 |
# File 'formula.rb', line 984 def plist_path opt_prefix/"#{plist_name}.plist" end |
#post_install ⇒ void
This method returns an undefined value.
Can be overridden to run commands on both source and bottle installation.
1086 |
# File 'formula.rb', line 1086 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.
1077 1078 1079 |
# File 'formula.rb', line 1077 def pour_bottle? true end |
#prefix(v = 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.
592 593 594 595 596 597 598 599 600 |
# File 'formula.rb', line 592 def prefix(v = pkg_version) versioned_prefix = versioned_prefix(v) if !@prefix_returns_versioned_prefix && v == pkg_version && versioned_prefix.directory? && Keg.new(versioned_prefix).optlinked? opt_prefix else versioned_prefix end end |
#prefix_linked?(v = pkg_version) ⇒ Boolean
If a formula’s linked keg points to the prefix.
613 614 615 616 617 |
# File 'formula.rb', line 613 def prefix_linked?(v = pkg_version) return false unless linked? linked_keg.resolved_path == versioned_prefix(v) 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" }
458 |
# File 'formula.rb', line 458 delegate resource: :active_spec |
#resources ⇒ Object
The Resources for the currently active SoftwareSpec.
481 |
# File 'formula.rb', line 481 def_delegator :"active_spec.resources", :values, :resources |
#rpath ⇒ String
Executable/Library RPATH according to platform conventions.
20 21 22 |
# File 'extend/os/linux/formula.rb', line 20 def rpath "'$ORIGIN/../lib'" end |
#runtime_installed_formula_dependents ⇒ Object
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'formula.rb', line 2002 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.
784 785 786 |
# File 'formula.rb', line 784 def sbin prefix/"sbin" end |
#service ⇒ Object
The service specification of the software.
1001 1002 1003 1004 1005 |
# File 'formula.rb', line 1001 def service return unless service? Homebrew::Service.new(self, &self.class.service) end |
#service? ⇒ Object
Is a service specification defined for the software?
406 |
# File 'formula.rb', line 406 delegate service?: :"self.class" |
#service_name ⇒ String
The generated service name.
978 979 980 |
# File 'formula.rb', line 978 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"
803 804 805 |
# File 'formula.rb', line 803 def share prefix/"share" end |
#shared_library(name, version = nil) ⇒ String
Shared library names according to platform conventions.
Optionally specify a version
to restrict the shared library to a specific
version. The special string “*” matches any version.
If name
is specified as “*”, match any shared library of any version.
shared_library("foo") #=> foo.dylib
shared_library("foo", 1) #=> foo.1.dylib
shared_library("foo", "*") #=> foo.2.dylib, foo.1.dylib, foo.dylib
shared_library("*") #=> foo.dylib, bar.dylib
10 11 12 13 14 15 16 17 |
# File 'extend/os/linux/formula.rb', line 10 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
1252 1253 1254 |
# File 'formula.rb', line 1252 def skip_cxxstdlib_check? false end |
#specified_name ⇒ Object
The name specified to find this formula.
319 320 321 |
# File 'formula.rb', line 319 def specified_name alias_name || name end |
#specified_path ⇒ Object
The path that was specified to find this formula.
308 309 310 311 312 313 314 315 316 |
# File 'formula.rb', line 308 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.
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 |
# File 'formula.rb', line 1531 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.
1481 1482 1483 |
# File 'formula.rb', line 1481 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.
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 |
# File 'formula.rb', line 1497 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.
1475 1476 1477 |
# File 'formula.rb', line 1475 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.
1523 1524 1525 1526 1527 |
# File 'formula.rb', line 1523 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.
1545 1546 1547 |
# File 'formula.rb', line 1545 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?
1391 1392 1393 |
# File 'formula.rb', line 1391 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"
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 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 |
# File 'formula.rb', line 2386 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, 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.
990 991 992 |
# File 'formula.rb', line 990 def systemd_service_path opt_prefix/"#{service_name}.service" end |
#systemd_timer_path ⇒ Pathname
The generated systemd timer file path.
996 997 998 |
# File 'formula.rb', line 996 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.
1584 1585 1586 1587 1588 1589 1590 |
# File 'formula.rb', line 1584 def time if ENV["SOURCE_DATE_EPOCH"].present? Time.at(ENV["SOURCE_DATE_EPOCH"].to_i).utc else Time.now.utc end end |
#to_recursive_bottle_hash(top_level: true) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Generate a hash to be used to install a formula from a JSON file
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 |
# File 'formula.rb', line 2170 def to_recursive_bottle_hash(top_level: true) bottle = bottle_hash bottles = bottle["files"].to_h do |tag, file| info = { "url" => file["url"] } info["sha256"] = file["sha256"] if tap.name != "homebrew/core" [tag.to_s, info] end hash = { "name" => name, "pkg_version" => pkg_version, "rebuild" => bottle["rebuild"], "bottles" => bottles, } return hash unless top_level hash["dependencies"] = declared_runtime_dependencies.map do |dep| dep.to_formula.to_recursive_bottle_hash(top_level: false) end hash end |
#to_s ⇒ Object
1463 1464 1465 |
# File 'formula.rb', line 1463 def to_s name end |
#update_head_version ⇒ Object
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 |
# File 'formula.rb', line 415 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.
863 864 865 |
# File 'formula.rb', line 863 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.
413 |
# File 'formula.rb', line 413 delegate version: :active_spec |
#versioned_formula? ⇒ Boolean
If this is a @
-versioned formula.
438 439 440 |
# File 'formula.rb', line 438 def versioned_formula? name.include?("@") end |
#versioned_formulae ⇒ Object
Returns any @
-versioned formulae for any formula (including versioned formulae).
443 444 445 446 447 448 449 450 451 |
# File 'formula.rb', line 443 def versioned_formulae Pathname.glob(path.to_s.gsub(/(@[\d.]+)?\.rb$/, "@*.rb")).map do |versioned_path| next if versioned_path == path Formula[versioned_path.basename(".rb").to_s] rescue FormulaUnavailableError nil end.compact.sort_by(&:version).reverse end |
#with_logging(log_type) ⇒ Object
Runs a block with the given log type in effect for its duration.
932 933 934 935 936 937 938 |
# File 'formula.rb', line 932 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.
2545 2546 2547 2548 2549 2550 2551 2552 2553 |
# File 'formula.rb', line 2545 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.
895 896 897 |
# File 'formula.rb', line 895 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.
871 872 873 |
# File 'formula.rb', line 871 def zsh_function share/"zsh/site-functions" end |