Document the grand totals reported by report-card tool

2 files changed, 14 insertions, 1 deletions

diff --git a/ChangeLog b/ChangeLog
index dbf90c8..3f47e76 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2023-11-22  Jacob Bachmeyer  <jcb@gnu.org>
+
+	PR67391
+
+	* doc/dejagnu.texi (Invoking dejagnu report card): Document
+	existence of totals rows in the produced table.
+
 2023-11-07  Jacob Bachmeyer  <jcb@gnu.org>
 
 	PR66984
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi
index 43e13f6..f7a6e4c 100644
--- a/doc/dejagnu.texi
+++ b/doc/dejagnu.texi
@@ -10,7 +10,7 @@
 
 @copying
 @c man begin COPYRIGHT
-Copyright @copyright{} 1992-2020, 2022 Free Software Foundation, Inc.
+Copyright @copyright{} 1992-2020, 2022, 2023 Free Software Foundation, Inc.
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -1170,6 +1170,12 @@ summarized together with expected failures (@samp{XFAIL} and
 @samp{?FAIL}.  Additionally, if a test produced any warnings or
 errors, tags @samp{!W!} or @samp{!E!} are added at the end of the row.
 
+If DejaGnu's multiple-pass testing features were used, the table
+features an additional group of summary rows reporting totals for each
+named pass across all tools that ran that pass.  Lastly, the table
+ends with an unmarked grand total row reporting totals for all tools
+across all testing passes.
+
 @node Customizing DejaGnu, Extending DejaGnu, Running other DejaGnu commands, Top
 @chapter Customizing DejaGnu
 @cindex customization