aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Manpage.md
diff options
context:
space:
mode:
authorMike McQuaid2017-04-18 08:17:24 +0100
committerMike McQuaid2017-04-18 08:17:26 +0100
commit3f8722c971cedf8b2c66d918fc4dd608bf439009 (patch)
treee0adb797c34673331d2c16023425fbeca76a0a41 /docs/Manpage.md
parent417f49dd32bfe555b20f3f7d88e2739f6623991b (diff)
downloadbrew-3f8722c971cedf8b2c66d918fc4dd608bf439009.tar.bz2
audit: allow skipping audit methods.
Add `--only` and `--except` methods which can be used to selectively enable or disable audit groups.
Diffstat (limited to 'docs/Manpage.md')
-rw-r--r--docs/Manpage.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/Manpage.md b/docs/Manpage.md
index 23e338213..e8171e5b0 100644
--- a/docs/Manpage.md
+++ b/docs/Manpage.md
@@ -606,7 +606,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
## DEVELOPER COMMANDS
- * `audit` [`--strict`] [`--fix`] [`--online`] [`--new-formula`] [`--display-cop-names`] [`--display-filename`] [`formulae`]:
+ * `audit` [`--strict`] [`--fix`] [`--online`] [`--new-formula`] [`--display-cop-names`] [`--display-filename`] [`--only=``method`|`--except=``method] [<formulae`]:
Check `formulae` for Homebrew coding style violations. This should be
run before submitting a new formula.
@@ -631,6 +631,10 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
If `--display-filename` is passed, every line of output is prefixed with the
name of the file or formula being audited, to make the output easy to grep.
+ If `--only` is passed, only the methods named `audit_`method`` will be run.
+
+ If `--except` is passed, the methods named `audit_`method`` will not be run.
+
`audit` exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.