aboutsummaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorAndrew Janke2016-05-11 09:19:45 -0700
committerAndrew Janke2016-05-11 09:19:45 -0700
commit63ea9295cf726bfccea39ffc308b80ea5c23fed9 (patch)
treefadedb825b243c4be19b34231d3233e7fbabcd7e /share/man
parent5f06312916e8ae518e8a9f212f7e683c49ceee67 (diff)
downloadbrew-63ea9295cf726bfccea39ffc308b80ea5c23fed9.tar.bz2
brew audit: add --display-filename format option for easy grepping (#221)
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man1/brew.15
1 files changed, 4 insertions, 1 deletions
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index 99514666f..bb3839263 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -56,7 +56,7 @@ Turn on/off Homebrew\'s analytics\.
Regenerate UUID used in Homebrew\'s analytics\.
.
.TP
-\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-online\fR] [\fB\-\-display\-cop\-names\fR] [\fIformulae\fR]
+\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-online\fR] [\fB\-\-display\-cop\-names\fR] [\fB\-\-display\-filename\fR] [\fIformulae\fR]
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
.
.IP
@@ -72,6 +72,9 @@ If \fB\-\-online\fR is passed, additional slower checks that require a network c
If \fB\-\-display\-cop\-names\fR is passed, the RuboCop cop name for each violation is included in the output\.
.
.IP
+If \fB\-\-display\-filename\fR 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\.
+.
+.IP
\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\.
.
.TP