aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominyk Tiller2015-08-03 22:27:07 +0100
committerDominyk Tiller2015-08-04 01:40:15 +0100
commite1d736a0fad6f36b51eca65d8f0fae3a126e0ac4 (patch)
treef4eee4f4c4e7dbc1f6809575b1b12d0747a5575b
parent3a733cad09ea45cb5f4f6fcf31afccb7f0333140 (diff)
downloadbrew-e1d736a0fad6f36b51eca65d8f0fae3a126e0ac4.tar.bz2
Formula-Cookbook: tweak conflicts_with
Closes Homebrew/homebrew#42432. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
-rw-r--r--share/doc/homebrew/Formula-Cookbook.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/share/doc/homebrew/Formula-Cookbook.md b/share/doc/homebrew/Formula-Cookbook.md
index ea8f4605c..99f9263e1 100644
--- a/share/doc/homebrew/Formula-Cookbook.md
+++ b/share/doc/homebrew/Formula-Cookbook.md
@@ -204,11 +204,12 @@ A Hash specifies a formula dependency with some additional information. Given a
Sometimes there’s hard conflict between formulae, and it can’t be avoided or circumvented with `keg_only`.
-PolarSSL is a good [example](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/polarssl.rb#L36-L37) formula for minor conflict.
+PolarSSL is a good [example](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/polarssl.rb) formula for minor conflict.
-PolarSSL ship GNU’s Hello, and compiles a `hello` binary. This is obviously non-essential to PolarSSL’s functionality, and conflict with the `hello` formula would be overkill, so we just remove it.
+PolarSSL ship and compile a "Hello World" executable. This is obviously non-essential to PolarSSL’s functionality, and conflict with the popular GNU `hello` formula would be overkill, so we just remove it.
-However, also in the PolarSSL formulae is a [firm conflict](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/polarssl.rb#L19) with `md5sha1sum`, because both `md5sha1sum` and `polarssl` compile identically-named binaries that *are* important for core functionality.
+[pdftohtml](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/pdftohtml.rb) provides an example of a serious
+conflict, where both formula ship a identically-named binary that is essential to functionality, so a `conflicts_with` is preferable.
As a general rule, `conflicts_with` should be a last-resort option. It’s a fairly blunt instrument.