Add some comments to the recently-added cli tests.

[apitrace-tests] / cli / cli-diff-images.script

diff --git a/cli/cli-diff-images.script b/cli/cli-diff-images.script
index cb4630f3b6e489ee255b1be1675570b2075ba40c..e575f1a6149a6a806336e08f02330c4c842472ca 100644 (file)
--- a/cli/cli-diff-images.script
+++ b/cli/cli-diff-images.script
@@ -1,4 +1,18 @@
+# Make a directory for the output images
+
 rm_and_mkdir ./tri-out
+
+# Generate images for every frame (only 1) of a trace
+
 apitrace dump-images -o ./tri-out/tri tri.trace
+
+# Compare the result of "apitrace dump-images" with our reference
+
 apitrace diff-images -v ./tri-ref ./tri-out
+
+# Ensure that the "apitrace diff-images" actually did something.  This
+# is important since if it couldn't find images in one directory or
+# the other then it would just silently return 0 and this test would
+# incorrectly pass.
+
 expect "Comparing ./tri-ref/tri0000000027.png and ./tri-out/tri0000000027.png ... MATCH\n"