diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Manpage.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/Manpage.md b/docs/Manpage.md index 4e173668a..fcc6cf4a0 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -402,7 +402,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--env=std` is passed, use the standard `PATH` instead of superenv's. - * `style` [`--fix`] [`--display-cop-names`] [`files`|`taps`|`formulae`]: + * `style` [`--fix`] [`--display-cop-names`] [`--only-cops=`[COP1,COP2..]|`--except-cops=`[COP1,COP2..]] [`files`|`taps`|`formulae`]: Check formulae or files for conformance to Homebrew style guidelines. `formulae` and `files` may not be combined. If both are omitted, style will run @@ -415,6 +415,10 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--display-cop-names` is passed, the RuboCop cop name for each violation is included in the output. + If `--only-cops` is passed, only the given Rubocop cop(s)' violations would be checked. + + If `--except-cops` is passed, the given Rubocop cop(s)' checks would be skipped. + Exits with a non-zero status if any style violations are found. * `switch` `name` `version`: @@ -606,7 +610,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`] [`--only=``method`|`--except=``method] [<formulae`]: + * `audit` [`--strict`] [`--fix`] [`--online`] [`--new-formula`] [`--display-cop-names`] [`--display-filename`] [`--only=``method`|`--except=``method`] [`--only-cops=`[COP1,COP2..]|`--except-cops=`[COP1,COP2..]] [`formulae`]: Check `formulae` for Homebrew coding style violations. This should be run before submitting a new formula. @@ -635,9 +639,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--except` is passed, the methods named `audit_`method`` will not be run. - If `--only-cops` is passed, only the mentioned cops' violations would be checked. + If `--only-cops` is passed, only the given Rubocop cop(s)' violations would be checked. - If `--except-cops` is passed, the mentioned cops' checks would be skipped. + If `--except-cops` is passed, the given Rubocop cop(s)' checks would be skipped. `audit` exits with a non-zero status if any errors are found. This is useful, for instance, for implementing pre-commit hooks. |