From: Ryan Lortie <desrt@desrt.ca>
Date: Thu, 12 Nov 2009 04:48:06 +0000 (-0500)
Subject: Bug 587300 - g_cancellable_disconnect deadlock
X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=6b7b7a76020e76370e416d794eceb99937b9ed33;p=dana%2Fcg-glib.git

Bug 587300 - g_cancellable_disconnect deadlock

add documentation to clarify that a deadlock is the expected case for
calling this function from a signal handler
---

diff --git a/gio/gcancellable.c b/gio/gcancellable.c
index 36973ad9..5f80022a 100644
--- a/gio/gcancellable.c
+++ b/gio/gcancellable.c
@@ -707,9 +707,12 @@ g_cancellable_connect (GCancellable   *cancellable,
  * @cancellable: A #GCancellable or %NULL.
  * @handler_id: Handler id of the handler to be disconnected, or %0.
  *
- * Disconnects a handler from an cancellable instance similar to
- * g_signal_handler_disconnect() but ensures that once this
- * function returns the handler will not run anymore in any thread.
+ * Disconnects a handler from a cancellable instance similar to
+ * g_signal_handler_disconnect().  Additionally, in the event that a
+ * signal handler is currently running, this call will block until the
+ * handler has finished.  Calling this function from a
+ * #GCancellable::cancelled signal handler will therefore result in a
+ * deadlock.
  *
  * This avoids a race condition where a thread cancels at the
  * same time as the cancellable operation is finished and the