aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/formula.rb
diff options
context:
space:
mode:
authorMike McQuaid2017-02-20 11:18:44 +0000
committerMike McQuaid2017-02-20 11:21:25 +0000
commit10970a5c54c0723126bef3582f9e9a63d25e1b54 (patch)
tree0f2b931663fe679f7d599dc1cba43be2164d3c47 /Library/Homebrew/formula.rb
parent9f31d41fb263718bff98e194df411b8aaea72aba (diff)
downloadbrew-10970a5c54c0723126bef3582f9e9a63d25e1b54.tar.bz2
formula: clarify caveats usage.
Diffstat (limited to 'Library/Homebrew/formula.rb')
-rw-r--r--Library/Homebrew/formula.rb4
1 files changed, 3 insertions, 1 deletions
diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb
index a4ef11276..7b3d1c326 100644
--- a/Library/Homebrew/formula.rb
+++ b/Library/Homebrew/formula.rb
@@ -1026,7 +1026,9 @@ class Formula
@prefix_returns_versioned_prefix = false
end
- # Tell the user about any caveats regarding this package.
+ # Tell the user about any Homebrew-specific caveats or locations regarding
+ # this package. These should not contain setup instructions that would apply
+ # to installation through a different package manager on a different OS.
# @return [String]
# <pre>def caveats
# <<-EOS.undent