From 63ea9295cf726bfccea39ffc308b80ea5c23fed9 Mon Sep 17 00:00:00 2001 From: Andrew Janke Date: Wed, 11 May 2016 09:19:45 -0700 Subject: brew audit: add --display-filename format option for easy grepping (#221) --- share/doc/homebrew/brew.1.html | 5 ++++- share/man/man1/brew.1 | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) (limited to 'share') diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 6322abf16..8c18f9c0a 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -39,7 +39,7 @@ If no search term is given, all locally available formulae are listed.

Read more at https://git.io/brew-analytics.

analytics (on|off)

Turn on/off Homebrew's analytics.

analytics regenerate-uuid

Regenerate UUID used in Homebrew's analytics.

-
audit [--strict] [--online] [--display-cop-names] [formulae]

Check formulae for Homebrew coding style violations. This should be +

audit [--strict] [--online] [--display-cop-names] [--display-filename] [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.

@@ -53,6 +53,9 @@ connection are run. This should be used when creating for new formulae.

If --display-cop-names is passed, the RuboCop cop name for each violation is included in the output.

+

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.

+

audit exits with a non-zero status if any errors are found. This is useful, for instance, for implementing pre-commit hooks.

cat formula

Display the source to formula.

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 -- cgit v1.2.3