summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2010-07-05 18:37:30 (GMT)
committerJunio C Hamano <gitster@pobox.com>2010-07-05 18:37:30 (GMT)
commit6fd45295ae0abf424c2e8a71118dcd277778abff (patch)
treebc5026089a7575a61d0bac3d99873704987863d9
parent20873f45e7fe23a8530e643d2eea9566d57f2fd4 (diff)
downloadgit-6fd45295ae0abf424c2e8a71118dcd277778abff.zip
git-6fd45295ae0abf424c2e8a71118dcd277778abff.tar.gz
git-6fd45295ae0abf424c2e8a71118dcd277778abff.tar.bz2
t/README: proposed rewording...
Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--t/README21
1 files changed, 8 insertions, 13 deletions
diff --git a/t/README b/t/README
index e481657..271f868 100644
--- a/t/README
+++ b/t/README
@@ -234,17 +234,15 @@ This test harness library does the following things:
Do's, don'ts & things to keep in mind
-------------------------------------
-Here's a few examples of things you probably should and shouldn't do
+Here are a few examples of things you probably should and shouldn't do
when writing tests.
Do:
- - Put as much code as possible inside test_expect_success and other
- assertions.
+ - Put all code inside test_expect_success and other assertions.
Even code that isn't a test per se, but merely some setup code
- should be inside a test assertion if at all possible. Test scripts
- should only have trivial code outside of their assertions.
+ should be inside a test assertion.
- Chain your test assertions
@@ -280,16 +278,15 @@ Don't:
- Break the TAP output
- The raw output from your test might be interpreted by a TAP
- harness. You usually don't have to worry about that. TAP harnesses
- will ignore everything they don't know about, but don't step on
- their toes in these areas:
+ The raw output from your test may be interpreted by a TAP harness. TAP
+ harnesses will ignore everything they don't know about, but don't step
+ on their toes in these areas:
- Don't print lines like "$x..$y" where $x and $y are integers.
- Don't print lines that begin with "ok" or "not ok".
- A TAP harness expect a line that begins with either "ok" and "not
+ TAP harnesses expect a line that begins with either "ok" and "not
ok" to signal a test passed or failed (and our harness already
produces such lines), so your script shouldn't emit such lines to
their output.
@@ -301,9 +298,7 @@ Don't:
Keep in mind:
- - That what you print to stderr and stdout is usually ignored
-
- Inside <script> part, the standard output and standard error
+ - Inside <script> part, the standard output and standard error
streams are discarded, and the test harness only reports "ok" or
"not ok" to the end user running the tests. Under --verbose, they
are shown to help debugging the tests.