sysdeps: Document _dbus_daemon_unpublish_session_bus_address

Signed-off-by: Simon McVittie <smcv@collabora.com>

diff --git a/dbus/dbus-sysdeps-unix.c b/dbus/dbus-sysdeps-unix.c
index 94c2be306fdfeb53128b0d5871b63bc8aa250ad3..8743589fd621b2958f59978f0909079d55152513 100644 (file)
--- a/dbus/dbus-sysdeps-unix.c
+++ b/dbus/dbus-sysdeps-unix.c
@@ -4632,11 +4632,10 @@ _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
   return FALSE;
 }
 
-//PENDING(kdab) docs
+/* Documented in dbus-sysdeps-win.c, does nothing on Unix */
 void
 _dbus_daemon_unpublish_session_bus_address (void)
 {
-
 }
 
 /**

diff --git a/dbus/dbus-sysdeps-win.c b/dbus/dbus-sysdeps-win.c
index 950d900a3384ed2de02fdb49f2a4da14d72f17ef..43350cc779674be72e995be49b454d1525b8ae37 100644 (file)
--- a/dbus/dbus-sysdeps-win.c
+++ b/dbus/dbus-sysdeps-win.c
@@ -3127,6 +3127,22 @@ _dbus_daemon_publish_session_bus_address (const char* address, const char *scope
   return TRUE;
 }
 
+/**
+ * Clear the platform-specific centralized location where the session
+ * bus address is published.
+ *
+ * This must only be called if \ref DBusServer.published_address is #TRUE,
+ * which is be the case if and only if platform-specific code has published
+ * the address centrally.
+ *
+ * On Windows, this is implemented by closing a global shared memory segment.
+ *
+ * On Unix, the session bus address is not published in a centralized
+ * location by libdbus, so this function does nothing. The closest
+ * equivalent on Unix is that the session bus address is published by the
+ * dbus-launch tool, and unpublished automatically when the dbus-launch
+ * tool exits.
+ */
 void
 _dbus_daemon_unpublish_session_bus_address (void)
 {