From 759b087c8c0be23e3695d4be60d62b86857c5e63 Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Fri, 6 Feb 2015 12:20:30 +0100 Subject: [PATCH] validate: Document some env variable usage --- validate/docs/validate/envvariables.xml | 80 +++++++++++++++++++++++++ 1 file changed, 80 insertions(+) diff --git a/validate/docs/validate/envvariables.xml b/validate/docs/validate/envvariables.xml index 91f88fe73a..43f9385967 100644 --- a/validate/docs/validate/envvariables.xml +++ b/validate/docs/validate/envvariables.xml @@ -112,5 +112,85 @@ + + <envar>GST_VALIDATE_REPORTING_DETAILS</envar> + + + The reporting level can be set through the "GST_VALIDATE_REPORTING_DETAILS" + environment variable, as a comma-separated list of (optional) object categories / names + and levels. No object category / name sets the global level. + + + Examples: + + GST_VALIDATE_REPORTING_DETAILS=synthetic,h264parse:all + GST_VALIDATE_REPORTING_DETAILS=none,h264parse::sink_0:synthetic + + + + Levels being: + + + + none + No debugging level specified or desired. Used to deactivate debugging output. + + + + + synthetic + + + + Summary of the issues found, with no details. + + + + + + subchain + + + + If set as the default level, similar issues can be reported multiple times for + different subchains. If set as the level for a particular object (my_object:subchain), + validate will report the issues where the object is the first to report an issue for + a subchain. + + + + + + monitor + + + + If set as the default level, all the + distinct issues for all the monitors will be reported. + If set as the level for a particular object, all the distinct issues for this object + will be reported. + Note that if the same issue happens twice on the same object, up until this + level that issue is only reported once. + + + + + + all + + + + All the issues will be reported, even those + that repeat themselves inside the same object. This can be *very* verbose if + set globally. + + + + + Setting the reporting level allows to control the way issues are reported + when calling #gst_validate_runner_printf. + + +