]> git.ipfire.org Git - thirdparty/dbus.git/commitdiff
spec: Document the o.fd.DBus.Verbose interface
authorSimon McVittie <smcv@collabora.com>
Wed, 25 Sep 2024 17:00:09 +0000 (18:00 +0100)
committerSimon McVittie <smcv@collabora.com>
Tue, 1 Oct 2024 14:41:06 +0000 (14:41 +0000)
Like Debug.Stats, this was implemented but never documented. Do so now.

Signed-off-by: Simon McVittie <smcv@collabora.com>
doc/dbus-specification.xml

index a494cdf0df8fa7f21621e6a9187ed0d48b358ca2..f278c1e485d91e602f23d3e4e23c67474d59c0ef 100644 (file)
 
     </sect2>
 
+    <sect2 id="message-bus-verbose-interface">
+      <title>Verbose Interface: <literal>org.freedesktop.DBus.Verbose</literal></title>
+      <para>
+        The special message bus name <literal>org.freedesktop.DBus</literal>
+        may optionally implement the
+        <literal>org.freedesktop.DBus.Verbose</literal> interface on
+        the object path <literal>/org/freedesktop/DBus</literal>.
+        In the reference implementation, this interface is an optional
+        feature, which can be enabled or disabled at compile-time.
+        On the well-known system bus or other buses that serve more than
+        one user, access to this interface should normally be restricted to
+        administrative users, but can be opened up to developers via
+        configuration if required.
+      </para>
+
+      <sect3 id="bus-messages-enable-verbose">
+        <title>Method: <literal>org.freedesktop.DBus.Verbose.EnableVerbose</literal></title>
+        <para>
+          As a method:
+          <programlisting>
+            EnableVerbose ()
+          </programlisting>
+          Start producing verbose debugging messages in an
+          implementation-specific way.
+          For example, these messages might go to standard error or to a
+          system event log.
+       </para>
+      </sect3>
+
+      <sect3 id="bus-messages-disable-verbose">
+        <title>Method: <literal>org.freedesktop.DBus.Verbose.DisableVerbose</literal></title>
+        <para>
+          As a method:
+          <programlisting>
+            DisableVerbose ()
+          </programlisting>
+          Stop producing verbose debugging messages.
+       </para>
+      </sect3>
+
+    </sect2>
   </sect1>
 <!--
   <appendix id="implementation-notes">