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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

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

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc:	"Nicholas A. Bellinger" <nab@xxxxxxxxxxxxxxx>
Cc:	linux-scsi@xxxxxxxxxxxxxxx
Cc:	target-devel@xxxxxxxxxxxxxxx
Cc:	Sagi Grimberg <sagi@xxxxxxxxxxx>
Cc:	linux-rdma@xxxxxxxxxxxxxxx
Cc:	"James E.J. Bottomley" <jejb@xxxxxxxxxxxxxxxxxx>
Cc:	"Martin K. Petersen" <martin.petersen@xxxxxxxxxx>
Cc:	Shaohua Li <shli@xxxxxxxxxx>
Cc:	Andy Grover <agrover@xxxxxxxxxx>
---
 drivers/target/target_core_user.c     |    6 +++++-
 include/uapi/linux/target_core_user.h |   11 ++++++-----
 2 files changed, 11 insertions(+), 6 deletions(-)

--- 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





[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [SCSI Target Devel]     [Linux SCSI Target Infrastructure]     [Kernel Newbies]     [IDE]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux ATA RAID]     [Linux IIO]     [Samba]     [Device Mapper]

  Powered by Linux