X-Git-Url: https://git.cworth.org/git?p=apitrace-tests;a=blobdiff_plain;f=traces%2FREADME.markdown;fp=traces%2FREADME.markdown;h=2d5d6751bcb790c35d24970017983c5ebfccff64;hp=2fd26af7360e8497f0a670663a6e8bb3a629f4a5;hb=91faeeeba1480af986a451306076286a510a10da;hpb=06b0dac15dd0a20178a77ff799a0ba5af5e545db

diff --git a/traces/README.markdown b/traces/README.markdown
index 2fd26af..2d5d675 100644
--- a/traces/README.markdown
+++ b/traces/README.markdown
@@ -1,3 +1,21 @@
+This directory tests various operations of the apitrace command-line
+interface (cli) operating on existings.
+
+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).