From 5ae18ce3578b3e5dfb42031eeadb3db239bcfebe Mon Sep 17 00:00:00 2001 From: Patrick Linnane Date: Sat, 4 Feb 2023 14:37:16 +0100 Subject: [PATCH] docs: Clarify dependency values --- docs/Formula-Cookbook.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index c8f1fcfd7d..6cb9dc96b9 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -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`. * `: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): ```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" ``` -**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