debugutils: Update configure option in documentation
authorFrancisco Velazquez <francisv@ifi.uio.no>
Fri, 4 May 2018 12:00:21 +0000 (14:00 +0200)
committerVivia Nikolaidou <vivia@ahiru.eu>
Fri, 4 May 2018 12:25:24 +0000 (15:25 +0300)
Update documentation on non existent option `gst-enable-gst-debug'.  Instead,
one has to make sure that the `--disable-gst-debug' option was not used when
compiling GStreamer (i.e., `./configure --disable-gst-debug').

https://bugzilla.gnome.org/show_bug.cgi?id=795801

gst/gstdebugutils.h

index 8017fc5..e0d6025 100644 (file)
@@ -85,9 +85,9 @@ void gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails detail
  * There is also a utility called xdot which allows you to view the dot file
  * directly without converting it first.
  *
- * The macro is only active if gstreamer is configured with
- * &quot;--gst-enable-gst-debug&quot; and the environment variable
- * GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).
+ * The macro is only active if the environment variable GST_DEBUG_DUMP_DOT_DIR
+ * is set to a basepath (e.g. /tmp), and the GStreamer debugging subsystem is
+ * enabled (i.e., no use of `./configure --disable-gst-debug')
  */
 #define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) gst_debug_bin_to_dot_file (bin, details, file_name)