Skip to content
Snippets Groups Projects
Commit 1439d5ec authored by Adam Vandenberg's avatar Adam Vandenberg
Browse files

Document audit return code

parent 8f59c84a
No related branches found
No related tags found
No related merge requests found
......@@ -172,13 +172,18 @@ didn't include with OS X.
If `--deps` is passed, also download dependencies for any listed <formulae>.
* `audit [--strict]`:
Check formulae for Homebrew coding style violations. This should be
run before submitting a new formula for inclusion.
* `audit [--strict]` [<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.
If `--strict` is passed, perform additional stricter checks that may not need
to be fixed before submitting.
`audit` exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.
* `options [--compact] [--all]` <formula>:
Display install options specific to <formula>.
......
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BREW\-MAN" "1" "March 2011" "Homebrew" "brew"
.TH "BREW\-MAN" "1" "May 2011" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\-man\fR \- Generate man pages for Homebrew
......
......@@ -190,12 +190,18 @@ If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\.
If \fB\-\-deps\fR is passed, also download dependencies for any listed \fIformulae\fR\.
.
.TP
\fBaudit [\-\-strict]\fR
Check formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\.
\fBaudit [\-\-strict]\fR [\fIformulae\fR]
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
.
.IP
If no \fIformulae\fR are provided, all of them are checked\.
.
.IP
If \fB\-\-strict\fR is passed, perform additional stricter checks that may not need to be fixed before submitting\.
.
.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
\fBoptions [\-\-compact] [\-\-all]\fR \fIformula\fR
Display install options specific to \fIformula\fR\.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment