GDBusConnection: note that exit-on-close is sometimes TRUE

g_bus_get_finish() and g_bus_get_sync() both document that the returned
object will usually have exit-on-close set to TRUE, but the property's
documentation specified that its default is FALSE. While that's
technically true from a GObject perspective, it's not accurate from the
API user's perspective.

https://bugzilla.gnome.org/show_bug.cgi?id=668163

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: David Zeuthen <zeuthen@gmail.com>

diff --git a/gio/gdbusconnection.c b/gio/gdbusconnection.c
index 849d287..46ff89f 100644 (file)
--- a/gio/gdbusconnection.c
+++ b/gio/gdbusconnection.c
@@ -956,6 +956,9 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
    * calling <literal>raise(SIGTERM)</literal>) if the connection
    * is closed by the remote peer.
    *
+   * Note that #GDBusConnection objects returned by g_bus_get_finish() and
+   * g_bus_get_sync() will (usually) have this property set to %TRUE.
+   *
    * Since: 2.26
    */
   g_object_class_install_property (gobject_class,