summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.net>2012-06-28 14:41:43 +0100
committerTim-Philipp Müller <tim@centricular.net>2012-06-28 14:47:22 +0100
commit7932f62891eea5c14194ba7ee7addbfa1fd6d3ce (patch)
tree8de7487a1b4299319eaf87c586684c0d2411d7ff
parent805674eed126f85cf4be2436da215b1d5abcb4f2 (diff)
downloadgstreamer-7932f62891eea5c14194ba7ee7addbfa1fd6d3ce.tar.gz
docs: expand a bit more on GST_DEBUG docs
-rw-r--r--docs/gst/running.xml10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/gst/running.xml b/docs/gst/running.xml
index b08b0a7902..db49f621bb 100644
--- a/docs/gst/running.xml
+++ b/docs/gst/running.xml
@@ -201,7 +201,12 @@ For example, setting <envar>GST_DEBUG</envar> to
<para>
To get all possible debug output, set
<envar>GST_DEBUG</envar>
-to <option>*:9</option>
+to <option>*:9</option>. For debugging purposes a <option>*:5</option> debug
+log is usually the most useful, as it contains all important information, but
+hides a lot of noise such as refs/unrefs. For bug reporting purposes, a
+<option>*:5</option> log is also what will be requested usually. It's often
+also worth running with <option>*:2</option> to see if there are any
+non-fatal errors or warnings that might be related to the problem at hand.
</para>
</formalpara>
@@ -298,7 +303,8 @@ The variable takes a comma-separated list of tracing options to enable.
Keep track of the unfreed memory pointers and dump an overview of all unfreed
memory at program exit. Together with a level 9 debug log this can be used to
follow the lifecycle of leaked objects in order to track down where they are
- leaked.
+ leaked. This can be useful for debugging memory leaks in situations where
+ tools such as valgrind are not available, or not an option.
</para>
</listitem>
</varlistentry>