diff options
| author | Mike McQuaid | 2016-08-02 10:59:39 +0100 |
|---|---|---|
| committer | Mike McQuaid | 2016-08-02 12:44:41 +0100 |
| commit | 0302a6bc7cc72aed9b729e9d465856e65b6c8b2c (patch) | |
| tree | ce67a5f4d0b2898db553446a2f1811c1af3173bc /share/doc | |
| parent | ebe8b8d328bba2ec5f450482f4a88ee1df4bb833 (diff) | |
| download | brew-0302a6bc7cc72aed9b729e9d465856e65b6c8b2c.tar.bz2 | |
audit: add --new-formula option.
Rather than nudge people to run `--strict` and then ignore some of the
results sometimes (e.g. GitHub repository notability) instead add a
dedicated `--new-formula` option that implies this is a one-time
advisory check.
Diffstat (limited to 'share/doc')
| -rw-r--r-- | share/doc/homebrew/brew.1.html | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 007edd11c..ad1b1f392 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -39,18 +39,20 @@ If no search term is given, all locally available formulae are listed.</p></dd> Read more at <a href="https://git.io/brew-analytics" data-bare-link="true">https://git.io/brew-analytics</a>.</p></dd> <dt><code>analytics</code> (<code>on</code>|<code>off</code>)</dt><dd><p>Turn on/off Homebrew's analytics.</p></dd> <dt><code>analytics</code> <code>regenerate-uuid</code></dt><dd><p>Regenerate UUID used in Homebrew's analytics.</p></dd> -<dt><code>audit</code> [<code>--strict</code>] [<code>--online</code>] [<code>--display-cop-names</code>] [<code>--display-filename</code>] [<var>formulae</var>]</dt><dd><p>Check <var>formulae</var> for Homebrew coding style violations. This should be +<dt><code>audit</code> [<code>--strict</code>] [<code>--online</code>] [<code>--new-formula</code>] [<code>--display-cop-names</code>] [<code>--display-filename</code>] [<var>formulae</var>]</dt><dd><p>Check <var>formulae</var> for Homebrew coding style violations. This should be run before submitting a new formula.</p> <p>If no <var>formulae</var> are provided, all of them are checked.</p> <p>If <code>--strict</code> is passed, additional checks are run, including RuboCop -style checks. This should be used when creating new formulae.</p> +style checks.</p> <p>If <code>--online</code> is passed, additional slower checks that require a network -connection are run. This should be used when creating for new formulae.</p> - -<p>If <code>--display-cop-names</code> is passed, the RuboCop cop name for each violation +connection are run. +If <code>--new-formula</code> is passed, various additional checks are run that check +if a new formula is eligable for Homebrew. This should be used when creating +new formulae and implies <code>--strict</code> and <code>--online</code>. +If <code>--display-cop-names</code> is passed, the RuboCop cop name for each violation is included in the output.</p> <p>If <code>--display-filename</code> is passed, every line of output is prefixed with the |