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.

def caveats
  <<-EOS.undent
    Are optional. Something the user should know?
  EOS
end
def caveats
  s = <<-EOS.undent
    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

Returns:



1003
1004
1005
# File 'Library/Homebrew/formula.rb', line 1003

def caveats
  nil
end