From 57a81f9e22ef2db7fefc432adafe2d63a2206bc8 Mon Sep 17 00:00:00 2001 From: Damien Pollet Date: Sun, 28 Feb 2016 22:08:15 +0100 Subject: [PATCH] Clarify case conventions in formula naming MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit If a formula's class name contains an uppercase-spelled acronym, the messages given by `brew install` can be pretty confusing (it recommends a formula named exactly the same…) Closes Homebrew/homebrew#49639. Signed-off-by: Tim D. Smith --- share/doc/homebrew/Formula-Cookbook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/share/doc/homebrew/Formula-Cookbook.md b/share/doc/homebrew/Formula-Cookbook.md index 5fb834b206..3f95766006 100644 --- a/share/doc/homebrew/Formula-Cookbook.md +++ b/share/doc/homebrew/Formula-Cookbook.md @@ -272,7 +272,7 @@ When importing classes, Homebrew will require the formula and then create an ins * `foo-bar.rb` => `FooBar` * `foobar.rb` => `Foobar` -Thus, if you change the name of the class, you must also rename the file. Filenames should be all lowercase. +Thus, if you change the name of the class, you must also rename the file. Filenames should be all lowercase, and class names should be the strict CamelCase equivalent, e.g. formulae `gnu-go` and `sdl_mixer` become classes `GnuGo` and `SdlMixer`, even if part of their name is an acronym. Add aliases by creating symlinks in `Library/Aliases`.