From 20301a882008dc849abec33d5d29d86441d86cae Mon Sep 17 00:00:00 2001
From: Thibault Saunier <tsaunier@igalia.com>
Date: Tue, 3 Sep 2019 17:14:49 -0400
Subject: [PATCH] docs: Document the new 'redirect-location' error message
 detail field

---
 gst/gstmessage.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/gst/gstmessage.h b/gst/gstmessage.h
index 69013e853d..3b321b919e 100644
--- a/gst/gstmessage.h
+++ b/gst/gstmessage.h
@@ -37,7 +37,9 @@ typedef struct _GstMessage GstMessage;
  * flushing seek in the pipeline, which will undo the EOS state again.
  * @GST_MESSAGE_ERROR: an error occurred. When the application receives an error
  * message it should stop playback of the pipeline and not assume that more
- * data will be played.
+ * data will be played. It is possible to specify a redirection url to the error
+ * messages by setting a `redirect-location` field into the error message, application
+ * or high level bins might use the information as required.
  * @GST_MESSAGE_WARNING: a warning occurred.
  * @GST_MESSAGE_INFO: an info message occurred
  * @GST_MESSAGE_TAG: a tag was found.