All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: jejb@linux.ibm.com, martin.petersen@oracle.com
Cc: linux-kernel@vger.kernel.org, linux-scsi@vger.kernel.org,
	Lee Jones <lee.jones@linaro.org>,
	QLogic-Storage-Upstream@qlogic.com,
	Anil Veerabhadrappa <anilgv@broadcom.com>,
	Eddie Wai <eddie.wai@broadcom.com>
Subject: [PATCH 29/40] scsi: bnx2i: bnx2i_iscsi: Add, remove and edit some function parameter descriptions
Date: Thu, 23 Jul 2020 13:24:35 +0100	[thread overview]
Message-ID: <20200723122446.1329773-30-lee.jones@linaro.org> (raw)
In-Reply-To: <20200723122446.1329773-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/scsi/bnx2i/bnx2i_iscsi.c:241: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_bind_conn_to_iscsi_cid'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:241: warning: Excess function parameter 'conn' description in 'bnx2i_bind_conn_to_iscsi_cid'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:470: warning: Excess function parameter 'cmd' description in 'bnx2i_destroy_cmd_pool'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:595: warning: Function parameter or member 'cls_session' not described in 'bnx2i_drop_session'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:595: warning: Excess function parameter 'hba' description in 'bnx2i_drop_session'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:595: warning: Excess function parameter 'session' description in 'bnx2i_drop_session'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:1290: warning: Function parameter or member 'ep' not described in 'bnx2i_session_create'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:1979: warning: Function parameter or member 'bnx2i_ep' not described in 'bnx2i_ep_tcp_conn_active'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:1979: warning: Excess function parameter 'ep' description in 'bnx2i_ep_tcp_conn_active'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:2178: warning: Function parameter or member 'shost' not described in 'bnx2i_nl_set_path'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:2178: warning: Function parameter or member 'params' not described in 'bnx2i_nl_set_path'
 drivers/scsi/bnx2i/bnx2i_iscsi.c:2178: warning: Excess function parameter 'buf' description in 'bnx2i_nl_set_path'

Cc: QLogic-Storage-Upstream@qlogic.com
Cc: Anil Veerabhadrappa <anilgv@broadcom.com>
Cc: Eddie Wai <eddie.wai@broadcom.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/scsi/bnx2i/bnx2i_iscsi.c | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

diff --git a/drivers/scsi/bnx2i/bnx2i_iscsi.c b/drivers/scsi/bnx2i/bnx2i_iscsi.c
index 0b28d44d35738..a9ffd89ec2c85 100644
--- a/drivers/scsi/bnx2i/bnx2i_iscsi.c
+++ b/drivers/scsi/bnx2i/bnx2i_iscsi.c
@@ -228,7 +228,7 @@ static void bnx2i_setup_cmd_wqe_template(struct bnx2i_cmd *cmd)
 /**
  * bnx2i_bind_conn_to_iscsi_cid - bind conn structure to 'iscsi_cid'
  * @hba:	pointer to adapter instance
- * @conn:	pointer to iscsi connection
+ * @bnx2i_conn:	pointer to iscsi connection
  * @iscsi_cid:	iscsi context ID, range 0 - (MAX_CONN - 1)
  *
  * update iscsi cid table entry with connection pointer. This enables
@@ -463,7 +463,6 @@ static int bnx2i_alloc_bdt(struct bnx2i_hba *hba, struct iscsi_session *session,
  * bnx2i_destroy_cmd_pool - destroys iscsi command pool and release BD table
  * @hba:	adapter instance pointer
  * @session:	iscsi session pointer
- * @cmd:	iscsi command structure
  */
 static void bnx2i_destroy_cmd_pool(struct bnx2i_hba *hba,
 				   struct iscsi_session *session)
