Attachment 131753 Details for Bug 101257 – [8/10] spec: Document the Features and Interfaces properties on o.fd.DBus

[patch] [8/10] spec: Document the Features and Interfaces properties on o.fd.DBus

0008-spec-Document-the-Features-and-Interfaces-properties.patch (text/plain), 5.83 KB, created by Simon McVittie on 2017-06-06 22:02:54 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2017-06-06 22:02:54 UTC

Size: 5.83 KB

patch

obsolete

>From af859e1648df9e87b998fb4a076f3f0e1f150c80 Mon Sep 17 00:00:00 2001
>From: Simon McVittie <smcv@collabora.com>
>Date: Fri, 2 Jun 2017 12:04:00 +0100
>Subject: [PATCH 08/10] spec: Document the Features and Interfaces properties
> on o.fd.DBus
>
>Signed-off-by: Simon McVittie <smcv@collabora.com>
>---
> doc/dbus-specification.xml | 116 +++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 116 insertions(+)
>
>diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
>index d575c663..7013e8bf 100644
>--- a/doc/dbus-specification.xml
>+++ b/doc/dbus-specification.xml
>@@ -6661,6 +6661,122 @@
> 
>     </sect2>
> 
>+    <sect2 id="message-bus-properties">
>+      <title>Message Bus Properties</title>
>+      <para>
>+        The special message bus name <literal>org.freedesktop.DBus</literal>
>+        exports several properties (see
>+        <xref linkend="standard-interfaces-properties"/>) on the object path
>+        <literal>/org/freedesktop/DBus</literal>.
>+      </para>
>+
>+      <sect3 id="message-bus-properties-features">
>+        <title><literal>org.freedesktop.DBus.Features</literal></title>
>+        <para>
>+          As a property:
>+          <programlisting>
>+            Read-only constant ARRAY of STRING Features
>+          </programlisting>
>+          This property lists abstract âfeaturesâ provided by the message
>+          bus, and can be used by clients to detect the capabilities
>+          of the message bus with which they are communicating.
>+          This property was added in version 1.11.x of the reference
>+          implementation of the message bus.
>+        </para>
>+
>+        <para>
>+          Items in the returned array not containing â.â are defined
>+          by this specification. Bus daemon implementors wishing to advertise
>+          features not mentioned in this document should either contribute
>+          patches to this specification, or use keys containing â.â and
>+          starting with their own reversed domain name, for example
>+          <literal>com.example.MyBus.SubliminalMessages</literal>.
>+        </para>
>+
>+        <para>
>+          The features currently defined in this specification are as follows:
>+          <variablelist>
>+
>+            <varlistentry>
>+              <term><literal>AppArmor</literal></term>
>+              <listitem>
>+                <para>
>+                  This message bus filters messages via the
>+                  <ulink url="http://wiki.apparmor.net/">AppArmor</ulink>
>+                  security framework. This feature should only be
>+                  advertised if AppArmor mediation is enabled and
>+                  active at runtime; merely compiling in support
>+                  for AppArmor should not result in this feature being
>+                  advertised on message bus instances where it is disabled by
>+                  message bus or operating system configuration.
>+                </para>
>+              </listitem>
>+            </varlistentry>
>+
>+            <varlistentry>
>+              <term><literal>SELinux</literal></term>
>+              <listitem>
>+                <para>
>+                  This message bus filters messages via the
>+                  <ulink url="https://selinuxproject.org/">SELinux</ulink>
>+                  security framework. Similar to <literal>apparmor</literal>,
>+                  this feature should only be advertised if SELinux mediation
>+                  is enabled and active at runtime (if SELinux is placed in
>+                  permissive mode, that is still considered to be active).
>+                </para>
>+              </listitem>
>+            </varlistentry>
>+
>+            <varlistentry>
>+              <term><literal>SystemdActivation</literal></term>
>+              <listitem>
>+                <para>
>+                  When asked to activate a service that has the
>+                  <literal>SystemdService</literal> field in its
>+                  <filename>.service</filename> file, this message bus will
>+                  carry out systemd activation (for details see
>+                  <xref linkend="message-bus-starting-services-systemd"/>).
>+                </para>
>+              </listitem>
>+            </varlistentry>
>+
>+          </variablelist>
>+        </para>
>+      </sect3>
>+
>+      <sect3 id="message-bus-properties-interfaces">
>+        <title><literal>org.freedesktop.DBus.Interfaces</literal></title>
>+        <para>
>+          As a property:
>+          <programlisting>
>+            Read-only constant ARRAY of STRING Interfaces
>+          </programlisting>
>+          This property lists interfaces provided by the
>+          <literal>/org/freedesktop/DBus</literal> object,
>+          and can be used by clients to detect the capabilities
>+          of the message bus with which they are communicating.
>+          Unlike the standard Introspectable interface, querying this
>+          property does not require parsing XML.
>+          This property was added in version 1.11.x of the reference
>+          implementation of the message bus.
>+        </para>
>+
>+        <para>
>+          The standard <literal>org.freedesktop.DBus</literal> and
>+          <literal>org.freedesktop.DBus.Properties</literal> interfaces
>+          are not included in the value of this property, because their
>+          presence can be inferred from the fact that a method call on
>+          <literal>org.freedesktop.DBus.Properties</literal> asking for
>+          properties of <literal>org.freedesktop.DBus</literal> was
>+          successful. The standard <literal>org.freedesktop.DBus.Peer</literal>
>+          and <literal>org.freedesktop.DBus.Introspectable</literal>
>+          interfaces are not included in the value of this property either,
>+          because they do not indicate features of the message bus
>+          implementation.
>+        </para>
>+      </sect3>
>+    </sect2>
>+
>   </sect1>
> <!--
>   <appendix id="implementation-notes">
>-- 
>2.11.0
>

Actions: View | Splinter Review

Attachments on bug 101257: 131617 | 131618 | 131619 | 131669 | 131670 | 131671 | 131672 | 131673 | 131674 | 131675 | 131676 | 131746 | 131747 | 131748 | 131749 | 131750 | 131751 | 131752 | 131753 | 131754 | 131755 | 131774 | 131775 | 131776 | 131781 | 131782

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.