From 85b9c7eca1b4e566b2387d22690619cd6415177f Mon Sep 17 00:00:00 2001 From: Adam Vandenberg Date: Sun, 15 Aug 2010 15:38:58 -0700 Subject: [PATCH] Document 'brew test' and sort external commands. --- Library/Contributions/manpages/brew.1.md | 15 ++++++++++++--- 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 7ae24b1ccf..1715752e15 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` : Downloads the tarball or checks out from VCS for the given . 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` : + A few formulae provide a test method. `brew test ` 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 18a2f3e673..8219a87617 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 +\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 Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\. . .TP -\fBaudit\fR -Checks all formulae for Homebrew coding style violations\. -. -.TP \fBmissing\fR Checks all installed formuale for missing dependencies\. . +.TP +\fBtest\fR \fIformula\fR +A few formulae provide a test method\. \fBbrew test \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