brew

https://github.com/homebrew/brew

Ruby

🍺 The missing package manager for macOS

Formula.depends_on

The dependencies for this formula. Use strings for the names of other
formulae. Homebrew provides some :special dependencies for stuff that
requires certain extra handling (often changing some ENV vars or
deciding if to use the system provided version or not.)
<pre># `:build` means this dep is only needed during build.
depends_on "cmake" => :build</pre>
<pre>depends_on "homebrew/dupes/tcl-tk" => :optional</pre>
<pre># `:recommended` dependencies are built by default.
# But a `--without-...` option is generated to opt-out.
depends_on "readline" => :recommended</pre>
<pre># `:optional` dependencies are NOT built by default.
# But a `--with-...` options is generated.
depends_on "glib" => :optional</pre>
<pre># 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.</pre>
<pre># Optional and enforce that boost is built with `--with-c++11`.
depends_on "boost" => [:optional, "with-c++11"]</pre>
<pre># If a dependency is only needed in certain cases:
depends_on "sqlite" if MacOS.version == :leopard
depends_on :xcode # If the formula really needs full Xcode.
depends_on :tex # Homebrew does not provide a Tex Distribution.
depends_on :fortran # Checks that `gfortran` is available or `FC` is set.
depends_on :mpi => :cc # Needs MPI with `cc`
depends_on :mpi => [:cc, :cxx, :optional] # Is optional. MPI with `cc` and `cxx`.
depends_on :macos => :lion # Needs at least Mac OS X "Lion" aka. 10.7.
depends_on :apr # If a formula requires the CLT-provided apr library to exist.
depends_on :arch => :intel # If this formula only builds on Intel architecture.
depends_on :arch => :x86_64 # If this formula only builds on Intel x86 64-bit.
depends_on :arch => :ppc # Only builds on PowerPC?
depends_on :ld64 # Sometimes ld fails on `MacOS.version < :leopard`. Then use this.
depends_on :x11 # X11/XQuartz components. Non-optional X11 deps should go in Homebrew/Homebrew-x11
depends_on :osxfuse # Permits the use of the upstream signed binary or our source package.
depends_on :tuntap # Does the same thing as above. This is vital for Yosemite and above.
depends_on :mysql => :recommended</pre>
<pre># It is possible to only depend on something if
# `build.with?` or `build.without? "another_formula"`:
depends_on :mysql # allows brewed or external mysql to be used
depends_on :postgresql if build.without? "sqlite"
depends_on :hg # Mercurial (external or brewed) is needed</pre>

<pre># If any Python >= 2.7 < 3.x is okay (either from OS X or brewed):
depends_on :python</pre>
<pre># to depend on Python >= 2.7 but use system Python where possible
depends_on :python if MacOS.version <= :snow_leopard</pre>
<pre># Python 3.x if the `--with-python3` is given to `brew install example`
depends_on :python3 => :optional</pre>

Source | Google | Stack overflow

Edit

git clone [email protected]:homebrew/brew.git

cd brew

open Library/Homebrew/formula.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Formula-depends_on-for-pr


# Commit to git

git add Library/Homebrew/formula.rbgit commit -m "better docs for Formula.depends_on"


# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Formula-depends_on-for-pr

hub pull-request


# Celebrate!