aboutsummaryrefslogtreecommitdiffstats
path: root/Library
diff options
context:
space:
mode:
authorAdam Vandenberg2010-08-15 15:38:58 -0700
committerAdam Vandenberg2010-08-15 15:38:58 -0700
commit85b9c7eca1b4e566b2387d22690619cd6415177f (patch)
tree78e4b5bc893463d31831b9c6e6b64dc332520915 /Library
parent3d20387863dea5bcede84469c37149a3c53007fe (diff)
downloadbrew-85b9c7eca1b4e566b2387d22690619cd6415177f.tar.bz2
Document 'brew test' and sort external commands.
Diffstat (limited to 'Library')
-rw-r--r--Library/Contributions/manpages/brew.1.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index 7ae24b1cc..1715752e1 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -164,16 +164,25 @@ to recognize `brew cmdname`.
Some external commands are shipped with Homebrew, and enabled by default.
+ * `audit`:
+ Checks all formulae for Homebrew coding style violations. This should be
+ run before submitting a new formula for inclusion.
+
* `fetch` <formula>:
Downloads the tarball or checks out from VCS for the given <formula>. For
tarballs, also prints MD5 and SHA1 checksums.
- * `audit`:
- Checks all formulae for Homebrew coding style violations.
-
* `missing`:
Checks all installed formuale for missing dependencies.
+ * `test` <formula>:
+ A few formulae provide a test method. `brew test <formula>` runs this
+ test method. There is no standard output or return code, but it should
+ generally indicate to the user if something is wrong with the installed
+ formula.
+
+ Example: `brew install jruby && brew test jruby`
+
## ENVIRONMENT
* HOMEBREW\_DEBUG: