diff options
| author | Adam Vandenberg | 2011-05-27 22:09:35 -0700 |
|---|---|---|
| committer | Adam Vandenberg | 2011-05-27 22:09:35 -0700 |
| commit | 1439d5ec2739d533866ce614ff677fae14c6b346 (patch) | |
| tree | 9d9cd19b1e5457e940ac41bf2dcc74dbf6673551 /Library | |
| parent | 8f59c84ab266df01a49fce055bbbfcb1a5288d1e (diff) | |
| download | brew-1439d5ec2739d533866ce614ff677fae14c6b346.tar.bz2 | |
Document audit return code
Diffstat (limited to 'Library')
| -rw-r--r-- | Library/Contributions/manpages/brew.1.md | 11 |
1 files changed, 8 insertions, 3 deletions
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 <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>. |
