t/README: proposed rewording...
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Jul 5, 2010 at 11:37 UTC
6fd45295ae0abf424c2e8a71118dcd277778abff
1 file changed
+8
-13
t/README
+8
-13
@@ -234,17 +234,15 @@ This test harness library does the following things:
234
Do's, don'ts & things to keep in mind
235
-------------------------------------
236
237
-Here's a few examples of things you probably should and shouldn't do
237
+Here are a few examples of things you probably should and shouldn't do
238
when writing tests.
239
240
Do:
241
242
- - Put as much code as possible inside test_expect_success and other
243
- assertions.
242
+ - Put all code inside test_expect_success and other assertions.
243
244
Even code that isn't a test per se, but merely some setup code
246
- should be inside a test assertion if at all possible. Test scripts
247
- should only have trivial code outside of their assertions.
245
+ should be inside a test assertion.
246
247
- Chain your test assertions
248
@@ -280,16 +278,15 @@ Don't:
278
279
- Break the TAP output
280
283
- The raw output from your test might be interpreted by a TAP
284
- harness. You usually don't have to worry about that. TAP harnesses
285
- will ignore everything they don't know about, but don't step on
286
- their toes in these areas:
281
+ The raw output from your test may be interpreted by a TAP harness. TAP
282
+ harnesses will ignore everything they don't know about, but don't step
283
+ on their toes in these areas:
284
285
- Don't print lines like "$x..$y" where $x and $y are integers.
286
287
- Don't print lines that begin with "ok" or "not ok".
288
292
- A TAP harness expect a line that begins with either "ok" and "not
289
+ TAP harnesses expect a line that begins with either "ok" and "not
290
ok" to signal a test passed or failed (and our harness already
291
produces such lines), so your script shouldn't emit such lines to
292
their output.
@@ -301,9 +298,7 @@ Don't:
298
299
Keep in mind:
300
304
- - That what you print to stderr and stdout is usually ignored
305
-
306
- Inside <script> part, the standard output and standard error
301
+ - Inside <script> part, the standard output and standard error
302
streams are discarded, and the test harness only reports "ok" or
303
"not ok" to the end user running the tests. Under --verbose, they
304
are shown to help debugging the tests.