Clarify GetConnectionUnixUser documentation.
authorWill Thompson <will.thompson@collabora.co.uk>
Thu, 17 Jun 2010 14:05:46 +0000 (15:05 +0100)
committerWill Thompson <will.thompson@collabora.co.uk>
Thu, 17 Jun 2010 14:27:08 +0000 (15:27 +0100)
(This makes it match the freshly-documented GetConnectionUnixProcessID.)

doc/dbus-specification.xml

index 8f6b40e..0e3a178 100644 (file)
         <para>
           As a method:
           <programlisting>
-            UINT32 GetConnectionUnixUser (in STRING connection_name)
+            UINT32 GetConnectionUnixUser (in STRING bus_name)
           </programlisting>
           Message arguments:
           <informaltable>
                 <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>
               <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>