aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/manpages
diff options
context:
space:
mode:
authorMike McQuaid2014-12-27 16:51:43 +0000
committerMike McQuaid2014-12-27 16:51:43 +0000
commitd3531cbc468125d7a5eef9ff613762f35916c72e (patch)
treebbb6e7521ac1bb050face2a5254614f6f29b6060 /Library/Homebrew/manpages
parent638beee2fbdb03779be0d5dd0cc141c3087dc91c (diff)
downloadhomebrew-d3531cbc468125d7a5eef9ff613762f35916c72e.tar.bz2
manpage: document `brew audit --strict`.
Diffstat (limited to 'Library/Homebrew/manpages')
-rw-r--r--Library/Homebrew/manpages/brew.1.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/Library/Homebrew/manpages/brew.1.md b/Library/Homebrew/manpages/brew.1.md
index 35a6755d6..eb9d6d1a1 100644
--- a/Library/Homebrew/manpages/brew.1.md
+++ b/Library/Homebrew/manpages/brew.1.md
@@ -38,12 +38,15 @@ Note that these flags should only appear after a command.
## COMMANDS
- * `audit` [<formulae>]:
+ * `audit` [--strict] [<formulae>]:
Check <formulae> for Homebrew coding style violations. This should be
run before submitting a new formula.
If no <formulae> are provided, all of them are checked.
+ If `--strict` is passed, additional checks are run. This should be used
+ when creating for new formulae.
+
`audit` exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.