Attachment 46822 Details for Bug 37095 – [PATCH 3/9] Describe best-practices for naming well-known bus names

[patch] [PATCH 3/9] Describe best-practices for naming well-known bus names

0003-Describe-best-practices-for-naming-well-known-bus-na.patch (text/plain), 2.14 KB, created by Simon McVittie on 2011-05-17 09:12:19 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2011-05-17 09:12:19 UTC

Size: 2.14 KB

patch

obsolete

>From 6213a3d8977c668a9a3dd2aaca211649ead60998 Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Tue, 17 May 2011 17:06:06 +0100
>Subject: [PATCH 3/9] Describe best-practices for naming well-known bus names
>
>---
> doc/dbus-specification.xml |   25 +++++++++++++++++++++++++
> 1 files changed, 25 insertions(+), 0 deletions(-)
>
>diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
>index 18caac1..4045513 100644
>--- a/doc/dbus-specification.xml
>+++ b/doc/dbus-specification.xml
>@@ -1251,6 +1251,31 @@
>           Note that the hyphen ('-') character is allowed in bus names but
>           not in interface names.
>         </para>
>+
>+        <para>
>+          Like <link linkend="message-protocol-names-interface">interface
>+            names</link>, well-known bus names should start with the
>+          reversed DNS domain name of the author of the interface (in
>+          lower-case), and it is conventional for the rest of the well-known
>+          bus name to consist of words run together, with initial
>+          capital letters. As with interface names, including a version
>+          number in well-known bus names is a good idea; it's possible to
>+          have the well-known bus name for more than one version
>+          simultaneously if backwards compatibility is required.
>+        </para>
>+
>+        <para>
>+          If a well-known bus name implies the presence of a "main" interface,
>+          that "main" interface is often given the same name as
>+          the well-known bus name, and situated at the corresponding object
>+          path. For instance, if the owner of <literal>example.com</literal>
>+          is developing a D-Bus API for a music player, they might define
>+          that any application that takes the well-known name
>+          <literal>com.example.MusicPlayer1</literal> should have an object
>+          at the object path <literal>/com/example/MusicPlayer1</literal>
>+          which implements the interface
>+          <literal>com.example.MusicPlayer1</literal>.
>+        </para>
>       </sect3>
>       <sect3 id="message-protocol-names-member">
>         <title>Member names</title>
>-- 
>1.7.5.1
>

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.