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

Document audit return code

Browse Source
This commit is contained in:
Adam Vandenberg 2011-05-27 22:09:35 -07:00
parent 8f59c84ab2
commit 1439d5ec27
3 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Library/Contributions/manpages/brew.1.md
View File

@ -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>.

2
share/man/man1/brew-man.1
View File

@ -1,7 +1,7 @@
.\" 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

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

@ -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\.