Add a warning to the g_dbus_connection_set_exit_on_close docs
authorMatthias Clasen <mclasen@redhat.com>
Thu, 7 Apr 2011 21:14:36 +0000 (17:14 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 7 Apr 2011 21:15:41 +0000 (17:15 -0400)
Tell people to not leak their apps out of the session.

gio/gdbusconnection.c

index 4227bda..a10bf4d 100644 (file)
@@ -2712,12 +2712,19 @@ g_dbus_connection_new_for_address_sync (const gchar           *address,
  * g_dbus_connection_set_exit_on_close:
  * @connection: A #GDBusConnection.
  * @exit_on_close: Whether the process should be terminated
- * when @connection is closed by the remote peer.
+ *     when @connection is closed by the remote peer.
  *
  * Sets whether the process should be terminated when @connection is
  * closed by the remote peer. See #GDBusConnection:exit-on-close for
  * more details.
  *
+ * Note that this function should be used with care. Most modern UNIX
+ * desktops tie the notion of a user session the session bus, and expect
+ * all of a users applications to quit when their bus connection goes away.
+ * If you are setting @exit_on_close to %FALSE for the shared session
+ * bus connection, you should make sure that your application exits
+ * when the user session ends.
+ *
  * Since: 2.26
  */
 void