gstinfo: Add an explicit enum for GST_STACK_TRACE_SHOW_NONE
authorNirbheek Chauhan <nirbheek@centricular.com>
Tue, 18 Jun 2019 21:49:16 +0000 (03:19 +0530)
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>
Mon, 1 Jul 2019 10:36:09 +0000 (10:36 +0000)
The code implicitly uses this value when the stack trace is not FULL.
Mostly useful for documenting the behaviour when each flag is passed
and for translating to/from strings.

gst/gstinfo.c
gst/gstinfo.h
plugins/tracers/gstleaks.c

index 63f9fca..fffa839 100644 (file)
@@ -2885,8 +2885,8 @@ done:
 
 /**
  * gst_debug_get_stack_trace:
- * @flags: A set of #GstStackTraceFlags to determine how the stack
- * trace should look like. Pass 0 to retrieve a minimal backtrace.
+ * @flags: A set of #GstStackTraceFlags to determine how the stack trace should
+ * look like. Pass #GST_STACK_TRACE_SHOW_NONE to retrieve a minimal backtrace.
  *
  * Returns: (nullable): a stack trace, if libunwind or glibc backtrace are
  * present, else %NULL.
index ceaa70e..257564a 100644 (file)
@@ -177,12 +177,17 @@ typedef enum { /*< flags >*/
 
 /**
  * GstStackTraceFlags:
- * @GST_STACK_TRACE_SHOW_FULL: Try to retrieve as much information as
- *                             possible when getting the stack trace
+ * @GST_STACK_TRACE_SHOW_NONE: Try to retrieve the minimum information
+ *                             available, which may be none on some platforms
+ *                             (Since: 1.18)
+ * @GST_STACK_TRACE_SHOW_FULL: Try to retrieve as much information as possible,
+ *                             including source information when getting the
+ *                             stack trace
  *
  * Since: 1.12
  */
 typedef enum {
+    GST_STACK_TRACE_SHOW_NONE = 0,
     GST_STACK_TRACE_SHOW_FULL = 1 << 0
 } GstStackTraceFlags;
 
index 22a005a..80e44aa 100644 (file)
@@ -106,7 +106,7 @@ set_print_stack_trace_from_string (GstLeaksTracer * self, const gchar * str)
   if (g_strcmp0 (str, "full") == 0)
     self->trace_flags = GST_STACK_TRACE_SHOW_FULL;
   else
-    self->trace_flags = 0;
+    self->trace_flags = GST_STACK_TRACE_SHOW_NONE;
 }
 
 static void