Record XML output format changes.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5157

diff --git a/NEWS b/NEWS
index 6dfec4b32f5680288232400fc6bff9f5613b0917..2aa6963c67166a306a958297d290bc51e8b69156 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -56,6 +56,9 @@ Other user-visible changes:
   profile Valgrind using Cachegrind.  As a result a couple of
   performance bad cases have been fixed.
 
+- The XML output format has changed slightly.  See
+  docs/internals/xml-output.txt.
+
 The following are some user-visible changes that occurred in earlier
 versions that may not have been announced, or were announced but not
 widely noticed.  So we're mentioning them now.

diff --git a/docs/internals/xml-output.txt b/docs/internals/xml-output.txt
index 84f0fdb43a82dc09d2b94ba08cdfede66b26530e..631c0d21552097e6c07108c08c74a4b00436f90e 100644 (file)
--- a/docs/internals/xml-output.txt
+++ b/docs/internals/xml-output.txt
@@ -103,15 +103,28 @@ protocol version is one they don`t understand.  Hence TOPLEVEL is:
   <?xml version="1.0"?>
   <valgrindoutput>
     <protocolversion>INT<protocolversion>
-    VERSION1STUFF
+    PROTOCOL
   </valgrindoutput>
 
-The only currently defined protocol version number is 1.  This
-document only defines protocol version 1.
+Valgrind versions 3.0.0 and 3.0.1 emit protocol version 1.  Version
+3.1.0 emits protocol version 2.
 
 
-VERSION1STUFF
--------------
+PROTOCOL for version 2
+----------------------
+Version 2 is identical in every way to version 1, except that the time
+string in
+
+   <time>human-readable-time-string</time>
+
+has changed format, and is also elapsed wallclock time since process
+start, and not local time or any such.  In fact version 1 does not
+define the format of the string so in some ways this revision is
+irrelevant.
+
+
+PROTOCOL for version 1
+----------------------
 This is the main top-level construction.  Roughly speaking, it
 contains a load of preamble, the errors from the run of the
 program, and the result of the final leak check.  Hence the
@@ -184,7 +197,7 @@ following in sequence:
 * Zero or more ERRORs, each of which is a complaint from the
   leak checker.
 
-That`s it.
+That's it.
 
 
 ERROR