GSettings: fix check for delaying backend subscription

[platform/upstream/glib.git] / gio / gcancellable.c

diff --git a/gio/gcancellable.c b/gio/gcancellable.c
index fcfca3f..258b88d 100644 (file)
--- a/gio/gcancellable.c
+++ b/gio/gcancellable.c
@@ -244,6 +244,13 @@ g_cancellable_get_current  (void)
  *
  * If cancellable is currently in use by any cancellable operation
  * then the behavior of this function is undefined.
+ *
+ * Note that it is generally not a good idea to reuse an existing
+ * cancellable for more operations after it has been cancelled once,
+ * as this function might tempt you to do. The recommended practice
+ * is to drop the reference to a cancellable after cancelling it,
+ * and let it die with the outstanding async operations. You should
+ * create a fresh cancellable for further async operations.
  **/
 void 
 g_cancellable_reset (GCancellable *cancellable)
@@ -715,6 +722,8 @@ static GSourceFuncs cancellable_source_funcs =
  * For convenience, you can call this with a %NULL #GCancellable,
  * in which case the source will never trigger.
  *
+ * The new #GSource will hold a reference to the #GCancellable.
+ *
  * Returns: (transfer full): the new #GSource.
  *
  * Since: 2.28