[PATCH 01/44] Documentation/kdbus: Document new name registry flags

[Sergei Zviagintsev]

Add description of KDBUS_NAME_PRIMARY and KDBUS_NAME_ACQUIRED flags
which were added in commit 0486b859f05a ("kdbus: inform caller about
exact updates on NAME_ACQUIRE").

Signed-off-by: Sergei Zviagintsev <sergei@xxxxxxxx>
---
 Documentation/kdbus/kdbus.name.xml | 42 +++++++++++++++++++++++++++++++++++---
 1 file changed, 39 insertions(+), 3 deletions(-)

diff --git a/Documentation/kdbus/kdbus.name.xml b/Documentation/kdbus/kdbus.name.xml
index 3f5f6a6c5ed6..85c8c30c0edd 100644
--- a/Documentation/kdbus/kdbus.name.xml
+++ b/Documentation/kdbus/kdbus.name.xml
@@ -209,6 +209,32 @@ struct kdbus_cmd {
                 </para>
               </listitem>
             </varlistentry>
+
+            <varlistentry>
+              <term><constant>KDBUS_NAME_PRIMARY</constant></term>
+              <listitem>
+                <para>
+		  The connection is currently the primary owner of the name.
+		  This flag is the negation of
+		  <constant>KDBUS_NAME_IN_QUEUE</constant>, but is required to
+		  distinguish the case from the situation where the connection
+		  is neither queued nor the primary owner of the name.
+                </para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term><constant>KDBUS_NAME_ACQUIRED</constant></term>
+              <listitem>
+                <para>
+                  This flag is used to let the caller know whether
+		  <emphasis>this</emphasis> exact call actually queued the
+		  connection on the name. If the flag is not set, the connection
+		  was either already queued and only the flags were updated, or
+		  the connection is not queued at all.
+                </para>
+              </listitem>
+            </varlistentry>
           </variablelist>
         </listitem>
       </varlistentry>
@@ -489,9 +515,19 @@ struct kdbus_info {
               <listitem>
                 <para>
                   When retrieving a list of currently acquired names in the
-                  registry, this flag indicates whether the connection
-                  actually owns the name or is currently waiting for it to
-                  become available.
+                  registry, this flag indicates that the connection is currently
+                  waiting for the name to become available.
+                </para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term><constant>KDBUS_NAME_PRIMARY</constant></term>
+              <listitem>
+                <para>
+                  When retrieving a list of currently acquired names in the
+                  registry, this flag indicates that the connection is the
+                  primary owner of the name.
                 </para>
               </listitem>
             </varlistentry>
-- 
1.8.3.1

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/