mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-06-01 07:08:12 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/subprojects/gst-devtools/validate/gst/validate/doc/meta-expected-issues.md
Thibault Saunier 93f1ffe715 validate: doc: Enhance the way we render action type parameters 
And update gst-validate-action-types.md

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5803>
2023-12-27 02:14:19 +00:00

1.2 KiB
Raw Blame History

The expected-issues field is an array of expected-issue structures containing information about issues to expect (which can be known bugs or not).

Use gst-validate-1.0 --print-issue-types to print information about all issue types.

For example:

expected-issues = {
    "expected-issue, issue-id=scenario::not-ended",
}

Note: Since this is GstStructure syntax, we need to have the structures in the array as strings/within quotes.

Each issue has the following fields:

  • issue-id: (string): Issue ID - Mandatory if summary is not provided.
  • summary: (string): Summary - Mandatory if issue-id is not provided.
  • details: Regex string to match the issue details detected-on: (string): The name of the element the issue happened on level: (string): Issue level
  • sometimes: (boolean): Default: false - Whether the issue happens only sometimes if false and the issue doesn't happen, an error will be issued.
  • issue-url: (string): The url of the issue in the bug tracker if the issue is a bug.

Warning: This field is validate only for .validatetest files, and not .scenario.