Bug 23130 - Document GetConnectionUnixProcessID and ListQueuedOwners in the spec
Summary: Document GetConnectionUnixProcessID and ListQueuedOwners in the spec
Status: RESOLVED FIXED
Alias: None
Product: dbus
Classification: Unclassified
Component: core (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: Havoc Pennington
QA Contact: John (J5) Palmieri
URL: http://git.collabora.co.uk/?p=user/wj...
Whiteboard:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2009-08-04 03:32 UTC by Will Thompson
Modified: 2010-06-17 07:35 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments
Document GetConnectionUnixProcessID in the spec (2.37 KB, patch)
2009-08-04 03:32 UTC, Will Thompson
Details | Splinter Review
Document GetConnectionUnixProcessID in the spec (2.37 KB, patch)
2010-01-10 04:02 UTC, Will Thompson
Details | Splinter Review
Fix a broken <xref/> (945 bytes, patch)
2010-01-10 04:03 UTC, Will Thompson
Details | Splinter Review
Document ListQueuedOwners in the spec (2.42 KB, patch)
2010-01-10 04:04 UTC, Will Thompson
Details | Splinter Review
Document GetConnectionUnixProcessID in the spec (2.53 KB, patch)
2010-06-17 07:09 UTC, Will Thompson
Details | Splinter Review
Document ListQueuedOwners in the spec (2.55 KB, patch)
2010-06-17 07:09 UTC, Will Thompson
Details | Splinter Review
Clarify GetConnectionUnixUser documentation. (2.04 KB, patch)
2010-06-17 07:10 UTC, Will Thompson
Details | Splinter Review

Description Will Thompson 2009-08-04 03:32:57 UTC
Created attachment 28337 [details] [review]
Document GetConnectionUnixProcessID in the spec

GetConnectionUnixProcessID isn't mentioned in the D-Bus specification (although GetConnectionUnixUser is). The attached patch adds it.
Comment 1 Will Thompson 2010-01-10 04:02:43 UTC
Created attachment 32554 [details] [review]
Document GetConnectionUnixProcessID in the spec
Comment 2 Will Thompson 2010-01-10 04:03:33 UTC
Created attachment 32555 [details] [review]
Fix a broken <xref/>
Comment 3 Will Thompson 2010-01-10 04:04:29 UTC
Created attachment 32556 [details] [review]
Document ListQueuedOwners in the spec
Comment 4 Will Thompson 2010-01-10 04:07:29 UTC
Matthew told me about ListQueuedOwners today. Hey, there's a method that makes queueing useful! So let's document it too.

Patches attached; also viewable in gitweb at the attached URL.
Comment 5 Simon McVittie 2010-06-17 06:02:52 UTC
Review of attachment 32554 [details] [review]:

::: doc/dbus-specification.xml
@@ +4098,3 @@
+          As a method:
+          <programlisting>
+            UINT32 GetConnectionUnixProcessID (in STRING connection_name)

in STRING bus_name, or unique_name, might be clearer?

@@ +4114,3 @@
+                  <entry>0</entry>
+                  <entry>STRING</entry>
+                  <entry>Name of the connection to query</entry>

Does this work for well-known names too? I'd say "Unique bus name of the...", or "Unique or well-known bus name of the...", depending.

@@ +4133,3 @@
+                <entry>0</entry>
+                <entry>UINT32</entry>
+                <entry>unix process id</entry>

Unix

@@ +4138,3 @@
+          </tgroup>
+        </informaltable>
+        Returns the unix process ID of the process connected to the server. If

Unix

@@ +4140,3 @@
+        Returns the unix process ID of the process connected to the server. If
+        unable to determine it, a
+        <literal>org.freedesktop.DBus.Error.Failed</literal> error is returned.

Since the Failed error is the catch-all, it'd be reasonable to add something more specific later, so I'd loosen this to "an error is returned".

It's probably worth saying "...unable to determine it (for instance because the process is not on the same machine as the bus daemon), ..."
Comment 6 Simon McVittie 2010-06-17 06:03:20 UTC
Review of attachment 32555 [details] [review]:

::: doc/dbus-specification.xml
@@ +3350,3 @@
         <para>
           Match rules are added using the AddMatch bus method 
+          (see <xref linkend="bus-messages-add-match"/>).  Rules are

Ship it.
Comment 7 Simon McVittie 2010-06-17 06:04:29 UTC
Review of attachment 32556 [details] [review]:

::: doc/dbus-specification.xml
@@ +3351,3 @@
+                  <entry>0</entry>
+                  <entry>STRING</entry>
+                  <entry>The name to query</entry>

"The well-known bus name to..." perhaps?

@@ +3370,3 @@
+                  <entry>0</entry>
+                  <entry>ARRAY of STRING</entry>
+                  <entry>The connections currently queued for the name</entry>

"The unique bus names of connections..."?
Comment 8 Will Thompson 2010-06-17 07:09:01 UTC
Created attachment 36329 [details] [review]
Document GetConnectionUnixProcessID in the spec
Comment 9 Will Thompson 2010-06-17 07:09:23 UTC
Created attachment 36330 [details] [review]
Document ListQueuedOwners in the spec
Comment 10 Will Thompson 2010-06-17 07:10:38 UTC
Created attachment 36331 [details] [review]
Clarify GetConnectionUnixUser documentation.

(This makes it match the freshly-documented GetConnectionUnixProcessID.)
Comment 11 Simon McVittie 2010-06-17 07:28:29 UTC
Review of attachment 36329 [details] [review]:

I approve.
Comment 12 Simon McVittie 2010-06-17 07:28:48 UTC
Review of attachment 36330 [details] [review]:

I approve.
Comment 13 Simon McVittie 2010-06-17 07:29:02 UTC
Review of attachment 36331 [details] [review]:

I approve.
Comment 14 Will Thompson 2010-06-17 07:35:08 UTC
Thanks, merged to master.


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.