aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/test.rb
diff options
context:
space:
mode:
authorMax Nordlund2016-04-08 16:28:43 +0200
committerMartin Afanasjew2016-04-10 22:59:25 +0200
commitfa1fd70a37c4ab843cb3d61c4301e44828c7b5ec (patch)
treec96f4a8b24e229fe6624c6a3a5cb4e6d593a0c85 /Library/Homebrew/cmd/test.rb
parentb21f699ff2f1691c4f10422c640a9d392cf2d7a7 (diff)
downloadbrew-fa1fd70a37c4ab843cb3d61c4301e44828c7b5ec.tar.bz2
Add all the top level comments
Diffstat (limited to 'Library/Homebrew/cmd/test.rb')
-rw-r--r--Library/Homebrew/cmd/test.rb14
1 files changed, 14 insertions, 0 deletions
diff --git a/Library/Homebrew/cmd/test.rb b/Library/Homebrew/cmd/test.rb
index b5a0afe8d..ffb9c169d 100644
--- a/Library/Homebrew/cmd/test.rb
+++ b/Library/Homebrew/cmd/test.rb
@@ -1,3 +1,17 @@
+#: * `test` [`--devel`|`--HEAD`] [`--debug`] <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.
+#:
+#: To test the development or head version of a formula, use `--devel` or
+#: `--HEAD`.
+#:
+#: If `--debug` is passed and the test fails, an interactive debugger will be
+#: launched with access to IRB or a shell inside the temporary test directory.
+#:
+#: Example: `brew install jruby && brew test jruby`
+
require "extend/ENV"
require "formula_assertions"
require "sandbox"