Attachment 126931 Details for Bug 37095 – spec: Recommend against using ‘/’ for object paths

[patch] spec: Recommend against using ‘/’ for object paths

0001-spec-Recommend-against-using-for-object-paths.patch (text/plain), 1.72 KB, created by Philip Withnall on 2016-10-01 11:27:20 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Philip Withnall

Created: 2016-10-01 11:27:20 UTC

Size: 1.72 KB

patch

obsolete

>From 9afcfb5cd8cf2ac7dbd0cf5c78ba74b1833a33bd Mon Sep 17 00:00:00 2001
>From: Philip Withnall <philip.withnall@collabora.co.uk>
>Date: Sat, 1 Oct 2016 13:22:30 +0200
>Subject: [PATCH] =?UTF-8?q?spec:=20Recommend=20against=20using=20=E2=80=98?=
> =?UTF-8?q?/=E2=80=99=20for=20object=20paths?=
>MIME-Version: 1.0
>Content-Type: text/plain; charset=UTF-8
>Content-Transfer-Encoding: 8bit
>
>As discussed in http://0pointer.de/blog/projects/versioning-dbus.html
>and in https://dbus.freedesktop.org/doc/dbus-api-design.html,
>un-versioned object paths make it hard to work out which interface a
>signal was emitted from.
>
>Clarify this in the specification to try and avoid people making this
>mistake.
>
>https://bugs.freedesktop.org/show_bug.cgi?id=37095
>---
> doc/dbus-specification.xml | 9 +++++++++
> 1 file changed, 9 insertions(+)
>
>diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
>index f57a498..b747c0b 100644
>--- a/doc/dbus-specification.xml
>+++ b/doc/dbus-specification.xml
>@@ -587,6 +587,15 @@
>         </para>
> 
>         <para>
>+          Using an object path of <literal>/</literal> is allowed, but
>+          recommended against, as it makes versioning of interfaces hard. Any
>+          signals emitted from a D-Bus object have the serviceâs unique bus name
>+          associated with them, rather than its well-known name. This means that
>+          receipients of the signals must rely entirely on the signal name and
>+          object path to work out which interface the signal originated from.
>+        </para>
>+
>+        <para>
>           For instance, if the owner of <literal>example.com</literal> is
>           developing a D-Bus API for a music player, they might use the
>           hierarchy of object paths that start with
>-- 
>2.7.4
>

Actions: View | Splinter Review

Attachments on bug 37095: 46820 | 46821 | 46822 | 46823 | 46824 | 46825 | 46826 | 46827 | 46828 | 126931

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.