[5981] update README's for makeinfo test suite

[Gavin D. Smith]

Revision: 5981
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=5981
Author:   gavin
Date:     2014-12-20 22:25:00 +0000 (Sat, 20 Dec 2014)
Log Message:
-----------
update README's for makeinfo test suite

Modified Paths:
--------------
    trunk/tp/t/README
    trunk/tp/tests/README

Modified: trunk/tp/t/README
===================================================================
--- trunk/tp/t/README   2014-12-20 18:26:42 UTC (rev 5980)
+++ trunk/tp/t/README   2014-12-20 22:25:00 UTC (rev 5981)
@@ -1,17 +1,31 @@
-Most test files use a testing infrastructure from t/test_utils.pl.  In that
-case the references for the test of a test category $test_category.t file 
-are in  t/results/$test_category/.  They are regenerated with the -g option 
-given to the .t file, as in
+Most test files use a testing infrastructure from t/test_utils.pl.
 
-  perl -w t/60macro.t -g
+In that case the reference output files for the test of a test category 
+$test_category.t file are in t/results/$test_category/.  For example, if 
+after running "make check" test-suite.log contains a line like:
 
-To regenerate a precise test reference file, the test name should be in
-argument, for example to regenerate the reference files for 
-arg_body_expansion_order:
+FAIL: t/03coverage_braces.t 324 - test_image converted html
 
-  perl -w t/60macro.t -g arg_body_expansion_order
+you can see the difference between the expected and actual output with
 
+  diff t/results/coverage_braces/test_image.pl{,.new}
 
+To review all the differences for one of the *.t test files, you can do:
+
+  for f in t/results/coverage_braces/*.pl; do echo --------; echo \
+  Differences in $f; diff $f{,.new}; done | less
+
+The reference files are regenerated with the -g option given to the .t 
+file, as in
+
+  perl -w t/03coverage_braces.t -g
+
+To regenerate a specific test reference file, the test name should be 
+given as an argument.  For example, to just regenerate the reference 
+files for the "test_image" test within t/03.coverage_braces.t, run
+
+  perl -w t/03coverage_braces.t -g test_image
+
 From the top directory, you can also create texinfo files corresponding with
 tests by running something along
 

Modified: trunk/tp/tests/README
===================================================================
--- trunk/tp/tests/README       2014-12-20 18:26:42 UTC (rev 5980)
+++ trunk/tp/tests/README       2014-12-20 22:25:00 UTC (rev 5981)
@@ -1,7 +1,7 @@
 $Id$
 texinfo/tp/tests/README
 
-  Copyright (C) 2010, 2012 Free Software Foundation, Inc.
+  Copyright (C) 2010, 2012, 2014 Free Software Foundation, Inc.
 
   Copying and distribution of this README file, with or without
   modification, are permitted in any medium without royalty provided the
@@ -22,18 +22,20 @@
 
 Running the testsuite
 =====================
-This testsuite can be run 
+This testsuite can be run one of the following ways:
 
-* using the makefile rules: check for the base tests, long-checks for 
-  the long tests, or all-checks for both.
+* Using the makefile rules: "make check" (in this directory) for the 
+base tests, "make long-checks" for the long tests, or "make all-checks" 
+for both.
 
-* using ./parser_tests.sh with the list of directories in argument one 
-  want to run the tests in. 
+* Using ./parser_tests.sh with the directories one want to run the tests 
+in given as arguments 
 
-* by going in one directory and running ../run_parser_all.sh, like
+* By going into one directory and running ../run_parser_all.sh, like
 $ cd formatting
 $ ../run_parser_all.sh
-* by going in one directory and running one specific test, like
+
+* By going into one directory and running one specific test, like
 $ cd formatting
 $ ../run_parser_all.sh cond
 (see below for info on how test names are specified).
@@ -45,7 +47,7 @@
 and res_parser_html for html output with the default texi2any style. 
 Diffs are put in diffs. 
 
-If a test failed,
+If a test failed when run via parser_tests.sh or run_parser_all.sh, then
  F: a_test_directory 
 is printed, if there is a diff with the references, a
  D: a_test_directory
@@ -59,13 +61,14 @@
 
 The test results are in a directory below the out directories. This 
 directory name can be considered as the test name. Let's call it a_test
-for the remaining of the explanation. The stderr output is in 
-out_parser/a_test/a_test.2, stdout output is in out_parser/a_test/a_test.1. 
-All the commands called are output in tests.log.
+for the remainder of the explanation. The stderr output is in 
+out_parser/a_test/a_test.2, stdout output is in 
+out_parser/a_test/a_test.1.  All the commands called are output in 
+tests.log.
 
-giving -copy in argument to parser_tests.sh or ../run_parser_all.sh will 
-cause the references to be regenerated. This can also be achieved with 
-the copy-tests make target.
+Giving -copy as the first argument to parser_tests.sh or 
+../run_parser_all.sh will cause the references to be regenerated. This 
+can also be achieved with the copy-tests make target.
 
 
 TeX4ht and LaTeX2HTML tests