summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThibault Saunier <tsaunier@igalia.com>2019-06-23 11:58:11 -0400
committerThibault Saunier <tsaunier@igalia.com>2019-06-26 12:09:03 -0400
commit25a7173b22416ac4d33a08d0939fde5e90fd6bae (patch)
treec6f0fe404ddf2b7784c94f6bfe3b013bf9499438 /docs
parentade8ba3fcb2e2fa4ad54dfff3741b204fd94ccc3 (diff)
downloadgstreamer-25a7173b22416ac4d33a08d0939fde5e90fd6bae.tar.gz
validateflow: Add `buffers-checksum` option to log buffers data checksum
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/validateflow.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/plugins/validateflow.md b/docs/plugins/validateflow.md
index c35f9b2106..e2dea801c6 100644
--- a/docs/plugins/validateflow.md
+++ b/docs/plugins/validateflow.md
@@ -84,6 +84,7 @@ In order to use the plugin a validate configuration file must be provided, conta
* `pad`: Required. Name of the pad that will be monitored.
* `record-buffers`: Default: false. Whether buffers will be logged. By default only events are logged.
+ * `buffers-checksum`: Default: false. Whether a checkum of the buffer data is logged. Implies `record-buffers`.
* `ignored-event-fields`: Default: `stream-start=stream-id` (as they are often non reproducible). Key with a list of coma (`,`) separated list of fields to not record.
* `expectations-dir`: Path to the directory where the expectations will be written if they don't exist, relative to the current working directory. By default the current working directory is used, but this setting is usually set automatically as part of the `%(validateflow)s` expansion to a correct path like `~/gst-validate/gst-integration-testsuites/flow-expectations/<test name>`.
* `actual-results-dir`: Path to the directory where the events will be recorded. The expectation file will be compared to this. By default the current working directory is used, but this setting is usually set automatically as part of the `%(validateflow)s` expansion to the test log directory, i.e. `~/gst-validate/logs/validate/launch_pipeline/<test name>`.