tests: Mark check.gstreamer.gst_gstbin.test_watch_for_state_change flaky
[platform/upstream/gstreamer.git] / subprojects / gst-devtools / validate / README
1 == Gst-Validate
2
3 The goal of GstValidate is to be able to detect when elements are not
4 behaving as expected and report it to the user so he knows how things
5 are supposed to work inside a GstPipeline. In the end, fixing issues
6 found by the tool will ensure that all elements behave all together in
7 the expected way.
8
9 The easiest way of using GstValidate is to use one of its command-line
10 tools, located at tools/ directory. It is also possible to monitor
11 GstPipelines from any application by using the LD_PRELOAD gstvalidate
12 lib. The third way of using it is to write your own application that
13 links and uses libgstvalidate.
14
15 == BUILDING
16
17 Getting the code:
18
19 Releases are available at <URL>, download and extract the tarball. If you
20 want to use latest git version, do:
21
22 git clone <URI>
23
24 After cloning or extracting from a tarball, enter the gst-validate directory:
25
26 cd gst-validate
27
28 Build with:
29
30 meson build --prefix=<installation-prefix>
31 ninja -C build
32 sudo ninja -C build install (only if you want to install it)
33
34 Replace <installation-prefix> with your desired installation path, you can omit
35 the --prefix argument if you aren't going to install it or if you want the
36 default /usr/local. It is possible to use gst-validate CLI tools without
37 installation.
38
39 == INSTRUCTIONS
40
41 If you are looking for informations on how to use gst-validate -> docs/validate-usage.txt
42 If you are looking for informations on gst-validate design -> docs/validate-design.txt