mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-31 11:32:38 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: minor spelling/grammar fixes

Browse source
This commit is contained in:
Vincent Penquerc'h 2013-08-27 04:38:52 -04:00 committed by Thiago Santos
parent 2ba098976a
commit c79430a450
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
validate/docs/qa-design.txt
View file

@ -5,7 +5,7 @@ Gst-qa is composed of 4 parts: the issues, the reports, the runner and the
reporters. reporters.
= Issue = Issue
Gst-QA main target is finding problems in GStreamer elements/pipelines. To Gst-QA's main target is finding problems in GStreamer elements/pipelines. To
make it easier to track down exactly what happens, the tests run by Gst-QA use make it easier to track down exactly what happens, the tests run by Gst-QA use
an extensible list of 'Issues'. Each Issue describes a potential error an extensible list of 'Issues'. Each Issue describes a potential error
situation and has an unique ID and a severity level. situation and has an unique ID and a severity level.
@ -15,15 +15,15 @@ should be met.
= Reporters = Reporters
A reporter is the object that implements the GstQaReporter interface and is A reporter is the object that implements the GstQaReporter interface and is
responsible for perfoming tests on some target element/scenario. The reporter responsible for performing tests on some target element/scenario. The reporter
is able to create 'Reports' whenever a test it executes fails. is able to create 'Reports' whenever a test it executes fails.
= Reports = Reports
The GstQaReports are created whenever a test fails, it is posted to the stderr The GstQaReports are created whenever a test fails, they are posted to the
and also are posted to the GstQaRunner for accumulation. stderr and also are posted to the GstQaRunner for accumulation.
Each report contains information about the object that generated the issue, Each report contains information about the object that generated the issue,
the issue associated with the reprot and a specific debug message for the case, the issue associated with the report and a specific debug message for the case,
this helps tracking down the problem and fixing it. this helps tracking down the problem and fixing it.
= Runner = Runner
@ -34,8 +34,8 @@ to the application.
== Reporter types == Reporter types
= Monitors = Monitors
The monitors are used to wrap around pipeline (and elements and pads) and The monitors are used to wrap around pipelines (and elements and pads) and
attach to its data flow handling functions to be able to intercept the data attach to their data flow handling functions to be able to intercept the data
and compare it with the expected behaviors. There are 3 types of monitors: and compare it with the expected behaviors. There are 3 types of monitors:
* GstQaElementMonitor * GstQaElementMonitor
@ -45,7 +45,7 @@ and compare it with the expected behaviors. There are 3 types of monitors:
All 3 inherit from the base GstQaMonitor class. Their name suggest what they All 3 inherit from the base GstQaMonitor class. Their name suggest what they
monitor and they have a relationship to their children and parents. A bin monitor and they have a relationship to their children and parents. A bin
monitor has, possibly, child element monitors and element monitors have child monitor has, possibly, child element monitors and element monitors have child
pad monitors. The monitors are responsible for listenning to new childs added pad monitors. The monitors are responsible for listening to new children added
to their monitored object and creating monitors for them. For example, element to their monitored object and creating monitors for them. For example, element
monitors listen to element's pad-added signal and create pad monitors whenever monitors listen to element's pad-added signal and create pad monitors whenever
a new pad is added. a new pad is added.

2
validate/docs/qa-usage.txt
View file

@ -20,7 +20,7 @@ use:
LD_PRELOAD=path/to/libgstqa.so yourapp ... LD_PRELOAD=path/to/libgstqa.so yourapp ...
gst-qa will try to replace GstPipeline creating functions and already gst-qa will try to replace GstPipeline creating functions and already
configure runners and monitors for you, reports will be printed to stdout when configure runners and monitors for you, reports will be printed to stderr when
they are found. they are found.