Add a warning to the g_dbus_connection_set_exit_on_close docs

Tell people to not leak their apps out of the session.
This commit is contained in:
Matthias Clasen 2011-04-07 17:14:36 -04:00
parent 784619bc3a
commit a2e3a4d150

View 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