summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMirsal Ennaime <mirsal@mirsal.fr>2012-04-15 17:56:57 +0200
committerMirsal Ennaime <mirsal@mirsal.fr>2012-04-15 18:43:02 +0200
commit3ae46831adb734a265b3f38b9df01b41e01f4318 (patch)
tree7d11cff6ca6b126e4bb080cc3dc33d03ab93b8db
parent2f260c7f5854f0bd0b3669ca7562cf983cae5ca7 (diff)
Fix the unique instance identifier example
The current recommendation to use a unix pid as a unique instance identifier and the bus name given as an example are misleading as they suggest that it begins with a digit, which violates the D-Bus specification. * Rephrase the suggestion to use a unix pid * Change the example so it complies with the D-Bus spec * Add a note quoting the relevant part of the D-Bus spec
-rw-r--r--spec/all.xml19
1 files changed, 16 insertions, 3 deletions
diff --git a/spec/all.xml b/spec/all.xml
index 9878b68..8549de4 100644
--- a/spec/all.xml
+++ b/spec/all.xml
@@ -68,6 +68,10 @@
"no track" where required in the <b>org.mpris.MediaPlayer2.TrackList</b>
interface (since empty paths are not allowed by D-Bus).
</li>
+ <li>
+ The suggested unique instance identifier no longer violates the D-Bus
+ specification by begining with a digit.
+ </li>
</ul>
</dd>
<dt>From 2.0 to 2.1:</dt>
@@ -117,13 +121,22 @@
<p>
In the case where the media player allows multiple instances running
simultaneously, each additional instance should request a unique bus
- name, adding a dot and a unique identifier (such as a UNIX process
- id) to its usual bus name. For example, this could be
+ name, adding a dot and a unique identifier to its usual bus name, such
+ as one based on a UNIX process id.
+
+ For example, this could be:
</p>
<ul>
- <li>org.mpris.MediaPlayer2.vlc.7389</li>
+ <li>org.mpris.MediaPlayer2.vlc.instance7389</li>
</ul>
+
+ <p>
+ Note: According to the <a href="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus">
+ D-Bus specification</a>, the unique identifier "must only contain the
+ ASCII characters '[A-Z][a-z][0-9]_-'" and "must not begin with a digit".
+ </p>
+
</tp:docstring>
</tp:section>