|
From: <sv...@va...> - 2005-06-13 16:44:35
|
Author: sewardj
Date: 2005-06-13 17:44:33 +0100 (Mon, 13 Jun 2005)
New Revision: 3905
Log:
Update with recent (minor) changes.
Modified:
trunk/README_XML_OUTPUT.txt
Modified: trunk/README_XML_OUTPUT.txt
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/README_XML_OUTPUT.txt 2005-06-13 08:46:57 UTC (rev 3904)
+++ trunk/README_XML_OUTPUT.txt 2005-06-13 16:44:33 UTC (rev 3905)
@@ -24,7 +24,9 @@
* Put as much information as possible into the XML and let the GUIs
decide what to show the user (a.k.a provide mechanism, not policy).
=20
+* Make XML which is actually parseable by standard XML tools.
=20
+
How to use
~~~~~~~~~~
=20
@@ -76,11 +78,23 @@
TEXT is arbitrary text.
HEX64 is a 64-bit hexadecimal number, with leading "0x".
=20
+Text strings are escaped so as to remove the <, > and & characters
+which would otherwise mess up parsing. They are replaced respectively
+with the standard encodings "<", ">" and "&" respectively.
+Note this is not (yet) done throughout, only for function names in
+<frame>..</frame> tags-pairs.
=20
+
TOPLEVEL
--------
-All output is contained within the tag-pair <valgrindoutput>.
=20
+The first line output is always this:
+
+ <?xml version=3D"1.0"?>
+
+All remaining output is contained within the tag-pair
+<valgrindoutput>.
+
Inside that, the first entity is an indication of the protocol
version. This is provided so that existing parsers can identify XML
created by future versions of Valgrind merely by observing that the
@@ -107,7 +121,9 @@
components. The text in them can be anything; it is not intended
for interpretation by the GUI:
=20
- <preamble>Misc version/copyright text</preamble>
+ <preamble>
+ <line>Misc version/copyright text</line> (zero or more of)
+ </preamble>
=20
* The PID of this process and of its parent:
=20
@@ -284,6 +300,7 @@
<ip>HEX64</ip>
optionally <obj>TEXT</obj>
optionally <fn>TEXT</fn>
+ optionally <dir>TEXT</dir>
optionally <file>TEXT</file>
optionally <line>INT</line>
</frame>
@@ -297,6 +314,10 @@
=20
* fn: gives the name of the function containing the code address
=20
+* dir: gives the source directory associated with the name specified
+ by <file>. Note the current implementation often does not
+ put anything useful in this field.
+
* file: gives the name of the source file containing the code address
=20
* line: gives the line number in the source file
@@ -335,3 +356,4 @@
=20
The <name> is as specified in the suppression name fields in .supp
files.
+
|