From 0980c4150f09c65a3df36c2d2e9a180cc56a9819 Mon Sep 17 00:00:00 2001 From: Sean Molenaar Date: Thu, 20 Jun 2019 10:28:34 +0200 Subject: [PATCH] Docs: add caveat info to cookbook --- docs/Formula-Cookbook.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index f706881000..1a747f7079 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -283,6 +283,18 @@ Homebrew expects to find manual pages in `#{prefix}/share/man/...`, and not in ` Some software installs to `man` instead of `share/man`, so check the output and add a `"--mandir=#{man}"` to the `./configure` line if needed. +### Special instructions + +In case there are specific issues with the homebrew install a `caveats` block can be added to the formula to inform users. This can indicate non-standard install paths, an example from the ruby formula: + +``` +==> Caveats +By default, binaries installed by gem will be placed into: + /usr/local/lib/ruby/gems/bin + +You may want to add this to your PATH. +``` + ### A quick word on naming Name the formula like the project markets the product. So it’s `pkg-config`, not `pkgconfig`; `sdl_mixer`, not `sdl-mixer` or `sdlmixer`.