Re: [PATCH v5 1/5] test-lib: Adjust output to be valid TAP format

On Fri, Jun 25, 2010 at 17:21, Junio C Hamano [off-list ref] wrote:

Ævar Arnfjörð Bjarmason [off-list ref] writes:

quoted

diff --git a/t/README b/t/README
index 0e4e8d8..aa4ed28 100644
--- a/t/README
+++ b/t/README

@@ -18,25 +18,48 @@ The easiest way to run tests is to say "make".  This runs all

...

This describes the general framework of tests from the point of view of a
person who runs them and reads their output well.  I'll replace ab/tap
topic with these five patches.

I'd however like to ask you to update the sections in t/README to help
test writers.  You have gained enough experience with patches 4 and 5 (and
with patch 2 for Perl tests) to know what kind of script constructs, used
by people who are used to the old way of writing our tests, would cause
the TAP stuff to break, and are in the ideal position to rewrite that
section.  Two examples of what is drastically different from the old world
order are "do not print to the standard output strings that begin with XX
(or partial lines)" and "here is how to skip the remainder of the tests",
but you may have a handful of more rules.  I expect that "Writing Tests"
through "Test harness library" sections would be affected.

Earlier I kept wondering if this series is worth the trouble.  Having to
learn and follow the set of these new rules is exactly what I meant by
"trouble".  Let's make sure that the new rules are clear, small, and easy
to follow for other contributors.

I'll write those docs, but I probably won't have time in the next few
days so I'll submit a patch for that it separately if that's OK.