doc: minor fixes and new TODOs

Signed-off-by: Tom Gundersen <teg@jklm.no>

diff --git a/doc/kdbus.bus.xml b/doc/kdbus.bus.xml
index d7e14e34f173b03b644ca07ea23543d1dd73270a..fe2f67ec5b205a17da7eda7c8ba3e19b5affebcc 100644 (file)
--- a/doc/kdbus.bus.xml
+++ b/doc/kdbus.bus.xml
@@ -137,14 +137,14 @@ struct kdbus_cmd_make {
         <term><varname>items</varname></term>
         <listitem>
           <para>
-            The following items are expected for 
-            <varname>KDBUS_CMD_BUS_MAKE</varname>.
+            The following items (see <citerefentry><refentrytitle>kdbus.item</refentrytitle><manvolnum>7</manvolnum></citerefentry>)
+            are expected for <varname>KDBUS_CMD_BUS_MAKE</varname>.
           </para>
           <variablelist>
             <varlistentry>
               <term><varname>KDBUS_ITEM_MAKE_NAME</varname></term>
               <listitem>
-                <para>Contains a string to identify the bus name.</para>
+                <para>Contains a null-terminated string that identifies the bus. The name must be unique across the kdbus domain and must start with the effective UID of the caller followed by a '-'. This item is mandatory.</para>
               </listitem>
             </varlistentry>
 
@@ -153,7 +153,8 @@ struct kdbus_cmd_make {
               <listitem>
                 <para>Bus-wide bloom parameters passed in a
                   <varname>struct kdbus_bloom_parameter</varname>. These
-                  settings are copied back to new connections verbatim.
+                  settings are copied back to new connections verbatim. This item is mandatory.
+TODO: document the bloom_parameter struct and reference that from here (maybe kdbus.bloom.7?)
                 </para>
               </listitem>
             </varlistentry>
@@ -201,6 +202,13 @@ struct kdbus_cmd_make {
     </para>
 
     <variablelist>
+      <varlistentry>
+        <term><varname>-EBADMSG</varname></term>
+        <listitem><para>
+          A mandatory item is missing.
+        </para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><varname>-EINVAL</varname></term>
         <listitem><para>

diff --git a/doc/kdbus.names.xml b/doc/kdbus.names.xml
index b2594727e72e402e323546918f4cdc9151de4a9e..f2c4c63fb889b16f2f7ac33af94d01c2bcda013e 100644 (file)
--- a/doc/kdbus.names.xml
+++ b/doc/kdbus.names.xml
@@ -205,7 +205,6 @@ struct kdbus_cmd_name {
 
   __u64 kernel_flags;
     Valid flags for this command, returned by the kernel upon each call.
-    See section 3.2 for more details.
 
   __u64 return_flags;
     Flags returned by the kernel. Currently unused and always set to zero by

diff --git a/doc/kdbus.xml b/doc/kdbus.xml
index cdbb7d4b36d1a778e18de9836d83e96024ea8e39..245eca12019b507068185581b652590e2a7c141a 100644 (file)
--- a/doc/kdbus.xml
+++ b/doc/kdbus.xml
@@ -79,7 +79,7 @@
         A bus is a named object inside a domain. Clients exchange messages
         over a bus. Multiple buses themselves have no connection to each other;
         messages can only be exchanged on the same bus. The default endpoint of
-        a bus, to which clients establish connections to, is the "bus" file
+        a bus, to which clients establish connections, is the "bus" file
         /sys/fs/kdbus/<bus name>/bus.
         Common operating system setups create one "system bus" per system,
         and one "user bus" for every logged-in user. Applications or services
@@ -131,7 +131,6 @@
         used to receive messages and answers to ioctl commands from the kernel.
         It is never used to send anything to the kernel. In order to access that
         memory, a userspace application must mmap() it into its address space.
-        See section 12 for more details.
         See
         <citerefentry><refentrytitle>kdbus.pool</refentrytitle><manvolnum>7</manvolnum></citerefentry>
         for more details.
@@ -166,7 +165,7 @@
         connection. Metadata contains information like: system timestamps, UID, GID,
         TID, proc-starttime, well-known names, process comm, process exe, process
         argv, cgroup, capabilities, seclabel, audit session, loginuid and the
-        connection's human-readable name. See section 7 and 13 for more details.
+        connection's human-readable name.
         See
         <citerefentry><refentrytitle>kdbus.message</refentrytitle><manvolnum>7</manvolnum></citerefentry>
         for more details.
@@ -178,7 +177,7 @@
       <para>
         The API of kdbus implements the notion of items, submitted through and
         returned by most ioctls, and stored inside data structures in the
-        connection's pool. See section 4 for more details.
+        connection's pool.
         See
         <citerefentry><refentrytitle>kdbus.item</refentrytitle><manvolnum>7</manvolnum></citerefentry>
         for more details.
@@ -208,7 +207,7 @@
         A policy is a set of rules that define which connections can see, talk to,
         or register a well-known name on the bus. A policy is attached to buses and
         custom endpoints, and modified by policy holder connections or owners of
-        custom endpoints. See section 11 for more details.
+        custom endpoints.
         See
         <citerefentry><refentrytitle>kdbus.policy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
         for more details.