fix kerneldoc

diff --git a/TODO b/TODO
index f28cc824453d9561ff50e26c0fcc14f21c1956af..62c257bc2927005784f00629f828aec1202198c6 100644 (file)
--- a/TODO
+++ b/TODO
@@ -10,14 +10,12 @@ Features:
      - policy, policy for custom endpoints
 
   - attach seclabel to names?
-
   - attach policy to names? Where/how to store names from policy but
     otherwise inactive names (name laceholders).
-
   - find a way to specify "name prefix wildcards" like:
      "com.expample.foo.* can be owned by uid foo"
 
-  - also attach queued names to metadata?
+  - also attach queued names to message metadata?
 
   - account and limit number of messages a connection can have in-flight
     for another connection, like a connection can have a maximum of 100

diff --git a/connection.c b/connection.c
index 9a2998ae7323f5778c6601e0e99275b251e26b30..4015fa51d9ac243c08be6c4132cb5cb4778fc108 100644 (file)
--- a/connection.c
+++ b/connection.c
@@ -44,6 +44,7 @@
  * @entry:             Entry in the connection's list
  * @prio_node:         Entry in the priority queue tree
  * @prio_entry:                Queue tree node entry in the list of one priority
+ * @priority:          Queueing priority of the message
  * @off:               Offset into the shmem file in the receiver's pool
  * @size:              The number of bytes used in the pool
  * @memfds:            Arrays of offsets where to update the installed
@@ -1046,7 +1047,7 @@ remove_unused:
 /**
  * kdbus_conn_recv_msg - receive a message from the queue
  * @conn:              Connection to work on
- * @buf:               The returned offset to the message in the pool
+ * @recv_user:         The returned offset to the message in the pool
  *
  * Returns: 0 on success, negative errno on failure.
  */

diff --git a/connection.h b/connection.h
index 70162121f5b847a29db047f363b4b671d531946d..c5c2d0ed786db2efb212bf151aa9b10fa5e02ecf 100644 (file)
--- a/connection.h
+++ b/connection.h
@@ -30,7 +30,7 @@
  * @lock:              Connection data lock
  * @msg_list:          Queue of messages
  * @msg_prio_queue:    Tree of messages, sorted by priority
- * @prio_highest:      Cached entry for highest priority (lowest value) node
+ * @msg_prio_highest:  Cached entry for highest priority (lowest value) node
  * @hentry:            Entry in ID <-> connection map
  * @monitor_entry:     The connection is a monitor
  * @names_list:                List of well-known names
@@ -91,7 +91,7 @@ struct kdbus_conn *kdbus_conn_unref(struct kdbus_conn *conn);
 int kdbus_conn_disconnect(struct kdbus_conn *conn, bool ensure_msg_list_empty);
 
 int kdbus_conn_recv_msg(struct kdbus_conn *conn,
-                       struct kdbus_cmd_recv __user *recv);
+                       struct kdbus_cmd_recv __user *recv_user);
 int kdbus_cmd_conn_info(struct kdbus_conn *conn,
                        void __user *buf);
 int kdbus_conn_kmsg_send(struct kdbus_ep *ep,

diff --git a/kdbus.h b/kdbus.h
index 10102d43358623379f449904b5efb4a715a5786f..357212709b8a3b45e6b4a0829f963356f91e7968 100644 (file)
--- a/kdbus.h
+++ b/kdbus.h
@@ -9,6 +9,9 @@
  * the terms of the GNU Lesser General Public License as published by the
  * Free Software Foundation; either version 2.1 of the License, or (at
  * your option) any later version.
+ *
+ * "Everything should be made as simple as possible, but not simpler."
+ *   -- Albert Einstein
  */
 
 #ifndef _KDBUS_H_
@@ -399,7 +402,7 @@ enum kdbus_recv_flags {
 };
 
 /**
- * kdbus_cmd_recv - struct to de-queue a buffered message
+ * struct kdbus_cmd_recv - struct to de-queue a buffered message
  * @flags:             KDBUS_RECV_* flags
  * @priority:          Minimum priority of the messages to de-queue. Lowest
  *                     values have the highest priority.

diff --git a/pool.c b/pool.c
index b54d4b3974cf7a7c3eb490686393f8609ce10522..a9cc7a4574943f6d0874117a4b472342ef29045c 100644 (file)
--- a/pool.c
+++ b/pool.c
@@ -33,7 +33,7 @@
  * @f:                 The backing shmem file
  * @size:              The size of the file
  * @busy:              The currently used size
- * @lock               Pool data lock
+ * @lock:              Pool data lock
  * @slices:            All slices sorted by address
  * @slices_busy:       Tree of allocated slices
  * @slices_free:       Tree of free slices