[PATCH 02/44] uapi: kdbus.h: Kernel-doc fixes

[Sergei Zviagintsev]

 - Fix typos and spelling errors, use proper case.

 - struct kdbus_pids: Add PPID to description.

 - struct kdbus_item: Add missing @pids, @fsd and
   KDBUS_ITEM_PAYLOAD_OFF.

Signed-off-by: Sergei Zviagintsev <sergei@xxxxxxxx>
---
 include/uapi/linux/kdbus.h | 43 +++++++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 20 deletions(-)

diff --git a/include/uapi/linux/kdbus.h b/include/uapi/linux/kdbus.h
index 4fc44cb1d4a8..09b23af87ce6 100644
--- a/include/uapi/linux/kdbus.h
+++ b/include/uapi/linux/kdbus.h
@@ -21,7 +21,7 @@
 /**
  * struct kdbus_notify_id_change - name registry change message
  * @id:			New or former owner of the name
- * @flags:		flags field from KDBUS_HELLO_*
+ * @flags:		Flags field from KDBUS_HELLO_*
  *
  * Sent from kernel to userspace when the owner or activator of
  * a well-known name changes.
@@ -86,7 +86,7 @@ struct kdbus_creds {
  * @tid:		Thread ID
  * @ppid:		Parent process ID
  *
- * The PID and TID of a process.
+ * The PID, TID and PPID of a process.
  *
  * Attached to:
  *   KDBUS_ITEM_PIDS
@@ -212,7 +212,7 @@ struct kdbus_name {
  * enum kdbus_policy_access_type - permissions of a policy record
  * @_KDBUS_POLICY_ACCESS_NULL:	Uninitialized/invalid
  * @KDBUS_POLICY_ACCESS_USER:	Grant access to a uid
- * @KDBUS_POLICY_ACCESS_GROUP:	Grant access to gid
+ * @KDBUS_POLICY_ACCESS_GROUP:	Grant access to a gid
  * @KDBUS_POLICY_ACCESS_WORLD:	World-accessible
  */
 enum kdbus_policy_access_type {
@@ -267,7 +267,7 @@ struct kdbus_policy_access {
  * @KDBUS_ATTACH_CONN_DESCRIPTION:	The human-readable connection name
  * @_KDBUS_ATTACH_ALL:			All of the above
  * @_KDBUS_ATTACH_ANY:			Wildcard match to enable any kind of
- *					metatdata.
+ *					metadata
  */
 enum kdbus_attach_flags {
 	KDBUS_ATTACH_TIMESTAMP		=  1ULL <<  0,
@@ -308,7 +308,7 @@ enum kdbus_attach_flags {
  *					connection, carries a struct
  *					kdbus_bloom_filter
  * @KDBUS_ITEM_BLOOM_MASK:		Bloom mask used to match against a
- *					message'sbloom filter
+ *					message's bloom filter
  * @KDBUS_ITEM_DST_NAME:		Destination's well-known name
  * @KDBUS_ITEM_MAKE_NAME:		Name of domain, bus, endpoint
  * @KDBUS_ITEM_ATTACH_FLAGS_SEND:	Attach-flags, used for updating which
@@ -409,20 +409,23 @@ enum kdbus_item_type {
 /**
  * struct kdbus_item - chain of data blocks
  * @size:		Overall data record size
- * @type:		Kdbus_item type of data
+ * @type:		kdbus_item type of data
  * @data:		Generic bytes
- * @data32:		Generic 32 bit array
- * @data64:		Generic 64 bit array
+ * @data32:		Generic 32-bit array
+ * @data64:		Generic 64-bit array
  * @str:		Generic string
  * @id:			Connection ID
  * @vec:		KDBUS_ITEM_PAYLOAD_VEC
+ *			KDBUS_ITEM_PAYLOAD_OFF
  * @creds:		KDBUS_ITEM_CREDS
+ * @pids:		KDBUS_ITEM_PIDS
  * @audit:		KDBUS_ITEM_AUDIT
  * @timestamp:		KDBUS_ITEM_TIMESTAMP
  * @name:		KDBUS_ITEM_NAME
  * @bloom_parameter:	KDBUS_ITEM_BLOOM_PARAMETER
  * @bloom_filter:	KDBUS_ITEM_BLOOM_FILTER
  * @memfd:		KDBUS_ITEM_PAYLOAD_MEMFD
+ * @fsd:		KDBUS_ITEM_FDS
  * @name_change:	KDBUS_ITEM_NAME_ADD
  *			KDBUS_ITEM_NAME_REMOVE
  *			KDBUS_ITEM_NAME_CHANGE
@@ -721,10 +724,10 @@ struct kdbus_cmd_hello {
 
 /**
  * struct kdbus_info - connection information
- * @size:		total size of the struct
- * @id:			64bit object ID
- * @flags:		object creation flags
- * @items:		list of items
+ * @size:		Total size of the struct
+ * @id:			64-bit object ID
+ * @flags:		Object creation flags
+ * @items:		List of items
  *
  * Note that the user is responsible for freeing the allocated memory with
  * the KDBUS_CMD_FREE ioctl.
@@ -738,10 +741,10 @@ struct kdbus_info {
 
 /**
  * enum kdbus_list_flags - what to include into the returned list
- * @KDBUS_LIST_UNIQUE:		active connections
- * @KDBUS_LIST_ACTIVATORS:	activator connections
- * @KDBUS_LIST_NAMES:		known well-known names
- * @KDBUS_LIST_QUEUED:		queued-up names
+ * @KDBUS_LIST_UNIQUE:		Active connections
+ * @KDBUS_LIST_ACTIVATORS:	Activator connections
+ * @KDBUS_LIST_NAMES:		Known well-known names
+ * @KDBUS_LIST_QUEUED:		Queued-up names
  */
 enum kdbus_list_flags {
 	KDBUS_LIST_UNIQUE		= 1ULL <<  0,
@@ -752,14 +755,14 @@ enum kdbus_list_flags {
 
 /**
  * struct kdbus_cmd_list - list connections
- * @size:		overall size of this object
- * @flags:		flags for the query (KDBUS_LIST_*), userspace â kernel
- * @return_flags:	command return flags, kernel â userspace
+ * @size:		Overall size of this object
+ * @flags:		Flags for the query (KDBUS_LIST_*), userspace â kernel
+ * @return_flags:	Command return flags, kernel â userspace
  * @offset:		Offset in the caller's pool buffer where an array of
  *			kdbus_info objects is stored.
  *			The user must use KDBUS_CMD_FREE to free the
  *			allocated memory.
- * @list_size:		size of returned list in bytes
+ * @list_size:		Size of returned list in bytes
  * @items:		Items for the command. Reserved for future use.
  *
  * This structure is used with the KDBUS_CMD_LIST ioctl.
-- 
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/