Skip to content

Commit

Permalink
Clarify case conventions in formula naming
Browse files Browse the repository at this point in the history
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#49639.

Signed-off-by: Tim D. Smith <[email protected]>
  • Loading branch information
cdlm authored and tdsmith committed Mar 2, 2016
1 parent c07c33c commit 46cbc43
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion share/doc/homebrew/Formula-Cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 46cbc43

Please sign in to comment.