Attachment 36331 Details for Bug 23130 – Clarify GetConnectionUnixUser documentation.

[patch] Clarify GetConnectionUnixUser documentation.

0003-Clarify-GetConnectionUnixUser-documentation.patch (text/plain), 2.04 KB, created by Will Thompson on 2010-06-17 07:10:38 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Will Thompson

Created: 2010-06-17 07:10:38 UTC

Size: 2.04 KB

patch

obsolete

>From a6bdf57799a498a9f3a16391de7e7c891e79e199 Mon Sep 17 00:00:00 2001
>From: Will Thompson <will.thompson@collabora.co.uk>
>Date: Thu, 17 Jun 2010 15:05:46 +0100
>Subject: [PATCH 3/3] Clarify GetConnectionUnixUser documentation.
>
>(This makes it match the freshly-documented GetConnectionUnixProcessID.)
>---
> doc/dbus-specification.xml |   14 ++++++++------
> 1 files changed, 8 insertions(+), 6 deletions(-)
>
>diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
>index 8f6b40e..0e3a178 100644
>--- a/doc/dbus-specification.xml
>+++ b/doc/dbus-specification.xml
>@@ -4172,7 +4172,7 @@
>         <para>
>           As a method:
>           <programlisting>
>-            UINT32 GetConnectionUnixUser (in STRING connection_name)
>+            UINT32 GetConnectionUnixUser (in STRING bus_name)
>           </programlisting>
>           Message arguments:
>           <informaltable>
>@@ -4188,7 +4188,9 @@
>                 <row>
>                   <entry>0</entry>
>                   <entry>STRING</entry>
>-                  <entry>Name of the connection to query</entry>
>+                  <entry>Unique or well-known bus name of the connection to
>+                    query, such as <literal>:12.34</literal> or
>+                    <literal>com.example.tea</literal></entry>
>                 </row>
>               </tbody>
>             </tgroup>
>@@ -4207,14 +4209,14 @@
>               <row>
>                 <entry>0</entry>
>                 <entry>UINT32</entry>
>-                <entry>unix user id</entry>
>+                <entry>Unix user ID</entry>
>               </row>
>             </tbody>
>           </tgroup>
>         </informaltable>
>-        Returns the unix uid of the process connected to the server. If unable to
>-	determine it, a <literal>org.freedesktop.DBus.Error.Failed</literal>
>-	error is returned.
>+        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.
>        </para>
>       </sect3>
> 
>-- 
>1.7.1
>

Actions: View | Splinter Review

Attachments on bug 23130: 28337 | 32554 | 32555 | 32556 | 36329 | 36330 | 36331

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.