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

docs: Clarify dependency values

Browse Source
This commit is contained in:
Patrick Linnane 2023-02-04 14:37:16 +01:00
parent 082e75e692
commit 5ae18ce357
No known key found for this signature in database
GPG Key ID: 9F26181A1866DA0D
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Formula-Cookbook.md
View File

@ -154,7 +154,7 @@ A `Hash` (e.g. `=>`) adds information to a dependency. Given a string or symbol,
* `:build` means this is a build-time only dependency so it can be skipped when installing from a bottle or when listing missing dependencies using `brew missing`. * `:build` means this is a build-time only dependency so it can be skipped when installing from a bottle or when listing missing dependencies using `brew missing`.
* `:test` means this is only required when running `brew test`. * `:test` means this is only required when running `brew test`.
* `:optional` generates an implicit `with-foo` option for the formula. This means that, given `depends_on "foo" => :optional`, the user must pass `--with-foo` to use the dependency. * `:optional` generates an implicit `with-foo` option for the formula. This means that, given `depends_on "foo" => :optional`, the user must pass `--with-foo` to use the dependency. **Note:** This value is not allowed in Homebrew/homebrew-core as it is not tested by CI.
* `:recommended` generates an implicit `without-foo` option, meaning that the dependency is enabled by default and the user must pass `--without-foo` to disable this dependency. The default description can be overridden using the [`option`](https://rubydoc.brew.sh/Formula#option-class_method) syntax (in this case, the [`option` declaration](#adding-optional-steps) must precede the dependency): * `:recommended` generates an implicit `without-foo` option, meaning that the dependency is enabled by default and the user must pass `--without-foo` to disable this dependency. The default description can be overridden using the [`option`](https://rubydoc.brew.sh/Formula#option-class_method) syntax (in this case, the [`option` declaration](#adding-optional-steps) must precede the dependency):
```ruby ```ruby
@ -162,7 +162,7 @@ A `Hash` (e.g. `=>`) adds information to a dependency. Given a string or symbol,
depends_on "foo" => :optional # Generated description would otherwise be "Build with foo support" depends_on "foo" => :optional # Generated description would otherwise be "Build with foo support"
``` ```
**Note:** `:optional` and `:recommended` are not allowed in Homebrew/homebrew-core as they are not tested by CI. **Note:** This value is not allowed in Homebrew/homebrew-core as it is not tested by CI.
### Specifying conflicts with other formulae ### Specifying conflicts with other formulae