From: Will Thompson <will.thompson@collabora.co.uk>
Date: Thu, 17 Jun 2010 14:05:46 +0000 (+0100)
Subject: Clarify GetConnectionUnixUser documentation.
X-Git-Tag: dbus-1.3.1~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1861c9fdd0cbe2be0351e9bdc5b199ff300a0844;p=thirdparty%2Fdbus.git

Clarify GetConnectionUnixUser documentation.

(This makes it match the freshly-documented GetConnectionUnixProcessID.)
---

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index 8f6b40e9e..0e3a17834 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>