Method: Formula#caveats

Defined in:
Library/Homebrew/formula.rb

#caveatsString

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. <pre>def caveats

<<~EOS
  Are optional. Something the user should know?
EOS

end</pre>

<pre>def caveats

s = <<~EOS
  Print some important notice to the user when `brew info <formula>` is
  called or when brewing a formula.
  This is optional. You can use all the vars like #{version} here.
EOS
s += "Some issue only on older systems" if MacOS.version < :mountain_lion
s

end</pre>

Returns:



1005
1006
1007
# File 'Library/Homebrew/formula.rb', line 1005

def caveats
  nil
end