gst/gstpad.h: Small addition to GST_FLOW_IS_FATAL() docs: mention that elements drivi...

Original commit message from CVS:
* gst/gstpad.h:
Small addition to GST_FLOW_IS_FATAL() docs: mention that elements
driving the pipeline may need to explicitly check for NOT_LINKED as
well, since IS_FATAL doesn't cover that.

diff --git a/ChangeLog b/ChangeLog
index 8d4f67d..4c581c8 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2007-07-22  Tim-Philipp Müller  <tim at centricular dot net>
 
+       * gst/gstpad.h:
+         Small addition to GST_FLOW_IS_FATAL() docs: mention that elements
+         driving the pipeline may need to explicitly check for NOT_LINKED as
+         well, since IS_FATAL doesn't cover that.
+
+2007-07-22  Tim-Philipp Müller  <tim at centricular dot net>
+
        * docs/pwg/advanced-types.xml:
          Fix typo and duplicate entry in video formats list.
 

diff --git a/gst/gstpad.h b/gst/gstpad.h
index af90ad6..1b919aa 100644 (file)
--- a/gst/gstpad.h
+++ b/gst/gstpad.h
@@ -138,8 +138,10 @@ typedef enum {
  * @ret: a #GstFlowReturn value
  *
  * Macro to test if the given #GstFlowReturn value indicates a fatal
- * error. This macro is mainly used in elements to decide when an error
- * message should be posted on the bus.
+ * error. This macro is mainly used in elements driving the pipeline to decide
+ * whether an error message should be posted on the bus. Note that such
+ * elements may also need to post an error message in the #GST_FLOW_NOT_LINKED
+ * case which is not caught by this macro.
  */
 #define GST_FLOW_IS_FATAL(ret) ((ret) <= GST_FLOW_UNEXPECTED)