diff options
| author | Adam Vandenberg | 2010-08-15 15:38:58 -0700 |
|---|---|---|
| committer | Adam Vandenberg | 2010-08-15 15:38:58 -0700 |
| commit | 85b9c7eca1b4e566b2387d22690619cd6415177f (patch) | |
| tree | 78e4b5bc893463d31831b9c6e6b64dc332520915 | |
| parent | 3d20387863dea5bcede84469c37149a3c53007fe (diff) | |
| download | brew-85b9c7eca1b4e566b2387d22690619cd6415177f.tar.bz2 | |
Document 'brew test' and sort external commands.
| -rw-r--r-- | Library/Contributions/manpages/brew.1.md | 15 | ||||
| -rw-r--r-- | share/man/man1/brew.1 | 15 |
2 files changed, 23 insertions, 7 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: diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 18a2f3e67..8219a8761 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -174,17 +174,24 @@ Homebrew allows external commands to be defined by putting a +x file named \fBbr Some external commands are shipped with Homebrew, and enabled by default\. . .TP -\fBfetch\fR \fIformula\fR -Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\. +\fBaudit\fR +Checks all formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\. . .TP -\fBaudit\fR -Checks all formulae for Homebrew coding style violations\. +\fBfetch\fR \fIformula\fR +Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\. . .TP \fBmissing\fR Checks all installed formuale for missing dependencies\. . +.TP +\fBtest\fR \fIformula\fR +A few formulae provide a test method\. \fBbrew test <formula>\fR 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\. +. +.IP +Example: \fBbrew install jruby && brew test jruby\fR +. .SH "ENVIRONMENT" . .TP |