eeprom93xx: Add a test-case for the new format=ascii option.

[sigrok-test.git] / README

diff --git a/README b/README
index 6d20e172781b38825d01f893aa21b41e25b97e26..962658ae5a71fd3dffe51e08d8bfbe3648b34784 100644 (file)
--- a/README
+++ b/README
@@ -54,6 +54,49 @@ This will test the decoders located at /path/to/decoders:
  $ LD_LIBRARY_PATH=$HOME/sr/lib ./decoder/pdtest -r -v -a
 
 
+Adding tests
+------------
+
+The best way to add tests is to copy one that is similar, and adjust
+accordingly. Some notes:
+
+ * In test.conf, the channel assignments must be done in a specific way:
+
+    protocol-decoder <pdname> channel <pd_channel_name>=<#> ...
+
+   Example:
+
+    protocol-decoder mcs48 d0=8 d1=9 [...] a8=0 ...
+
+   Of important note, the channels/probes are numbered from 0, regardless of
+   the naming used in the capture file.
+
+ * To initially generate the test files which have been configured in test.conf
+   pdtest has to be run with the -f parameter first.
+
+   Example:
+
+    ./decoder/pdtest -r -v -f <testroot>
+
+  This can also be done to update the test-cases in case of a changes in
+  the protocol decoder.
+
+ * To troubleshoot a specific test, try:
+
+    * Run all tests under decoder/test/<testroot>:
+
+      ./decoder/pdtest -v -d -r <testroot>
+
+    * Run the named test. Note, in this case <testname> is not
+      a file but rather a test described in <testroot>/test.conf.
+
+      ./decoder/pdtest -v -d -r <testroot>/<testname>
+
+    * Print parameters as parsed from <testroot>/test.conf (to spot typos):
+
+      ./decoder/pdtest -v -s <testroot>
+
+
 Copyright and license
 ---------------------