Francois Gouget : testbot/LogUtils: Move the .errors format documentation to LoadLogErrors().

[Alexandre Julliard]

Module: tools
Branch: master
Commit: e6a493fa40dc999ba64e8f64e7a412ef91497dbb
URL:    https://source.winehq.org/git/tools.git/?a=commit;h=e6a493fa40dc999ba64e8f64e7a412ef91497dbb

Author: Francois Gouget <fgouget at codeweavers.com>
Date:   Tue Jan 19 18:55:51 2021 +0100

testbot/LogUtils: Move the .errors format documentation to LoadLogErrors().

Signed-off-by: Francois Gouget <fgouget at codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard at winehq.org>

---

 testbot/lib/WineTestBot/LogUtils.pm | 60 ++++++++++++++++++-------------------
 1 file changed, 30 insertions(+), 30 deletions(-)

diff --git a/testbot/lib/WineTestBot/LogUtils.pm b/testbot/lib/WineTestBot/LogUtils.pm
index 77837fb..1e7dcda 100644
--- a/testbot/lib/WineTestBot/LogUtils.pm
+++ b/testbot/lib/WineTestBot/LogUtils.pm
@@ -822,6 +822,7 @@ sub GetLogLabel($)
   return defined $Label ? sprintf($Label, $Extra) : $LogFileName;
 }
 
+
 #
 # Log errors caching [Part 1]
 #
@@ -833,10 +834,36 @@ sub GetLogLabel($)
 
 Loads the specified log errors file.
 
-See _WriteLogErrors() for the format of the errors file.
-
 Returns the errors in the same format as TagNewErrors().
 
+All lines are of the following form:
+  <type> <value1> <value2>
+
+The values depend on the <type> of the line. <type> and <value1> must not
+contain spaces while <value2> runs to the end of the line.
+More specifically the line formats are:
+=over
+
+=item p <name> <value>
+Property lines contain (name, value) pairs.
+Note that properties which can be calculated while reading the errors file
+are not saved (e.g. ErrCount and NewCount).
+
+=item g <lineno> <groupname>
+Group lines contain the group name and the line number of the first line of
+the group in the log. Note that the first line would typically not be an
+error line.
+A group line should be followed by the old and new error lines in this group.
+
+=item o <lineno> <line>
+Old error lines contain the line number of the error in the log and a verbatim
+copy of that line (with CR/LF converted to a simple LF).
+
+=item n <lineno> <line>
+The format for new error lines is identical to that for old errors but with a
+different type.
+
+=back
 =back
 =cut
 
@@ -919,35 +946,8 @@ sub LoadLogErrors($)
 =item C<_WriteLogErrors()>
 
 Writes the LogInfo structure in text form to the specified file descriptor.
+See _LoadLogErrors() for the format of the errors file.
 
-All lines follow are of the following form:
-  <type> <value1> <value2>
-
-The values depend on the <type> of the line. <type> and <value1> must not
-contain spaces while <value2> runs to the end of the line. More specifically
-the line formats are:
-=over
-
-=item p <name> <value>
-Property lines contain (name, value) pairs.
-Note that properties which can be calculated while reading the errors file
-are not saved (e.g. ErrCount and NewCount).
-
-=item g <lineno> <groupname>
-Group lines contain the group name and the line number of the first line of
-the group in the log. Note that the first line would typically not be an
-error line.
-A group line should be followed by the old and new error lines in this group.
-
-=item o <lineno> <line>
-Old error lines contain the line number of the error in the log and a verbatim
-copy of that line (with CR/LF converted to a simple LF).
-
-=item n <lineno> <line>
-The format for new error lines is identical to that for old errors but with a
-different type.
-
-=back
 =back
 =cut