From 1439d5ec2739d533866ce614ff677fae14c6b346 Mon Sep 17 00:00:00 2001
From: Adam Vandenberg <flangy@gmail.com>
Date: Fri, 27 May 2011 22:09:35 -0700
Subject: [PATCH] Document audit return code

---
 Library/Contributions/manpages/brew.1.md | 11 ++++++++---
 share/man/man1/brew-man.1                |  2 +-
 share/man/man1/brew.1                    | 10 ++++++++--
 3 files changed, 17 insertions(+), 6 deletions(-)

diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index 7efe0249cc..9b9a283825 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -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>.
 
diff --git a/share/man/man1/brew-man.1 b/share/man/man1/brew-man.1
index 24bd05a4e9..bbf4194f21 100644
--- a/share/man/man1/brew-man.1
+++ b/share/man/man1/brew-man.1
@@ -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
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index 2b5f928a2a..1a811bd22f 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -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\.