Attachment 131048 Details for Bug 100795 – document error codes specific to each call

[patch] document error codes specific to each call

0002-docs-document-the-drivers-error-codes.patch (text/plain), 15.45 KB, created by Tom Gundersen on 2017-04-26 09:49:51 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Tom Gundersen

Created: 2017-04-26 09:49:51 UTC

Size: 15.45 KB

patch

obsolete

>From ac7762f22853dec7233af0c4669d006633b25c79 Mon Sep 17 00:00:00 2001
>From: Tom Gundersen <teg@jklm.no>
>Date: Sun, 23 Apr 2017 17:05:16 +0200
>Subject: [PATCH 2/3] docs: document the drivers error codes
>
>Document the possible error code during normal operations. Error codes due to
>internal errors or configuration errors are not documented and are not really
>meant for the client to know what to do with.
>
>Signed-off-by: Tom Gundersen <teg@jklm.no>
>---
> doc/dbus-specification.xml | 314 ++++++++++++++++++++++++++++++++++++++++++++-
> 1 file changed, 307 insertions(+), 7 deletions(-)
>
>diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
>index 7759de36..f730f580 100644
>--- a/doc/dbus-specification.xml
>+++ b/doc/dbus-specification.xml
>@@ -5247,6 +5247,27 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.LimitsExceeded</entry>
>+                  <entry>The maximum number of active connections have been exceeded</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.Failed</entry>
>+                  <entry>The client is already registered on the bus</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         </para>
>         <para>
>           Before an application is able to send messages to other applications
>@@ -5313,6 +5334,31 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.InvalidArgs</entry>
>+                  <entry>The requested name is reserved or not a valid well-known name</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.AccessDenied</entry>
>+                  <entry>Application is not allowed to own name</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.LimitsExceeded</entry>
>+                  <entry>The maximum number of names have been exceeded</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         </para>
>         <para>
>           Ask the message bus to assign the given name to the method caller. Each
>@@ -5546,6 +5592,23 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.InvalidArgs</entry>
>+                  <entry>The name is reserved or not a valid well-known name</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         </para>
>         <para>
>           Ask the message bus to release the method caller's claim to the given
>@@ -5641,6 +5704,23 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.NameHasNoOwner</entry>
>+                  <entry>The name does not exist</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         </para>
>         <para>
>           List the connections currently queued for a bus name (see
>@@ -5919,6 +5999,31 @@
>             </tbody>
>           </tgroup>
>         </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.LimitsExceeded</entry>
>+                  <entry>The maximum number of pending activations has been exceeded</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.ServiceUnknown</entry>
>+                  <entry>The name is not activatable</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.AccessDenied</entry>
>+                  <entry>The caller does not have permission to activate the service</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         Tries to launch the executable associated with a name (service
>         activation), as an explicit request. This is an alternative to
>         relying on auto-starting. For more information on how services
>@@ -5996,6 +6101,23 @@
>               </tbody>
>             </tgroup>
>             </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.AccessDenied</entry>
>+                  <entry>Invalid object path, or the caller does not have permission to alter the activation environemnt</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>             Normally, session bus activated services inherit the environment of the bus daemon.  This method adds to or modifies that environment when activating services.
>         </para>
>         <para>
>@@ -6052,9 +6174,25 @@
>             </tbody>
>           </tgroup>
>         </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.NameHasNoOwner</entry>
>+                  <entry>The name has no owner</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         Returns the unique connection name of the primary owner of the name
>-        given. If the requested name doesn't have an owner, returns a
>-        <literal>org.freedesktop.DBus.Error.NameHasNoOwner</literal> error.
>+        given.
>        </para>
>       </sect3>
> 
>@@ -6105,6 +6243,23 @@
>             </tbody>
>           </tgroup>
>         </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.NameHasNoOwner</entry>
>+                  <entry>The name does not exist</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         Returns the Unix user ID of the process connected to the server. If
>         unable to determine it (for instance, because the process is not on the
>         same machine as the bus daemon), an error is returned.
>@@ -6158,9 +6313,30 @@
>             </tbody>
>           </tgroup>
>         </informaltable>
>-        Returns the Unix process ID of the process connected to the server. If
>-        unable to determine it (for instance, because the process is not on the
>-        same machine as the bus daemon), an error is returned.
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.NameHasNoOwner</entry>
>+                  <entry>The name does not exist</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.UnixProcessIdUnknown</entry>
>+                  <entry>The process ID could not be determined (for instance,
>+                         because the process is not on the same machine as the
>+                         bus daemon).</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>+        Returns the Unix process ID of the process connected to the server.
>        </para>
>       </sect3>
> 
>@@ -6211,6 +6387,23 @@
>             </tbody>
>           </tgroup>
>         </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.NameHasNoOwner</entry>
>+                  <entry>The name does not exist</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>       </para>
> 
>       <para>
>@@ -6373,6 +6566,27 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.NameHasNoOwner</entry>
>+                  <entry>The name does not exist</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.AdtAuditDataUnknown</entry>
>+                  <entry>Could not determine audit session data</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>           Returns auditing data used by Solaris ADT, in an unspecified
>           binary format. If you know what this means, please contribute
>           documentation via the D-Bus bug tracking system.
>@@ -6431,6 +6645,27 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.NameHasNoOwner</entry>
>+                  <entry>The name does not exist</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown</entry>
>+                  <entry>Could not determine security context</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>           Returns the security context used by SELinux, in an unspecified
>           format. If you know what this means, please contribute
>           documentation via the D-Bus bug tracking system.
>@@ -6468,6 +6703,31 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.LimitsExceeded</entry>
>+                  <entry>The maximum number of match rules have been exceeded</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.MatchRuleInvalid</entry>
>+                  <entry>The match rule string is invalid</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.AccessDenied</entry>
>+                  <entry>The caller does not have permission to eavesdrop</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         Adds a match rule to match messages going through the message bus (see <xref linkend='message-bus-routing-match-rules'/>).
>         If the bus does not have enough resources the <literal>org.freedesktop.DBus.Error.OOM</literal>
>         error is returned.
>@@ -6499,9 +6759,28 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.MatchRuleInvalid</entry>
>+                  <entry>The match rule string is invalid</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.MatchRuleNotFound</entry>
>+                  <entry>The match rule was not found</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         Removes the first rule that matches (see <xref linkend='message-bus-routing-match-rules'/>).
>-        If the rule is not found the <literal>org.freedesktop.DBus.Error.MatchRuleNotFound</literal>
>-        error is returned.
>        </para>
>       </sect3>
> 
>@@ -6572,6 +6851,27 @@
>               </tbody>
>             </tgroup>
>           </informaltable>
>+          Error codes:
>+          <informaltable>
>+            <tgroup cols="2">
>+              <thead>
>+                <row>
>+                  <entry>Error</entry>
>+                  <entry>Description</entry>
>+                </row>
>+              </thead>
>+              <tbody>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.AccessDenied</entry>
>+                  <entry>Invalid object path, or the caller does not have the permission to eavesdrop</entry>
>+                </row>
>+                <row>
>+                  <entry>org.freedesktop.DBus.Error.MatchRuleInvalid</entry>
>+                  <entry>Invalid match rule</entry>
>+                </row>
>+              </tbody>
>+            </tgroup>
>+          </informaltable>
>         </para>
> 
>         <para>
>-- 
>2.12.2
>

Actions: View | Splinter Review

Attachments on bug 100795: 131047 | 131048 | 131049 | 131166 | 131167

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.