]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man/org.freedesktop.systemd1.xml: Clarify the behavior of Subscribe()
authorMarco Trevisan (Treviño) <mail@3v1n0.net>
Mon, 17 Feb 2025 17:12:01 +0000 (18:12 +0100)
committerLuca Boccassi <luca.boccassi@gmail.com>
Tue, 18 Feb 2025 09:56:11 +0000 (09:56 +0000)
It was unclear that it was applied to standard signals too, and this
lead to unexpected behavior.

See: https://github.com/systemd/systemd/pull/36366

man/org.freedesktop.systemd1.xml

index 134241994740525868416d11defa0170e981895b..5e1c3e2c08eddbc57b877bef904c70b0ca95d8e4 100644 (file)
@@ -1434,7 +1434,12 @@ node /org/freedesktop/systemd1 {
 
       <para><function>Subscribe()</function> enables most bus signals to be sent out. Clients which are
       interested in signals need to call this method. Signals are only sent out if at least one client
-      invoked this method. <function>Unsubscribe()</function> reverts the signal subscription that
+      invoked this method. Note that this behavior is applied to all the signals that the object
+      in <constant>/org/freedesktop/systemd1</constant> may emit, including the
+      D-Bus standard <constant>org.freedesktop.DBus.Properties.PropertiesChanged</constant>
+      signal and others that do not belong to the <constant>org.freedesktop.systemd1</constant> interface.</para>
+
+      <para><function>Unsubscribe()</function> reverts the signal subscription that
       <function>Subscribe()</function> implements. It is not necessary to invoke
       <function>Unsubscribe()</function> as clients are tracked. Signals are no longer sent out as soon as
       all clients which previously asked for <function>Subscribe()</function> either closed their connection