Attachment 46827 Details for Bug 37095 – [PATCH 8/9] Describe best practices for property names, and recommend against dash-separated-words

[patch] [PATCH 8/9] Describe best practices for property names, and recommend against dash-separated-words

0008-Describe-best-practices-for-property-names-and-recom.patch (text/plain), 1.85 KB, created by Simon McVittie on 2011-05-17 09:13:46 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2011-05-17 09:13:46 UTC

Size: 1.85 KB

patch

obsolete

>From 1909039b191f0ac1c1fa2aeb9b9053b921471f1b Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Tue, 17 May 2011 17:10:36 +0100
>Subject: [PATCH 8/9] Describe best practices for property names, and
> recommend against dash-separated-words
>
>Related to <https://bugs.freedesktop.org/show_bug.cgi?id=20948> whose
>conclusion seemed to be that anything is allowed, but CamelCase is
>considerably more interoperable.
>---
> doc/dbus-specification.xml |   16 ++++++++++++++++
> 1 files changed, 16 insertions(+), 0 deletions(-)
>
>diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
>index 86e2b9b..88360af 100644
>--- a/doc/dbus-specification.xml
>+++ b/doc/dbus-specification.xml
>@@ -3067,6 +3067,22 @@
>         </programlisting>
>       </para>
>       <para>
>+        It is conventional to give D-Bus properties names consisting of
>+        capitalized words without punctuation ("CamelCase"), like
>+        <link linkend="message-protocol-names-member">member names</link>.
>+        For instance, the GObject property
>+        <literal>connection-status</literal> or the Qt property
>+        <literal>connectionStatus</literal> could be represented on D-Bus
>+        as <literal>ConnectionStatus</literal>.
>+      </para>
>+      <para>
>+        Strictly speaking, D-Bus property names are not required to follow
>+        the same naming restrictions as member names, but D-Bus property
>+        names that would not be valid member names (in particular,
>+        GObject-style dash-separated property names) can cause interoperability
>+        problems and should be avoided.
>+      </para>
>+      <para>
>         The available properties and whether they are writable can be determined
>         by calling <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>,
>         see <xref linkend="standard-interfaces-introspectable"/>.
>-- 
>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.