From bd0533448718bbf323e58070fc711d662c54b855 Mon Sep 17 00:00:00 2001 From: Dave Cottlehuber Date: Mon, 2 Jun 2014 22:30:22 +0200 Subject: [PATCH] test: improve docs for when using HEAD or similar flags Closes Homebrew/homebrew#29791. Signed-off-by: Adam Vandenberg --- Library/Contributions/manpages/brew.1.md | 3 ++- 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 492aecc25e..49dde2d56a 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 ` 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 04ebe5d2ea..84697b830e 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"`.