summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorstephan.thiele <stephan.thiele@mailbox.org>2018-10-20 17:23:23 +0200
committerUwe Hermann <uwe@hermann-uwe.de>2018-10-21 19:25:55 +0200
commiteb7f7eff3c04cac2dfc84990cf2b487e95a31ee4 (patch)
tree8f11b9a88f030fd88f7aa0e254d2a9a7c2de0638 /README
parent3c35aaa05492cfa60c9482634987b50c5b7b2d38 (diff)
downloadsigrok-test-eb7f7eff3c04cac2dfc84990cf2b487e95a31ee4.tar.gz
sigrok-test-eb7f7eff3c04cac2dfc84990cf2b487e95a31ee4.zip
README: improve pdtest documentation
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 11 insertions, 1 deletions
diff --git a/README b/README
index 85784b2..962658a 100644
--- a/README
+++ b/README
@@ -71,12 +71,22 @@ accordingly. Some notes:
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.