diff options
| author | Dave Cottlehuber | 2014-06-02 22:30:22 +0200 |
|---|---|---|
| committer | Adam Vandenberg | 2014-06-03 20:17:45 -0700 |
| commit | bd0533448718bbf323e58070fc711d662c54b855 (patch) | |
| tree | 9e322f9332c6ac5b19b1af7e85b8cba0a746a07d /Library | |
| parent | 68f27922bca5888d1003dcd736621657316d8a9e (diff) | |
| download | brew-bd0533448718bbf323e58070fc711d662c54b855.tar.bz2 | |
test: improve docs for when using HEAD or similar flags
Closes Homebrew/homebrew#29791.
Signed-off-by: Adam Vandenberg <flangy@gmail.com>
Diffstat (limited to 'Library')
| -rw-r--r-- | Library/Contributions/manpages/brew.1.md | 3 | ||||
| -rw-r--r-- | Library/Homebrew/cmd/create.rb | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index 492aecc25..49dde2d56 100644 --- a/Library/Contributions/manpages/brew.1.md +++ b/Library/Contributions/manpages/brew.1.md @@ -334,7 +334,8 @@ Note that these flags should only appear after a command. 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. + formula. Options passed to `brew install` such as `--HEAD` also need to + be provided to `brew test`. Example: `brew install jruby && brew test jruby` diff --git a/Library/Homebrew/cmd/create.rb b/Library/Homebrew/cmd/create.rb index 04ebe5d2e..84697b830 100644 --- a/Library/Homebrew/cmd/create.rb +++ b/Library/Homebrew/cmd/create.rb @@ -165,7 +165,8 @@ class FormulaCreator # # This test will fail and we won't accept that! It's enough to just replace # "false" with the main program this formula installs, but it'd be nice if you - # were more thorough. Run the test with `brew test #{name}`. + # were more thorough. Run the test with `brew test #{name}`. Options passed + # to `brew install` such as `--HEAD` also need to be provided to `brew test`. # # The installed folder is not in the path, so use the entire path to any # executables being tested: `system "\#{bin}/program", "do", "something"`. |