diff mbox

target: add kernel-doc overview in target_core_user.[hc]

Message ID 7e8662e8-f554-cc8c-0287-6a22f561692b@infradead.org (mailing list archive)
State Not Applicable
Headers show

Commit Message

Randy Dunlap Dec. 23, 2017, 5:40 a.m. UTC 
From: Randy Dunlap <rdunlap@infradead.org>

Make documentation on target-supported userspace-I/O design be
usable by kernel-doc by using "DOC:".

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc:	"Nicholas A. Bellinger" <nab@linux-iscsi.org>
Cc:	linux-scsi@vger.kernel.org
Cc:	target-devel@vger.kernel.org
Cc:	Sagi Grimberg <sagi@grimberg.me>
Cc:	linux-rdma@vger.kernel.org
Cc:	"James E.J. Bottomley" <jejb@linux.vnet.ibm.com>
Cc:	"Martin K. Petersen" <martin.petersen@oracle.com>
Cc:	Shaohua Li <shli@kernel.org>
Cc:	Andy Grover <agrover@redhat.com>
---
 drivers/target/target_core_user.c     |    6 +++++-
 include/uapi/linux/target_core_user.h |   11 ++++++-----
 2 files changed, 11 insertions(+), 6 deletions(-)
diff mbox

Patch

--- linux-next-20171221.orig/drivers/target/target_core_user.c
+++ linux-next-20171221/drivers/target/target_core_user.c
@@ -42,7 +42,11 @@ 
 
 #include <linux/target_core_user.h>
 
-/*
+/**
+ * DOC: Userspace I/O
+ * Userspace I/O
+ * -------------
+ *
  * Define a shared-memory interface for LIO to pass SCSI commands and
  * data to userspace for processing. This is to allow backends that
  * are too complex for in-kernel support to be possible.
--- linux-next-20171221.orig/include/uapi/linux/target_core_user.h
+++ linux-next-20171221/include/uapi/linux/target_core_user.h
@@ -9,21 +9,22 @@ 
 
 #define TCMU_VERSION "2.0"
 
-/*
+/**
+ * DOC: Ring Design
  * Ring Design
  * -----------
  *
  * The mmaped area is divided into three parts:
- * 1) The mailbox (struct tcmu_mailbox, below)
- * 2) The command ring
- * 3) Everything beyond the command ring (data)
+ * 1) The mailbox (struct tcmu_mailbox, below);
+ * 2) The command ring;
+ * 3) Everything beyond the command ring (data).
  *
  * The mailbox tells userspace the offset of the command ring from the
  * start of the shared memory region, and how big the command ring is.
  *
  * The kernel passes SCSI commands to userspace by putting a struct
  * tcmu_cmd_entry in the ring, updating mailbox->cmd_head, and poking
- * userspace via uio's interrupt mechanism.
+ * userspace via UIO's interrupt mechanism.
  *
  * tcmu_cmd_entry contains a header. If the header type is PAD,
  * userspace should skip hdr->length bytes (mod cmdr_size) to find the