diff options
| author | Aldrin Piri | 2015-08-21 12:28:38 -0400 |
|---|---|---|
| committer | Dominyk Tiller | 2015-08-22 19:49:19 +0100 |
| commit | 6abf63c99bbd8a00a591c708c86093f5bb975adc (patch) | |
| tree | 4845a0f3713489a57e70932116d06bb0a1f7066b | |
| parent | 9f20679366ff47894f9e2ffb649eb818c5fc80cc (diff) | |
| download | brew-6abf63c99bbd8a00a591c708c86093f5bb975adc.tar.bz2 | |
Formula-Cookbook: document strict audit
Providing specific reference to the --strict option for brew audit.
Closes Homebrew/homebrew#43155.
Closes Homebrew/homebrew#43156.
Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
| -rw-r--r-- | share/doc/homebrew/Formula-Cookbook.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/share/doc/homebrew/Formula-Cookbook.md b/share/doc/homebrew/Formula-Cookbook.md index 914b23b40..7430c5f88 100644 --- a/share/doc/homebrew/Formula-Cookbook.md +++ b/share/doc/homebrew/Formula-Cookbook.md @@ -343,7 +343,9 @@ Add aliases by creating symlinks in `Library/Aliases`. ## Audit the formula -You can run `brew audit` to test formulae for adherence to Homebrew house style. This includes warnings for trailing whitespace, preferred URLs for certain source hosts, and a lot of other style issues. Fixing these warnings before committing will make the process a lot smoother for us. +You can run `brew audit` to test formulae for adherence to Homebrew house style. The audit command includes warnings for trailing whitespace, preferred URLs for certain source hosts, and a lot of other style issues. Fixing these warnings before committing will make the process a lot smoother for us. + +New formulae being introduced to homebrew should run `brew audit <formula name> --strict`. This command is performed by the Brew Bot in cases when a formula is being added as part of the automated build and test process, and is more stringent in its inspection. Use `brew info` and check if the version guessed by Homebrew from the URL is correct. Add an explicit `version` if not. |