Formula-Cookbook: tweak :run explanation

This commit is contained in:
Dominyk Tiller 2016-09-14 20:55:13 +01:00
parent de283d81c5
commit da3e98070b
No known key found for this signature in database
GPG Key ID: FE19AEFCF658C6F6

View File

@ -143,9 +143,9 @@ A Hash (e.g. `=>`) specifies a formula dependency with some additional informati
- `: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 - `: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 to declare build dependencies such as `pkg-config` are needed at
runtime as well, which will silence the audit warning. `:run` currently runtime as well, which will silence the audit warning. `:run` dependencies
implies `:build` as well. are currently available at build-time.
- `: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