scsi: target: target_core_user.[ch]: convert comments into DOC:

Make documentation on target-supported userspace-I/O design be
usable by kernel-doc by using "DOC:". This is used in the driver-api
Documentation chapter.

Signed-off-by: Randy Dunlap <[email protected]>
To: "Nicholas A. Bellinger" <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: "James E.J. Bottomley" <[email protected]>
Cc: "Martin K. Petersen" <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Signed-off-by: Martin K. Petersen <[email protected]>
This commit is contained in:
Randy Dunlap 2018-04-14 10:51:05 -07:00 • committed by Martin K. Petersen
commit 572ccdab50
2 changed files with 12 additions and 7 deletions

View file

@ -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.
@ -53,7 +57,7 @@
* See the .h file for how the ring is laid out. Note that while the
* command ring is defined, the particulars of the data area are
* not. Offset values in the command entry point to other locations
* internal to the mmap()ed area. There is separate space outside the
* internal to the mmap-ed area. There is separate space outside the
* command ring for data buffers. This leaves maximum flexibility for
* moving buffer allocations, or even page flipping or other
* allocation techniques, without altering the command ring layout.