From beb4eff5bf19110affe81d04c3cfc90edc2fa2ca Mon Sep 17 00:00:00 2001 From: Adam Vandenberg Date: Fri, 27 May 2011 22:09:35 -0700 Subject: Document audit return code --- Library/Contributions/manpages/brew.1.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'Library') diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index 7efe0249c..9b9a28382 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 . - * `audit [--strict]`: - Check formulae for Homebrew coding style violations. This should be - run before submitting a new formula for inclusion. + * `audit [--strict]` []: + Check for Homebrew coding style violations. This should be + run before submitting a new formula. + + If no 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]` : Display install options specific to . -- cgit v1.2.3