From: Simon McVittie <smcv@collabora.com>
Date: Tue, 12 Dec 2017 12:31:20 +0000 (+0000)
Subject: spec: Document the direction of each auth command
X-Git-Tag: dbus-1.13.0~47
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=553ca04550564594bc3ff291770636ec4c3324a5;p=thirdparty%2Fdbus.git

spec: Document the direction of each auth command

Signed-off-by: Simon McVittie <smcv@collabora.com>
Reviewed-by: Philip Withnall <withnall@endlessm.com>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=104224
---

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index 2852411e0..c6e204b61 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -2303,6 +2303,9 @@
     </sect2>
     <sect2 id="auth-command-auth">
       <title>AUTH command</title>
+      <para>
+        The AUTH command is sent by the client to the server.
+      </para>
       <para>
         If an AUTH command has no arguments, it is a request to list
         available mechanisms. The server must respond with a REJECTED
@@ -2333,6 +2336,9 @@
     </sect2>
     <sect2 id="auth-command-cancel">
       <title>CANCEL Command</title>
+      <para>
+        The CANCEL command is sent by the client to the server.
+      </para>
       <para>
         At any time up to sending the BEGIN command, the client may send a
         CANCEL command. On receiving the CANCEL command, the server must
@@ -2354,6 +2360,9 @@
     </sect2>
     <sect2 id="auth-command-begin">
       <title>BEGIN Command</title>
+      <para>
+        The BEGIN command is sent by the client to the server.
+      </para>
       <para>
         The BEGIN command acknowledges that the client has received an
         OK command from the server and completed any feature negotiation
@@ -2375,6 +2384,9 @@
     </sect2>
     <sect2 id="auth-command-rejected">
       <title>REJECTED Command</title>
+      <para>
+        The REJECTED command is sent by the server to the client.
+      </para>
       <para>
         The REJECTED command indicates that the current authentication
         exchange has failed, and further exchange of DATA is inappropriate.
@@ -2390,6 +2402,9 @@
     </sect2>
     <sect2 id="auth-command-ok">
       <title>OK Command</title>
+      <para>
+        The OK command is sent by the server to the client.
+      </para>
       <para>
         The OK command indicates that the client has been
         authenticated. The client may now proceed with negotiating
@@ -2421,6 +2436,9 @@
     </sect2>
     <sect2 id="auth-command-error">
       <title>ERROR Command</title>
+      <para>
+        The ERROR command can be sent in either direction.
+      </para>
       <para>
         The ERROR command indicates that either server or client did not
         know a command, does not accept the given command in the current
@@ -2448,6 +2466,9 @@
     </sect2>
     <sect2 id="auth-command-negotiate-unix-fd">
       <title>NEGOTIATE_UNIX_FD Command</title>
+      <para>
+        The NEGOTIATE_UNIX_FD command is sent by the client to the server.
+      </para>
       <para>
         The NEGOTIATE_UNIX_FD command indicates that the client
         supports Unix file descriptor passing. This command may only
@@ -2468,6 +2489,9 @@
     </sect2>
     <sect2 id="auth-command-agree-unix-fd">
       <title>AGREE_UNIX_FD Command</title>
+      <para>
+        The AGREE_UNIX_FD command is sent by the server to the client.
+      </para>
       <para>
         The AGREE_UNIX_FD command indicates that the server supports
         Unix file descriptor passing. This command may only be sent