From: Simon McVittie Date: Wed, 31 May 2017 15:17:02 +0000 (+0100) Subject: spec: Move ReleaseName API description to list of methods X-Git-Tag: dbus-1.11.14~58 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f3f347a8503062c341d1d7191d6acd9df7aa01dd;p=thirdparty%2Fdbus.git spec: Move ReleaseName API description to list of methods Tom Gundersen pointed out that RequestName, ReleaseName and ListQueuedOwners were documented in their own section instead of being put together with the other method calls, which makes it more difficult to apply changes consistently across all methods. I'm moving them one at a time to make the changes reviewable, since the diff resulting from moving all three as a unit is too large to review sensibly. Signed-off-by: Simon McVittie --- diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml index b9e2c02b5..45a475743 100644 --- a/doc/dbus-specification.xml +++ b/doc/dbus-specification.xml @@ -4254,101 +4254,6 @@ org.freedesktop.DBus.ReleaseName message. - - <literal>org.freedesktop.DBus.ReleaseName</literal> - - As a method: - - UINT32 ReleaseName (in STRING name) - - Message arguments: - - - - - Argument - Type - Description - - - - - 0 - STRING - Name to release - - - - - Reply arguments: - - - - - Argument - Type - Description - - - - - 0 - UINT32 - Return value - - - - - - - This method call should be sent to - org.freedesktop.DBus and asks the message bus to - release the method caller's claim to the given name. If the caller is - the primary owner, a new primary owner will be selected from the - queue if any other owners are waiting. If the caller is waiting in - the queue for the name, the caller will removed from the queue and - will not be made an owner of the name if it later becomes available. - If there are no other owners in the queue for the name, it will be - removed from the bus entirely. - - The return code can be one of the following values: - - - - - - Conventional Name - Value - Description - - - - - DBUS_RELEASE_NAME_REPLY_RELEASED - 1 The caller has released his claim on - the given name. Either the caller was the primary owner of - the name, and the name is now unused or taken by somebody - waiting in the queue for the name, or the caller was waiting - in the queue for the name and has now been removed from the - queue. - - - DBUS_RELEASE_NAME_REPLY_NON_EXISTENT - 2 - The given name does not exist on this bus. - - - DBUS_RELEASE_NAME_REPLY_NOT_OWNER - 3 - The caller was not the primary owner of this name, - and was also not waiting in the queue to own this name. - - - - - - - <literal>org.freedesktop.DBus.ListQueuedOwners</literal> @@ -5655,6 +5560,101 @@ + + <literal>org.freedesktop.DBus.ReleaseName</literal> + + As a method: + + UINT32 ReleaseName (in STRING name) + + Message arguments: + + + + + Argument + Type + Description + + + + + 0 + STRING + Name to release + + + + + Reply arguments: + + + + + Argument + Type + Description + + + + + 0 + UINT32 + Return value + + + + + + + This method call should be sent to + org.freedesktop.DBus and asks the message bus to + release the method caller's claim to the given name. If the caller is + the primary owner, a new primary owner will be selected from the + queue if any other owners are waiting. If the caller is waiting in + the queue for the name, the caller will removed from the queue and + will not be made an owner of the name if it later becomes available. + If there are no other owners in the queue for the name, it will be + removed from the bus entirely. + + The return code can be one of the following values: + + + + + + Conventional Name + Value + Description + + + + + DBUS_RELEASE_NAME_REPLY_RELEASED + 1 The caller has released his claim on + the given name. Either the caller was the primary owner of + the name, and the name is now unused or taken by somebody + waiting in the queue for the name, or the caller was waiting + in the queue for the name and has now been removed from the + queue. + + + DBUS_RELEASE_NAME_REPLY_NON_EXISTENT + 2 + The given name does not exist on this bus. + + + DBUS_RELEASE_NAME_REPLY_NOT_OWNER + 3 + The caller was not the primary owner of this name, + and was also not waiting in the queue to own this name. + + + + + + + <literal>org.freedesktop.DBus.ListNames</literal>