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
  "Are optional. Something the user should know?\n".undent
end
def caveats
  s = "Print some important notice to the user when `brew info <formula>` is\ncalled or when brewing a formula.\nThis is optional. You can use all the vars like \#{version} here.\n".undent
  s += "Some issue only on older systems" if MacOS.version < :mountain_lion
  s
end


1059
1060
1061
# File 'Library/Homebrew/formula.rb', line 1059

def caveats
  nil
end