admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Formula-Cookbook: document :run

Browse Source
This commit is contained in:
Dominyk Tiller 2016-09-14 18:12:47 +01:00
parent 3eb966c309
commit 0cc4d530dc
No known key found for this signature in database
GPG Key ID: FE19AEFCF658C6F6
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
share/doc/homebrew/Formula-Cookbook.md
View File

@ -121,10 +121,11 @@ Homebrew maintains a special [tap that provides other useful system duplicates](
```ruby ```ruby
class Foo < Formula class Foo < Formula
depends_on "pkg-config" => :run
depends_on "jpeg" depends_on "jpeg"
depends_on "gtk+" => :optional
depends_on "readline" => :recommended
depends_on "boost" => "with-icu" depends_on "boost" => "with-icu"
depends_on "readline" => :recommended
depends_on "gtk+" => :optional
depends_on :x11 => :optional depends_on :x11 => :optional
end end
``` ```
@ -135,12 +136,16 @@ A Symbol (e.g. `:x11`) specifies a [`Requirement`](http://www.rubydoc.info/githu
A Hash (e.g. `=>`) specifies a formula dependency with some additional information. Given a single string key, the value can take several forms: A Hash (e.g. `=>`) specifies a formula dependency with some additional information. Given a single string key, the value can take several forms:
* a Symbol (currently one of `:build`, `:optional`, `:recommended`). * a Symbol (currently one of `:build`, `:optional`, `:run` or `:recommended`).
- `:build` means that dependency is a build-time only dependency so it can - `:build` means that dependency is a build-time only dependency so it can
be skipped when installing from a bottle or when listing missing be skipped when installing from a bottle or when listing missing
dependencies using `brew missing`. dependencies using `brew missing`.
- `:optional` generates an implicit `with-foo` option for the formula. - `:optional` generates an implicit `with-foo` option for the formula.
This means that, given `depends_on "foo" => :optional`, the user must pass `--with-foo` in order to use the dependency. This means that, given `depends_on "foo" => :optional`, the user must pass `--with-foo` in order to use the dependency.
- `:run` can mean the dependency is only required at run, or it can be used
to declare build dependencies such as `pkg-config` are needed during
runtime as well, which will silence the audit warning. `:run` currently
implies `:build` as well.
- `:recommended` generates an implicit `without-foo` option, meaning that - `:recommended` generates an implicit `without-foo` option, meaning that
the dependency is enabled by default and the user must pass the dependency is enabled by default and the user must pass
`--without-foo` to disable this dependency. The default `--without-foo` to disable this dependency. The default