From: Simon McVittie <simon.mcvittie@collabora.co.uk>
Date: Tue, 26 Apr 2011 15:06:58 +0000 (+0100)
Subject: Clarify that 'r' and 'e' cannot appear in signatures
X-Git-Tag: dbus-1.5.2~19
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f8ae29fd4e56d039ecd62284bf6883ea38dd5520;p=thirdparty%2Fdbus.git

Clarify that 'r' and 'e' cannot appear in signatures

Reviewed-by: Colin Walters <walters@verbum.org>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=34529
---

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index 8c6ddf062..324d8b973 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -478,7 +478,10 @@
               </row><row>
                 <entry><literal>STRUCT</literal></entry>
                 <entry>114 (ASCII 'r'), 40 (ASCII '('), 41 (ASCII ')')</entry>
-                <entry>Struct</entry>
+                <entry>Struct; type code 114 'r' is reserved for use in
+                  bindings and implementations to represent the general
+                  concept of a struct, and must not appear in signatures
+                  used on D-Bus.</entry>
               </row><row>
                 <entry><literal>VARIANT</literal></entry>
                 <entry>118 (ASCII 'v') </entry>
@@ -486,7 +489,11 @@
               </row><row>
                 <entry><literal>DICT_ENTRY</literal></entry>
                 <entry>101 (ASCII 'e'), 123 (ASCII '{'), 125 (ASCII '}') </entry>
-                <entry>Entry in a dict or map (array of key-value pairs)</entry>
+                <entry>Entry in a dict or map (array of key-value pairs).
+                  Type code 101 'e' is reserved for use in bindings and
+                  implementations to represent the general concept of a
+                  dict or dict-entry, and must not appear in signatures
+                  used on D-Bus.</entry>
               </row><row>
                 <entry><literal>UNIX_FD</literal></entry>
                 <entry>104 (ASCII 'h')</entry>