From 6213a3d8977c668a9a3dd2aaca211649ead60998 Mon Sep 17 00:00:00 2001 From: Simon McVittie 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. + + + Like interface + names, 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. + + + + 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 example.com + is developing a D-Bus API for a music player, they might define + that any application that takes the well-known name + com.example.MusicPlayer1 should have an object + at the object path /com/example/MusicPlayer1 + which implements the interface + com.example.MusicPlayer1. + Member names -- 1.7.5.1