summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThibault Saunier <tsaunier@igalia.com>2020-04-28 23:06:24 -0400
committerThibault Saunier <tsaunier@igalia.com>2020-04-29 10:13:51 -0400
commitec2a139246b3f09542e12fda885aa84be1f8706b (patch)
tree618ab4c947fbbdd8911dd62852c1f10528221586 /docs
parent0e85d15da05f2a37f8376778384ecef388240c70 (diff)
downloadgstreamer-ec2a139246b3f09542e12fda885aa84be1f8706b.tar.gz
validate: Allow overidding issue severity from configs
Refactoring sensibly to allow getting configs outside the `core` namespace and outside plugin names. The `GST_VALIDATE_OVERRIDE` env variable should probably be removed all together at some point. Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-devtools/-/merge_requests/185>
Diffstat (limited to 'docs')
-rw-r--r--docs/gst-validate-config.md21
1 files changed, 18 insertions, 3 deletions
diff --git a/docs/gst-validate-config.md b/docs/gst-validate-config.md
index a4bcea268b..c2f5e0784b 100644
--- a/docs/gst-validate-config.md
+++ b/docs/gst-validate-config.md
@@ -27,7 +27,7 @@ See [GstValidateVerbosityFlags](GstValidateVerbosityFlags) for possible values.
The [action type](gst-validate-action-types.md) to execute, the action type
must be a CONFIG action or the action type must have a `as-config` argument. When the `action`
-is specified in a parametter, a validate action is executed using the other parametters of the
+is specified in a parameter, a validate action is executed using the other parameters of the
config as configuration for the validate scenario action.
#### Example:
@@ -72,7 +72,7 @@ Defaults variables are:
- `$(CONFIG_DIR)`: The directory the running scenario is in.
- `$(CONFIG_NAME)`: The name of the config file
- `$(LOGSDIR)`: The directory where to place log files. This uses the
- `GST_VALIDATE_LOGSDIR` environment variable if avalaible or `$(TMPDIR)` if
+ `GST_VALIDATE_LOGSDIR` environment variable if available or `$(TMPDIR)` if
the variables hasn't been set. (Note that the
[gst-validate-launcher](gst-validate-launcher.md) set the environment
variables).
@@ -88,4 +88,19 @@ It is also possible to set global variables (also usable from
``` yaml
set-globals, TESTSUITE_ROOT_DIR=$(CONFIG_DIR)
-``` \ No newline at end of file
+```
+
+## `change-issue-severity` settings parameters
+
+You can change issues severity with the `change-issue-severity` configuration
+with the following parameters:
+
+* `issue-id`: The GQuark name of the issue, for example: `event::segment-has-wrong-start`,
+ You can use `gst-validate-1.0 --print-issue-types` to list all issue types.
+* `new-severity`: The new [`severity`](GstValidateReportLevel) of the issue
+* `element-name` (*optional*): The name of the element the severity
+ change applies to
+* `element-factory-name` (*optional*): The element factory name of the elements the
+ severity change applies to
+* `element-classification` (*optional*): The classification of the elements the
+ severity change applies to