From: Randy Dunlap <rd.dunlab@gmail.com>
To: "Nicholas A. Bellinger" <nab@linux-iscsi.org>
Cc: Randy Dunlap <rdunlap@infradead.org>,
linux-scsi@vger.kernel.org, target-devel@vger.kernel.org,
linux-doc@vger.kernel.org,
"James E.J. Bottomley" <jejb@linux.vnet.ibm.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v3 4/4] target: add driver-api document
Date: Sat, 14 Apr 2018 17:51:06 +0000 [thread overview]
Message-ID: <20180414175106.13760-5-rd.dunlab@gmail.com> (raw)
In-Reply-To: <20180414175106.13760-1-rd.dunlab@gmail.com>
From: Randy Dunlap <rdunlap@infradead.org>
Add a driver-api document for target/iSCSI interfaces.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
To: "Nicholas A. Bellinger" <nab@linux-iscsi.org>
Cc: linux-scsi@vger.kernel.org
Cc: target-devel@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Cc: "James E.J. Bottomley" <jejb@linux.vnet.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: Jonathan Corbet <corbet@lwn.net>
---
Documentation/driver-api/index.rst | 1
Documentation/driver-api/scsi.rst | 2
Documentation/driver-api/target.rst | 64 ++++++++++++++++++++++++++
3 files changed, 66 insertions(+), 1 deletion(-)
--- linux-next-20180413.orig/Documentation/driver-api/index.rst
+++ linux-next-20180413/Documentation/driver-api/index.rst
@@ -34,6 +34,7 @@ available subsections can be seen below.
edac
scsi
libata
+ target
mtdnand
miscellaneous
w1
--- linux-next-20180413.orig/Documentation/driver-api/scsi.rst
+++ linux-next-20180413/Documentation/driver-api/scsi.rst
@@ -334,5 +334,5 @@ todo
~~~~
Parallel (fast/wide/ultra) SCSI, USB, SATA, SAS, Fibre Channel,
-FireWire, ATAPI devices, Infiniband, I2O, iSCSI, Parallel ports,
+FireWire, ATAPI devices, Infiniband, I2O, Parallel ports,
netlink...
--- /dev/null
+++ linux-next-20180413/Documentation/driver-api/target.rst
@@ -0,0 +1,64 @@
+================+target and iSCSI Interfaces Guide
+================+
+Introduction and Overview
+============+
+TBD
+
+Target core device interfaces
+==============+
+.. kernel-doc:: drivers/target/target_core_device.c
+ :export:
+
+Target core transport interfaces
+================
+
+.. kernel-doc:: drivers/target/target_core_transport.c
+ :export:
+
+Target-supported userspace I/O
+===============
+
+.. kernel-doc:: drivers/target/target_core_user.c
+ :doc: Userspace I/O
+
+.. kernel-doc:: include/uapi/linux/target_core_user.h
+ :doc: Ring Design
+
+iSCSI helper functions
+===========
+
+.. kernel-doc:: drivers/scsi/libiscsi.c
+ :export:
+
+
+iSCSI boot information
+===========
+
+.. kernel-doc:: drivers/scsi/iscsi_boot_sysfs.c
+ :export:
+
+
+iSCSI transport class
+==========+
+The file drivers/scsi/scsi_transport_iscsi.c defines transport
+attributes for the iSCSI class, which sends SCSI packets over TCP/IP
+connections.
+
+.. kernel-doc:: drivers/scsi/scsi_transport_iscsi.c
+ :export:
+
+
+iSCSI TCP interfaces
+==========
+
+.. kernel-doc:: drivers/scsi/iscsi_tcp.c
+ :internal:
+
+.. kernel-doc:: drivers/scsi/libiscsi_tcp.c
+ :export:
+
next prev parent reply other threads:[~2018-04-14 17:51 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-14 17:51 target: clean up kernel-doc and add driver-api document Randy Dunlap
2018-04-14 17:51 ` [PATCH v3 1/4] target: target_core_transport.c: fix kernel-doc warnings Randy Dunlap
2018-04-14 17:51 ` [PATCH v3 2/4] target: target_core_transport.c: enable+fix kernel-doc Randy Dunlap
2018-04-14 17:51 ` [PATCH v3 3/4] target: target_core_user.[ch]: convert comments into DOC: Randy Dunlap
2018-04-14 17:51 ` Randy Dunlap [this message]
2018-04-20 22:54 ` target: clean up kernel-doc and add driver-api document Martin K. Petersen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180414175106.13760-5-rd.dunlab@gmail.com \
--to=rd.dunlab@gmail.com \
--cc=corbet@lwn.net \
--cc=jejb@linux.vnet.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=martin.petersen@oracle.com \
--cc=nab@linux-iscsi.org \
--cc=rdunlap@infradead.org \
--cc=target-devel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).