2003-04-20 Havoc Pennington <hp@pobox.com>

	* doc/dbus-specification.sgml: document the restrictions on
	message and service names

diff --git a/ChangeLog b/ChangeLog
index 5d86d0ffa5527307f19f8c07df51865501e50ffc..7a9ee363ebebeeffe3db47d6c10c70a5eaf2e0a1 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2003-04-20  Havoc Pennington  <hp@pobox.com>
+
+       * doc/dbus-specification.sgml: document the restrictions on
+       message and service names
+
 2003-04-22  Havoc Pennington  <hp@redhat.com>
 
        * dbus/dbus-message.c, dbus/dbus-marshal.c: add 64-bit integer

diff --git a/doc/TODO b/doc/TODO
index 2cd7e44df266d4de1cb832dd7d5f5e6440af5f5f..9e7b750594dbe4fcad724425e5fc181f41d3f9c2 100644 (file)
--- a/doc/TODO
+++ b/doc/TODO
@@ -58,6 +58,3 @@
  - if you send a message to a service then block for reply, and the service exits/crashes
    after the message bus has processed your message but before the service has replied, 
    it would be nice if the message bus sent you an error reply.
-
- - We have a limit on the number of messages a connection can send, but 
-   not on how many can be buffered for a given connection.

diff --git a/doc/dbus-specification.sgml b/doc/dbus-specification.sgml
index eda6c00e8d32aa92295c0493e884357124fbc026..d510ca6a711a30a5f5c6e570f29d562c4199eb7c 100644 (file)
--- a/doc/dbus-specification.sgml
+++ b/doc/dbus-specification.sgml
@@ -436,6 +436,25 @@
         </informaltable>
       </para>
     </sect2>
+
+    <sect2 id="message-protocol-names">
+      <title>Valid names</title>
+      <para>
+        Messages and services have names with type STRING, meaning that 
+        they must be valid UTF-8. However, there are also some 
+        additional restrictions that apply to message and service names 
+        specifically:
+        <itemizedlist>
+         <listitem><para>They must contain at least one '.' (period) character</para></listitem>
+         <listitem><para>They must not begin with a '.' (period) character</para></listitem>
+         <listitem><para>They must not exceed 256 bytes in length</para></listitem>
+         <listitem><para>They must be at least 1 byte in length</para></listitem>
+        </itemizedlist>
+        As a special exception, base service names (those beginning with a colon (':') character)
+        need not contain a period.
+      </para>
+    </sect2>
+
   </sect1>
 
   <sect1 id="auth-protocol">