@@ -582,8 +581,7 @@ static void bnx2i_free_mp_bdt(struct bnx2i_hba *hba)
 
 /**
  * bnx2i_drop_session - notifies iscsid of connection error.
- * @hba:	adapter instance pointer
- * @session:	iscsi session pointer
+ * @cls_session:	iscsi cls session pointer
  *
  * This notifies iscsid that there is a error, so it can initiate
  * recovery.
@@ -1277,7 +1275,7 @@ static int bnx2i_task_xmit(struct iscsi_task *task)
 
 /**
  * bnx2i_session_create - create a new iscsi session
- * @cmds_max:		max commands supported
+ * @ep:		pointer to iscsi endpoint
  * @qdepth:		scsi queue depth to support
  * @initial_cmdsn:	initial iscsi CMDSN to be used for this session
  *
@@ -1971,7 +1969,7 @@ static int bnx2i_ep_poll(struct iscsi_endpoint *ep, int timeout_ms)
 
 /**
  * bnx2i_ep_tcp_conn_active - check EP state transition
- * @ep:		endpoint pointer
+ * @bnx2i_ep:		endpoint pointer
  *
  * check if underlying TCP connection is active
  */
@@ -2014,9 +2012,9 @@ static int bnx2i_ep_tcp_conn_active(struct bnx2i_endpoint *bnx2i_ep)
 }
 
 
-/*
+/**
  * bnx2i_hw_ep_disconnect - executes TCP connection teardown process in the hw
- * @ep:		TCP connection (bnx2i endpoint) handle
+ * @bnx2i_ep:		TCP connection (bnx2i endpoint) handle
  *
  * executes  TCP connection teardown process
  */
