diff options
author | Randy Dunlap <rdunlap@infradead.org> | 2017-12-22 17:08:27 -0500 |
---|---|---|
committer | Martin K. Petersen <martin.petersen@oracle.com> | 2018-01-03 23:10:06 -0500 |
commit | ccd4a43035090c00611459a63f6cb31335decc9b (patch) | |
tree | 1d62d61bddfd5fa6e3124b197adb5fd9b6441980 /drivers/scsi/libiscsi.c | |
parent | f49d4aed1315a7b766d855f1367142e682b0cc87 (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/libiscsi.c')
-rw-r--r-- | drivers/scsi/libiscsi.c | 4 |
1 files changed, 3 insertions, 1 deletions
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 |