diff options
| author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2011-05-17 17:06:30 +0100 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2011-05-17 17:06:30 +0100 |
| commit | cd279fd3c57bf60da4436c0fdc15e33735207273 (patch) | |
| tree | 2091bfd89dee348bb0fe6fd0127fbd344106733a /doc | |
| parent | 977c7a7c4a01ba3fad919d20404865144417d9f6 (diff) | |
| download | dbus-cd279fd3c57bf60da4436c0fdc15e33735207273.tar.gz | |
Describe conventional naming of errors
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dbus-specification.xml | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml index 6d2b26a4..20b0d48a 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> |