Skip to content

Commit

Permalink
test-lib: document short options in t/README
Browse files Browse the repository at this point in the history
Most arguments that could be provided to a test have short forms.
Unless documented, the only way to learn them is to read the code.

Signed-off-by: Ilya Bobyr <ilya.bobyr@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Ilya Bobyr authored and Junio C Hamano committed Jun 6, 2014
1 parent 779792a commit 5e3b4fc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions t/README
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ You can pass --verbose (or -v), --debug (or -d), and --immediate
(or -i) command line argument to the test, or by setting GIT_TEST_OPTS
appropriately before running "make".

-v::
--verbose::
This makes the test more verbose. Specifically, the
command being run and their output if any are also
Expand All @@ -81,6 +82,7 @@ appropriately before running "make".
numbers matching <pattern>. The number matched against is
simply the running count of the test within the file.

-d::
--debug::
This may help the person who is developing a new test.
It causes the command defined with test_debug to run.
Expand All @@ -89,13 +91,15 @@ appropriately before running "make".
failed tests so that you can inspect its contents after
the test finished.

-i::
--immediate::
This causes the test to immediately exit upon the first
failed test. Cleanup commands requested with
test_when_finished are not executed if the test failed,
in order to keep the state for inspection by the tester
to diagnose the bug.

-l::
--long-tests::
This causes additional long-running tests to be run (where
available), for more exhaustive testing.
Expand Down

0 comments on commit 5e3b4fc

Please sign in to comment.