diff options
Diffstat (limited to 'Library/Homebrew/cmd/audit.rb')
| -rw-r--r-- | Library/Homebrew/cmd/audit.rb | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Library/Homebrew/cmd/audit.rb b/Library/Homebrew/cmd/audit.rb index acc22f98a..3fe461908 100644 --- a/Library/Homebrew/cmd/audit.rb +++ b/Library/Homebrew/cmd/audit.rb @@ -1,3 +1,18 @@ +#: * `audit` [`--strict`] [`--online`] [<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, additional checks are run. This should be used +#: when creating for new formulae. +#: +#: If `--online` is passed, additional slower checks that require a network +#: connection are run. This should be used when creating for new formulae. +#: +#: `audit` exits with a non-zero status if any errors are found. This is useful, +#: for instance, for implementing pre-commit hooks. + require "formula" require "formula_versions" require "utils" |