summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2014-09-24 14:06:02 +0100
committerPhilip Withnall <philip.withnall@collabora.co.uk>2014-10-27 09:43:55 +0000
commit203fe3b8a8817da8e1ec771e2ebd15c747653158 (patch)
tree481f050bf53598c39a9cc5701e8b3f1d6ba58b86
parent92d67358986c3be48ccbd4135b53ea591f15ea86 (diff)
downloadglib-203fe3b8a8817da8e1ec771e2ebd15c747653158.tar.gz
gcancellable: Clarify that GSources hold references to GCancellables
Clarify in the documentation that a GSource created with g_cancellable_source_new() must be explicitly removed from its GMainContext before the GCancellable can be finalised. This could be a common way of leaking GCancellables. https://bugzilla.gnome.org/show_bug.cgi?id=737259
-rw-r--r--gio/gcancellable.c2
1 files changed, 2 insertions, 0 deletions
diff --git a/gio/gcancellable.c b/gio/gcancellable.c
index 800e8f312..258b88da5 100644
--- a/gio/gcancellable.c
+++ b/gio/gcancellable.c
@@ -722,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