Clarify g_propagate_error docs
authorMatthias Clasen <mclasen@redhat.com>
Fri, 10 Oct 2014 18:17:56 +0000 (14:17 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Fri, 10 Oct 2014 18:17:56 +0000 (14:17 -0400)
I just ran into a bug that was caused by having src being a
persistent GError* that was not cleared after propagating it.

glib/gerror.c

index db31692..4eed58e 100644 (file)
@@ -604,6 +604,10 @@ g_set_error_literal (GError      **err,
  *
  * If @dest is %NULL, free @src; otherwise, moves @src into *@dest.
  * The error variable @dest points to must be %NULL.
+ *
+ * Note that @src is no longer valid after this call. If you want
+ * to keep using the same GError*, you need to set it to %NULL
+ * after calling this function on it.
  */
 void
 g_propagate_error (GError **dest,