diff options
| author | Damien Pollet | 2016-02-28 22:08:15 +0100 |
|---|---|---|
| committer | Tim D. Smith | 2016-03-01 22:12:29 -0800 |
| commit | 57a81f9e22ef2db7fefc432adafe2d63a2206bc8 (patch) | |
| tree | a4a16aa5ea35930a31590750758174690776cf92 | |
| parent | e404a71e43bd5192e8ec0dec2e3ccef18292bfb7 (diff) | |
| download | brew-57a81f9e22ef2db7fefc432adafe2d63a2206bc8.tar.bz2 | |
Clarify case conventions in formula naming
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 <git@tim-smith.us>
| -rw-r--r-- | share/doc/homebrew/Formula-Cookbook.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/share/doc/homebrew/Formula-Cookbook.md b/share/doc/homebrew/Formula-Cookbook.md index 5fb834b20..3f9576600 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`. |