summaryrefslogtreecommitdiffstats
path: root/drivers/scsi
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2017-12-22 17:08:27 -0500
committerMartin K. Petersen <martin.petersen@oracle.com>2018-01-03 23:10:06 -0500
commitccd4a43035090c00611459a63f6cb31335decc9b (patch)
tree1d62d61bddfd5fa6e3124b197adb5fd9b6441980 /drivers/scsi
parentf49d4aed1315a7b766d855f1367142e682b0cc87 (diff)
scsi: doc: fix iscsi-related kernel-doc warnings
Fix kernel-doc warnings in drivers/scsi/ that are related to iscsi support interfaces. Fixes these kernel-doc warnings: (tested by adding these files to a new target.rst documentation file: WIP) ../drivers/scsi/libiscsi.c:2740: warning: No description found for parameter 'dd_size' ../drivers/scsi/libiscsi.c:2740: warning: No description found for parameter 'id' ../drivers/scsi/libiscsi.c:2961: warning: No description found for parameter 'cls_conn' ../drivers/scsi/iscsi_tcp.c:313: warning: No description found for parameter 'conn' ../drivers/scsi/iscsi_tcp.c:363: warning: No description found for parameter 'conn' ../drivers/scsi/libiscsi_tcp.c:810: warning: No description found for parameter 'tcp_conn' ../drivers/scsi/libiscsi_tcp.c:810: warning: No description found for parameter 'segment' ../drivers/scsi/libiscsi_tcp.c:887: warning: No description found for parameter 'offloaded' ../drivers/scsi/libiscsi_tcp.c:887: warning: No description found for parameter 'status' ../drivers/scsi/libiscsi_tcp.c:887: warning: Excess function parameter 'offload' description in 'iscsi_tcp_recv_skb' ../drivers/scsi/libiscsi_tcp.c:964: warning: Excess function parameter 'conn' description in 'iscsi_tcp_task_init' ../drivers/scsi/libiscsi_tcp.c:964: warning: Excess function parameter 'sc' description in 'iscsi_tcp_task_init' 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> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
Diffstat (limited to 'drivers/scsi')
-rw-r--r--drivers/scsi/iscsi_tcp.c2
-rw-r--r--drivers/scsi/libiscsi.c4
-rw-r--r--drivers/scsi/libiscsi_tcp.c9
3 files changed, 10 insertions, 5 deletions
diff --git a/drivers/scsi/iscsi_tcp.c b/drivers/scsi/iscsi_tcp.c
index 4d934d6c3e13..6198559abbd8 100644
--- a/drivers/scsi/iscsi_tcp.c
+++ b/drivers/scsi/iscsi_tcp.c
@@ -307,6 +307,7 @@ static int iscsi_sw_tcp_xmit_segment(struct iscsi_tcp_conn *tcp_conn,
307 307
308/** 308/**
309 * iscsi_sw_tcp_xmit - TCP transmit 309 * iscsi_sw_tcp_xmit - TCP transmit
310 * @conn: iscsi connection
310 **/ 311 **/
311static int iscsi_sw_tcp_xmit(struct iscsi_conn *conn) 312static int iscsi_sw_tcp_xmit(struct iscsi_conn *conn)
312{ 313{
@@ -357,6 +358,7 @@ error:
357 358
358/** 359/**
359 * iscsi_tcp_xmit_qlen - return the number of bytes queued for xmit 360 * iscsi_tcp_xmit_qlen - return the number of bytes queued for xmit
361 * @conn: iscsi connection
360 */ 362 */
361static inline int iscsi_sw_tcp_xmit_qlen(struct iscsi_conn *conn) 363static inline int iscsi_sw_tcp_xmit_qlen(struct iscsi_conn *conn)
362{ 364{
diff --git a/drivers/scsi/libiscsi.c b/drivers/scsi/libiscsi.c
index 785d1c55d152..15a2fef51e38 100644
--- a/drivers/scsi/libiscsi.c
+++ b/drivers/scsi/libiscsi.c
@@ -2744,8 +2744,10 @@ static void iscsi_host_dec_session_cnt(struct Scsi_Host *shost)
2744 * @iscsit: iscsi transport template 2744 * @iscsit: iscsi transport template
2745 * @shost: scsi host 2745 * @shost: scsi host
2746 * @cmds_max: session can queue 2746 * @cmds_max: session can queue
2747 * @dd_size: private driver data size, added to session allocation size
2747 * @cmd_task_size: LLD task private data size 2748 * @cmd_task_size: LLD task private data size
2748 * @initial_cmdsn: initial CmdSN 2749 * @initial_cmdsn: initial CmdSN
2750 * @id: target ID to add to this session
2749 * 2751 *
2750 * This can be used by software iscsi_transports that allocate 2752 * This can be used by software iscsi_transports that allocate
2751 * a session per scsi host. 2753 * a session per scsi host.
@@ -2973,7 +2975,7 @@ EXPORT_SYMBOL_GPL(iscsi_conn_setup);
2973 2975
2974/** 2976/**
2975 * iscsi_conn_teardown - teardown iscsi connection 2977 * iscsi_conn_teardown - teardown iscsi connection
2976 * cls_conn: iscsi class connection 2978 * @cls_conn: iscsi class connection
2977 * 2979 *
2978 * TODO: we may need to make this into a two step process 2980 * TODO: we may need to make this into a two step process
2979 * like scsi-mls remove + put host 2981 * like scsi-mls remove + put host
diff --git a/drivers/scsi/libiscsi_tcp.c b/drivers/scsi/libiscsi_tcp.c
index 63a1d69ff515..369ef8f23b24 100644
--- a/drivers/scsi/libiscsi_tcp.c
+++ b/drivers/scsi/libiscsi_tcp.c
@@ -798,6 +798,8 @@ iscsi_tcp_hdr_dissect(struct iscsi_conn *conn, struct iscsi_hdr *hdr)
798 798
799/** 799/**
800 * iscsi_tcp_hdr_recv_done - process PDU header 800 * iscsi_tcp_hdr_recv_done - process PDU header
801 * @tcp_conn: iSCSI TCP connection
802 * @segment: the buffer segment being processed
801 * 803 *
802 * This is the callback invoked when the PDU header has 804 * This is the callback invoked when the PDU header has
803 * been received. If the header is followed by additional 805 * been received. If the header is followed by additional
@@ -876,9 +878,10 @@ EXPORT_SYMBOL_GPL(iscsi_tcp_recv_segment_is_hdr);
876 * @conn: iscsi connection 878 * @conn: iscsi connection
877 * @skb: network buffer with header and/or data segment 879 * @skb: network buffer with header and/or data segment
878 * @offset: offset in skb 880 * @offset: offset in skb
879 * @offload: bool indicating if transfer was offloaded 881 * @offloaded: bool indicating if transfer was offloaded
882 * @status: iscsi TCP status result
880 * 883 *
881 * Will return status of transfer in status. And will return 884 * Will return status of transfer in @status. And will return
882 * number of bytes copied. 885 * number of bytes copied.
883 */ 886 */
884int iscsi_tcp_recv_skb(struct iscsi_conn *conn, struct sk_buff *skb, 887int iscsi_tcp_recv_skb(struct iscsi_conn *conn, struct sk_buff *skb,
@@ -955,9 +958,7 @@ EXPORT_SYMBOL_GPL(iscsi_tcp_recv_skb);
955 958
956/** 959/**
957 * iscsi_tcp_task_init - Initialize iSCSI SCSI_READ or SCSI_WRITE commands 960 * iscsi_tcp_task_init - Initialize iSCSI SCSI_READ or SCSI_WRITE commands
958 * @conn: iscsi connection
959 * @task: scsi command task 961 * @task: scsi command task
960 * @sc: scsi command
961 */ 962 */
962int iscsi_tcp_task_init(struct iscsi_task *task) 963int iscsi_tcp_task_init(struct iscsi_task *task)
963{ 964{