From: Simon McVittie <simon.mcvittie@collabora.co.uk>
Date: Tue, 17 May 2011 16:06:30 +0000 (+0100)
Subject: Describe conventional naming of errors
X-Git-Tag: dbus-1.5.10~55^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cd279fd3c57bf60da4436c0fdc15e33735207273;p=thirdparty%2Fdbus.git

Describe conventional naming of errors
---

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index 6d2b26a42..20b0d48a1 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -1304,6 +1304,17 @@
         <para>
           Error names have the same restrictions as interface names.
         </para>
+
+        <para>
+          Error names have the same naming conventions as interface
+          names, and often contain <literal>.Error.</literal>; for instance,
+          the owner of <literal>example.com</literal> might define the
+          errors <literal>com.example.MusicPlayer.Error.FileNotFound</literal>
+          and <literal>com.example.MusicPlayer.Error.OutOfMemory</literal>.
+          The errors defined by D-Bus itself, such as
+          <literal>org.freedesktop.DBus.Error.Failed</literal>, follow a
+          similar pattern.
+        </para>
       </sect3>
     </sect2>