diff options
| author | Javier Jardón <jjardon@gnome.org> | 2012-06-28 04:18:20 +0900 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.net> | 2012-06-28 14:34:03 +0100 |
| commit | 805674eed126f85cf4be2436da215b1d5abcb4f2 (patch) | |
| tree | feef4c65dc2afb51c79ebba885687f90e0864b59 | |
| parent | b348f1daad999c599d6aeac547ed2d5cfb81e04e (diff) | |
| download | gstreamer-805674eed126f85cf4be2436da215b1d5abcb4f2.tar.gz | |
docs/gst/running.xml: Add info about the GST_TRACE environment variable
https://bugzilla.gnome.org/show_bug.cgi?id=679008
| -rw-r--r-- | docs/gst/running.xml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/gst/running.xml b/docs/gst/running.xml index 4db812a826..b08b0a7902 100644 --- a/docs/gst/running.xml +++ b/docs/gst/running.xml @@ -270,6 +270,44 @@ plugins frequently, it will save time when doing gst_init(). </formalpara> +<formalpara id="GST_TRACE"> + <title><envar>GST_TRACE</envar></title> + + <para> + Enable memory allocation tracing. Most GStreamer objects have support for + tracing the number of unfreed objects and their memory pointers. + </para> + <para> +The variable takes a comma-separated list of tracing options to enable. + <variablelist> + + <varlistentry> + <term>live</term> + <listitem> +<para> + Counts all live objects and dumps an overview of the number of unfreed + objects at program exit. +</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>mem-live</term> + <listitem> +<para> + 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. +</para> + </listitem> + </varlistentry> + </variablelist> + + Use <option>all</option> to enable all tracing flags. + </para> +</formalpara> + <formalpara id="ORC_CODE"> <title><envar>ORC_CODE</envar></title> |