formula: clarify caveats usage.

2017-02-20 11:18:44 +00:00 · 2017-02-20 11:18:44 +00:00 · 10970a5c54
commit 10970a5c54
parent 9f31d41fb2
1 changed files with 3 additions and 1 deletions
--- 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