admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

brew man output

Browse Source
This commit is contained in:
Gautham Goli 2018-07-30 18:26:09 +05:30
parent b6c456b681
commit acd9a335a5
No known key found for this signature in database
GPG Key ID: 6A9ABBC284468364
2 changed files with 72 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/Manpage.md
View File

@ -663,6 +663,38 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
## DEVELOPER COMMANDS
Usage: brew audit [options] [`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.
--strict Run additional style checks, including Rubocop style checks.
--online Run additional slower style checks that require a
network connection.
--new-formula Run various additional style checks to determine if a new formula
is eligible for Homebrew. This should be used when creating
new formula and implies --strict and --online.
--fix Fix style violations automatically using
RuboCop's auto-correct feature.
--display-cop-names Include the RuboCop cop name for each violation
in the output.
--display-filename Prefix everyline of output with name of the file or
formula being audited, to make output easy to grep.
-D, --audit-debug Activates debugging and profiling
--only Passing --only=method will run only the methods named audit_method,
`method` should be a comma-separated list.
--except Passing --except=method will run only the methods named audit_method,
`method` should be a comma-separated list.
--only-cops Passing --only-cops=cops will check for violations of only the listed
RuboCop cops. `cops` should be a comma-separated list of cop names.
--except-cops Passing --except-cops=cops will skip checking the listed
RuboCop cops violations. `cops` should be a comma-separated list of cop names.
-v, --verbose Verbose mode.
-d, --debug Display debug info.
-h, --help Show this message
* `audit` [`--strict`] [`--fix`] [`--online`] [`--new-formula`] [`--display-cop-names`] [`--display-filename`] [`--only=``method`|`--except=``method`] [`--only-cops=``cops`|`--except-cops=``cops`] [`formulae`]:
Check `formulae` for Homebrew coding style violations. This should be
run before submitting a new formula.

40
manpages/brew.1
View File

@ -601,6 +601,46 @@ If the command\'s output is sent through a pipe and no shell is specified, the l
.IP "" 0
.
.SH "DEVELOPER COMMANDS"
Usage: brew audit [options] [\fIformulae\fR]
.
.P
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
.
.P
If no \fIformulae\fR are provided, all of them are checked\.
.
.IP "" 4
.
.nf
\-\-strict Run additional style checks, including Rubocop style checks\.
\-\-online Run additional slower style checks that require a
network connection\.
\-\-new\-formula Run various additional style checks to determine if a new formula
is eligible for Homebrew\. This should be used when creating
new formula and implies \-\-strict and \-\-online\.
\-\-fix Fix style violations automatically using
RuboCop\'s auto\-correct feature\.
\-\-display\-cop\-names Include the RuboCop cop name for each violation
in the output\.
\-\-display\-filename Prefix everyline of output with name of the file or
formula being audited, to make output easy to grep\.
\-D, \-\-audit\-debug Activates debugging and profiling
\-\-only Passing \-\-only=method will run only the methods named audit_method,
`method` should be a comma\-separated list\.
\-\-except Passing \-\-except=method will run only the methods named audit_method,
`method` should be a comma\-separated list\.
\-\-only\-cops Passing \-\-only\-cops=cops will check for violations of only the listed
RuboCop cops\. `cops` should be a comma\-separated list of cop names\.
\-\-except\-cops Passing \-\-except\-cops=cops will skip checking the listed
RuboCop cops violations\. `cops` should be a comma\-separated list of cop names\.
\-v, \-\-verbose Verbose mode\.
\-d, \-\-debug Display debug info\.
\-h, \-\-help Show this message
.
.fi
.
.IP "" 0
.
.TP
\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-fix\fR] [\fB\-\-online\fR] [\fB\-\-new\-formula\fR] [\fB\-\-display\-cop\-names\fR] [\fB\-\-display\-filename\fR] [\fB\-\-only=\fR\fImethod\fR|\fB\-\-except=\fR\fImethod\fR] [\fB\-\-only\-cops=\fR\fIcops\fR|\fB\-\-except\-cops=\fR\fIcops\fR] [\fIformulae\fR]