X-Git-Url: https://git.cworth.org/git?p=apitrace-tests;a=blobdiff_plain;f=traces%2FREADME.markdown;h=805ab98c689401c9ec42d1e03c7486d096543033;hp=141fafd3d79ca7d3cfb4d29c0bce7162d6b2f832;hb=8351c1e187d8f65477db05a07bacd5d184c2b950;hpb=8a63a6b0f98da88770d3479a1166ec92e8c72e7f

diff --git a/traces/README.markdown b/traces/README.markdown
index 141fafd..805ab98 100644
--- a/traces/README.markdown
+++ b/traces/README.markdown
@@ -1,6 +1,29 @@
-zlib-no-eof.trace is a short, zlib compressed trace, with an unexpected end of
-file because the application terminated abnormally (which is actual very
-normal).
+This directory tests various operations of the apitrace command-line
+interface (cli) operating on existings.
 
-Depending on how zlib handles the unexpected end of file, it may fail to read
-any data from it.
+All files with a .script extension specify a simple script for
+testing. The test driver (in ../tool_driver.py) will parse the script
+file line-by-line, interpreting each line as arguments to the apitrace
+cli interface and invoking the cli with the given arguments. This
+continues until the first line of the script beginning with the "dump"
+command.
+
+After a "dump" command in the script, the remainder of the script file
+provides the expected output of the given dump command. The tool
+driver will report a test failure if the actual dump output differs
+from that given in the.
+
+Here are descriptions of some of the trace files contained here which
+are used by the test scripts:
+
+*   zlib-no-eof.trace:  is a short, zlib compressed trace, with an unexpected end of
+    file because the application terminated abnormally (which is actual very
+    normal).
+
+    Depending on how zlib handles the unexpected end of file, it may fail to read
+    any data from it.
+
+*   incomplete-call.trace:  trace with an incomplete call, with missing arguments
+
+*   glxsimple.trace: trace from a simple program showing drawing with
+    glClear, with GLSL shader, and with texture. See ../cli/src
\ No newline at end of file