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

manpage: document brew audit --strict.

Browse Source
This commit is contained in:
Mike McQuaid 2014-12-27 16:51:43 +00:00
parent c4f7217811
commit 5cff7efc56
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Library/Homebrew/manpages/brew.1.md
View File

@ -38,12 +38,15 @@ Note that these flags should only appear after a command.
## COMMANDS ## COMMANDS
* `audit` [<formulae>]: * `audit` [--strict] [<formulae>]:
Check <formulae> for Homebrew coding style violations. This should be Check <formulae> for Homebrew coding style violations. This should be
run before submitting a new formula. run before submitting a new formula.
If no <formulae> are provided, all of them are checked. If no <formulae> are provided, all of them are checked.
If `--strict` is passed, additional checks are run. This should be used
when creating for new formulae.
`audit` exits with a non-zero status if any errors are found. This is useful, `audit` exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks. for instance, for implementing pre-commit hooks.

5
share/man/man1/brew.1
View File

@ -44,13 +44,16 @@ Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is su
.SH "COMMANDS" .SH "COMMANDS"
. .
.TP .TP
\fBaudit\fR [\fIformulae\fR] \fBaudit\fR [\-\-strict] [\fIformulae\fR]
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
. .
.IP .IP
If no \fIformulae\fR are provided, all of them are checked\. If no \fIformulae\fR are provided, all of them are checked\.
. .
.IP .IP
If \fB\-\-strict\fR is passed, additional checks are run\. This should be used when creating for new formulae\.
.
.IP
\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\. \fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\.
. .
.TP .TP