Document 'brew test' and sort external commands.

This commit is contained in:
Adam Vandenberg 2010-08-15 15:38:58 -07:00
parent 3d20387863
commit 85b9c7eca1
2 changed files with 23 additions and 7 deletions

View File

@ -164,16 +164,25 @@ to recognize `brew cmdname`.
Some external commands are shipped with Homebrew, and enabled by default. 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>: * `fetch` <formula>:
Downloads the tarball or checks out from VCS for the given <formula>. For Downloads the tarball or checks out from VCS for the given <formula>. For
tarballs, also prints MD5 and SHA1 checksums. tarballs, also prints MD5 and SHA1 checksums.
* `audit`:
Checks all formulae for Homebrew coding style violations.
* `missing`: * `missing`:
Checks all installed formuale for missing dependencies. 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 ## ENVIRONMENT
* HOMEBREW\_DEBUG: * HOMEBREW\_DEBUG:

View File

@ -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\. Some external commands are shipped with Homebrew, and enabled by default\.
. .
.TP .TP
\fBaudit\fR
Checks all formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\.
.
.TP
\fBfetch\fR \fIformula\fR \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\. Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\.
. .
.TP .TP
\fBaudit\fR
Checks all formulae for Homebrew coding style violations\.
.
.TP
\fBmissing\fR \fBmissing\fR
Checks all installed formuale for missing dependencies\. 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" .SH "ENVIRONMENT"
. .
.TP .TP