mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Formula-Cookbook: document strict audit

Browse Source 
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>
This commit is contained in:
Aldrin Piri 2015-08-21 12:28:38 -04:00 committed by Dominyk Tiller
parent 9f20679366
commit 6abf63c99b
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
share/doc/homebrew/Formula-Cookbook.md
View File

@ -343,7 +343,9 @@ Add aliases by creating symlinks in `Library/Aliases`.
## Audit the formula ## 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 Use `brew info` and check if the version guessed by Homebrew from the URL is
correct. Add an explicit `version` if not. correct. Add an explicit `version` if not.