]> git.ipfire.org Git - thirdparty/dbus.git/commitdiff
Describe conventional naming of errors
authorSimon McVittie <simon.mcvittie@collabora.co.uk>
Tue, 17 May 2011 16:06:30 +0000 (17:06 +0100)
committerSimon McVittie <simon.mcvittie@collabora.co.uk>
Tue, 17 May 2011 16:06:30 +0000 (17:06 +0100)
doc/dbus-specification.xml

index 6d2b26a4251302862b87584c1e69d6096f2751f5..20b0d48a15bcce51c4ecfbdf608fbf891dfe9eca 100644 (file)
         <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>