doc: global-test-result not test-global-result.

Report from Tomas Volf,
https://lists.gnu.org/archive/html/automake/2026-03/msg00004.html

* doc/automake.texi (Command-line arguments for test drivers):
use global-test-result not test-global-result, since that is
what's actually in the .trs files.
* t/test-metadata-results.sh: likewise.

diff --git a/doc/automake.texi b/doc/automake.texi
index 9b87bd513afb1767e9d6501e3242cce85007776e..ad52207b4ae4ff9f52dd52d5684381291a0ac4f9 100644 (file)
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -5602,7 +5602,7 @@ mymodule_la_LDFLAGS = -module
 
 Ordinarily, Automake requires that a library's name start with
 @code{lib}.  However, when building a dynamically loadable module you
-might wish to use a "nonstandard" name.  Automake will not complain
+might wish to use a ``nonstandard'' name.  Automake will not complain
 about such nonstandard names if it knows the library being built is a
 libtool module, i.e., if @option{-module} explicitly appears in the
 library's @code{_LDFLAGS} variable (or in the common @code{AM_LDFLAGS}
@@ -10427,17 +10427,17 @@ successful.  What happens when two or more @code{:copy-in-global-log:}
 fields are present in the same @file{.trs} file is undefined behavior.
 
 @c Keep in sync with 'test-metadata-global-result.sh'.
-@item @code{:test-global-result:}
-@cindex :test-global-result:
-@cindex reStructuredText field, @code{:test-global-result:}
-This is used to declare the "global result" of the script.  Currently,
-the value of this field is needed only to be reported (more or less
+@item @code{:global-test-result:}
+@cindex :global-test-result:
+@cindex reStructuredText field, @code{:global-test-result:}
+This is used to declare the ``global result'' of the script.  Currently,
+the value of this field is only needed to be reported (more or less
 verbatim) in the generated global log file @code{$(TEST_SUITE_LOG)},
 so it's quite free-form.  For example, a test script which runs 10 test
 cases, 6 of which pass and 4 of which are skipped, could reasonably have
 a @code{PASS/SKIP} value for this field, while a test script which runs
 19 successful tests and one failed test could have an @code{ALMOST
-PASSED} value.  What happens when two or more @code{:test-global-result:}
+PASSED} value.  What happens when two or more @code{:global-test-result:}
 fields are present in the same @file{.trs} file is undefined behavior.
 @end table
 

diff --git a/t/test-metadata-results.sh b/t/test-metadata-results.sh
index f7f0fece1521a3a2c56c5c52431bc081f6553e61..f0ccf926ef1a204d6be64fb91c2387321bda64bb 100644 (file)
--- a/t/test-metadata-results.sh
+++ b/t/test-metadata-results.sh
@@ -94,12 +94,12 @@ mk_check
 count_test_results total=0 pass=0 fail=0 xpass=0 xfail=0 skip=0 error=0
 
 cat > foo.test <<END
-:test-global-result: PASS
+:global-test-result: PASS
 :test-result: FAIL
 END
 cat > bar.test <<END
 :test-result: SKIP
-:test-global-result: ERROR
+:global-test-result: ERROR
 END
 mk_check -e FAIL
 count_test_results total=2 pass=0 fail=1 xpass=0 xfail=0 skip=1 error=0
@@ -107,18 +107,18 @@ count_test_results total=2 pass=0 fail=1 xpass=0 xfail=0 skip=1 error=0
 cat > foo.test <<END
 FAIL: foo.test
 :test-result: PASS
-:test-global-result: XPASS
+:global-test-result: XPASS
 END
 echo ERROR: bar.test > bar.test
 mk_check
 count_test_results total=1 pass=1 fail=0 xpass=0 xfail=0 skip=0 error=0
 
 cat > foo.test <<END
-:test-global-result: SKIP
+:global-test-result: SKIP
 :test-result: FAIL
 END
 cat > bar.test <<END
-:test-global-result: PASS
+:global-test-result: PASS
 END
 mk_check -e FAIL
 count_test_results total=1 pass=0 fail=1 xpass=0 xfail=0 skip=0 error=0