@@ -2171,8 +2169,8 @@ static void bnx2i_ep_disconnect(struct iscsi_endpoint *ep)
 
 /**
  * bnx2i_nl_set_path - ISCSI_UEVENT_PATH_UPDATE user message handler
+ * @shost:	scsi host pointer
  * @buf:	pointer to buffer containing iscsi path message
- *
  */
 static int bnx2i_nl_set_path(struct Scsi_Host *shost, struct iscsi_path *params)
 {
-- 
2.25.1


  parent reply	other threads:[~2020-07-23 12:26 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-23 12:24 [PATCH 00/40] Set 5: Penultimate set of SCSI related W=1 warnings Lee Jones
2020-07-23 12:24 ` [PATCH 01/40] scsi: lpfc: lpfc_els: Fix some function parameter descriptions Lee Jones
2020-07-23 12:24 ` [PATCH 02/40] scsi: lpfc: lpfc_hbadisc: Fix kerneldoc parameter formatting/misnaming/missing issues Lee Jones
2020-07-23 12:24 ` [PATCH 03/40] scsi: ufs: ufs-qcom: Demote nonconformant kerneldoc headers Lee Jones
2020-07-23 12:24 ` [PATCH 04/40] scsi: bnx2i: bnx2i_init: Fix parameter misnaming in function header Lee Jones
2020-07-23 12:24 ` [PATCH 05/40] scsi: ufs: ufs-exynos: Make stubs 'static inline' Lee Jones
2020-07-23 12:24 ` [PATCH 06/40] scsi: ufs: ufs-exynos: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-23 12:24 ` [PATCH 07/40] scsi: bfa: bfa_port: Staticify local functions Lee Jones
2020-07-23 12:24 ` [PATCH 08/40] scsi: bnx2i: bnx2i_sysfs: Add missing descriptions for 'attr' parameter Lee Jones
2020-07-23 12:24 ` [PATCH 09/40] scsi: bfa: bfa_fcpim: Remove set but unused variable 'rp' Lee Jones
2020-07-23 12:24 ` [PATCH 10/40] scsi: bfa: bfa_fcpim: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-23 12:24 ` [PATCH 11/40] scsi: qedi: qedi_main: Remove 2 set but unused variables Lee Jones
2020-07-23 12:24 ` [PATCH 12/40] scsi: ips: Remove some " Lee Jones
2020-07-23 12:24 ` [PATCH 13/40] scsi: ips: Convert strnlen() to memcpy() since result should not be NUL terminated Lee Jones
2020-07-23 12:24 ` [PATCH 14/40] scsi: qla4xxx: ql4_83xx: Remove set but unused variable 'status' Lee Jones
2020-07-23 12:24 ` [PATCH 15/40] scsi: lpfc: lpfc_init: Use __printf() format notation Lee Jones
2020-07-23 12:24 ` [PATCH 16/40] scsi: lpfc: lpfc_init: Add and rename a whole bunch of function parameter descriptions Lee Jones
2020-07-23 12:24 ` [PATCH 17/40] scsi: qla4xxx: ql4_bsg: Rename " Lee Jones
2020-07-23 12:24 ` [PATCH 18/40] scsi: lpfc: lpfc_mbox: Fix a bunch of kerneldoc misdemeanours Lee Jones
2020-07-23 12:24 ` [PATCH 19/40] scsi: lpfc: lpfc_nportdisc: Add description for lpfc_release_rpi()'s 'ndlpl param Lee Jones
2020-07-23 12:24 ` [PATCH 20/40] scsi: bfa: bfa_ioc: Remove a few unused variables 'pgoff' and 't' Lee Jones
2020-07-23 12:24 ` [PATCH 21/40] scsi: csiostor: csio_hw: Mark known unused variable as __always_unused Lee Jones
2020-07-23 12:24 ` [PATCH 22/40] scsi: csiostor: csio_hw_t5: Remove 2 unused variables {mc,edc}_bist_status_rdata_reg Lee Jones
2020-07-23 12:24 ` [PATCH 23/40] scsi: bfa: bfa_ioc: Staticify non-external functions Lee Jones
2020-07-23 12:24 ` [PATCH 24/40] scsi: csiostor: csio_rnode: Add missing description for csio_rnode_fwevt_handler()'s 'fwevt' param Lee Jones
2020-07-23 12:24 ` [PATCH 25/40] scsi: bfa: bfa_ioc_ct: Demote non-compliant kerneldoc headers to standard comments Lee Jones
2020-07-23 12:24 ` [PATCH 26/40] scsi: mvsas: mv_init: Place 'core_nr' inside correct clause Lee Jones
2020-07-23 12:24 ` [PATCH 27/40] scsi: bfa: bfa_fcs_rport: Remove unused variable 'adisc' Lee Jones
2020-07-23 12:24 ` [PATCH 28/40] scsi: bnx2i: bnx2i_hwi: Fix a whole host of kerneldoc issues Lee Jones
2020-07-23 12:24 ` Lee Jones [this message]
2020-07-23 12:24 ` [PATCH 30/40] scsi: be2iscsi: be_iscsi: Correct misdocumentation of function param 'ep' Lee Jones
2020-07-23 12:24 ` [PATCH 31/40] scsi: qedi: qedi_fw: Remove set but unused variable 'tmp' Lee Jones
2020-07-23 12:24 ` [PATCH 32/40] scsi: esas2r: esas2r: Add braces around the one-line if() Lee Jones
2020-07-23 12:24 ` [PATCH 33/40] scsi: bfa: bfa_ioc: Demote non-kerneldoc headers down to standard comment blocks Lee Jones
2020-07-23 12:24 ` [PATCH 34/40] scsi: bfa: bfa_core: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-23 12:24 ` [PATCH 35/40] scsi: bfa: bfa_svc: " Lee Jones
2020-07-23 12:24 ` [PATCH 36/40] scsi: qedi: qedi_main: " Lee Jones
2020-07-23 12:24 ` [PATCH 37/40] scsi: qedi: qedi_iscsi: Staticify non-external function 'qedi_get_iscsi_error' Lee Jones
2020-07-23 12:24 ` [PATCH 38/40] scsi: bfa: bfa_ioc: Ensure a blank line precedes next function/header Lee Jones
2020-07-23 12:24 ` [PATCH 39/40] scsi: bnx2i: bnx2i_iscsi: Add parameter description and rename another Lee Jones
2020-07-23 12:24 ` [PATCH 40/40] scsi: esas2r: esas2r_log: Demote a few non-conformant kerneldoc headers Lee Jones
2020-07-25  2:58 ` [PATCH 00/40] Set 5: Penultimate set of SCSI related W=1 warnings 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=20200723122446.1329773-30-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=QLogic-Storage-Upstream@qlogic.com \
    --cc=anilgv@broadcom.com \
    --cc=eddie.wai@broadcom.com \
    --cc=jejb@linux.ibm.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-scsi@vger.kernel.org \
    --cc=martin.petersen@oracle.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.