diff options
Diffstat (limited to 'docs/Formula-Cookbook.md')
| -rw-r--r-- | docs/Formula-Cookbook.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index bb3ad33dc..6b4678f90 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -288,13 +288,13 @@ Name the formula like the project markets the product. So itâs `pkg-config`, n The only exception is stuff like âApache Antâ. Apache sticks âApacheâ in front of everything, but we use the formula name `ant`. We only include the prefix in cases like *GNUplot* (because itâs part of the name) and *GNU Go* (because everyone calls it âGNU goâânobody just calls it âGoâ). The word âGoâ is too common and there are too many implementations of it. -If youâre not sure about the name check the homepage, and check the Wikipedia page and [what Debian call it](https://www.debian.org/distrib/packages). +If youâre not sure about the name check the homepage, and check the Wikipedia page and [what Debian calls it](https://www.debian.org/distrib/packages). -Where Homebrew already has a formula called `foo` we typically do not accept requests to replace that formula with something else also named `foo`. This is to avoid both confusing and surprising usersâ expectation. +Where Homebrew already has a formula called `foo` we typically do not accept requests to replace that formula with something else also named `foo`. This is to avoid both confusing and surprising usersâ expectations. When two formulae share an upstream name, e.g. [`AESCrypt`](https://github.com/Homebrew/homebrew-core/blob/master/Formula/aescrypt.rb) and [`AESCrypt`](https://github.com/Homebrew/homebrew-core/blob/master/Formula/aescrypt-packetizer.rb) the newer formula must typically adapt the name to avoid conflict with the current formula. -If youâre *still* not sure, just commit. Weâll apply some arbitrary rule and make a decision :wink:. +If youâre *still* not sure, just commit. Weâll apply some arbitrary rule and make a decision đ. When importing classes, Homebrew will require the formula and then create an instance of the class. It does this by assuming the formula name can be directly converted to the class name using a `regexp`. The rules are simple: @@ -359,6 +359,7 @@ Now, please [open a pull request](http://docs.brew.sh/How-To-Open-a-Homebrew-Pul * Keep merge commits out of the pull request # Convenience Tools + ## Messaging Three commands are provided for displaying informational messages to the user: @@ -783,6 +784,8 @@ The symlinks created by `install_symlink` are guaranteed to be relative. `ln_s` For example, Ruby 1.9âs gems should be installed to `var/lib/ruby/` so that gems donât need to be reinstalled when upgrading Ruby. You can usually do this with symlink trickery, or *better* a configure option. +Another example would be configuration files that should not be overwritten on package upgrades. If after installation you find that to-be-persisted configuration files are not copied but instead *symlinked* into `/usr/local/etc/` from the Cellar, this can often be rectified by passing an appropriate argument to the packageâs configure script. That argument will vary depending on a given packageâs configure script and/or Makefile, but one example might be: `--sysconfdir=#{etc}` + ### launchd plist files Homebrew provides two Formula methods for launchd plist files. [`plist_name`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#plist_name-instance_method) will return e.g. `homebrew.mxcl.<formula>` and [`plist_path`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#plist_path-instance_method) will return e.g. `/usr/local/Cellar/foo/0.1/homebrew.mxcl.foo.plist`. |