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
Subject: [PATCH 21/40] scsi: qla4xxx: ql4_mbx: Fix-up incorrectly documented parameter
Date: Tue, 21 Jul 2020 17:41:29 +0100	[thread overview]
Message-ID: <20200721164148.2617584-22-lee.jones@linaro.org> (raw)
In-Reply-To: <20200721164148.2617584-1-lee.jones@linaro.org>

Also demote incomplete header from kerneldoc.

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

from  drivers/scsi/qla4xxx/ql4_mbx.c:9:
 drivers/scsi/qla4xxx/ql4_mbx.c:53: warning: Excess function parameter 'ret' description in 'qla4xxx_is_intr_poll_mode'
 drivers/scsi/qla4xxx/ql4_mbx.c:832: warning: Function parameter or member 'fw_ddb_entry_dma' not described in 'qla4xxx_get_fwddb_entry'
 drivers/scsi/qla4xxx/ql4_mbx.c:832: warning: Function parameter or member 'conn_err_detail' not described in 'qla4xxx_get_fwddb_entry'
 drivers/scsi/qla4xxx/ql4_mbx.c:832: warning: Function parameter or member 'tcp_source_port_num' not described in 'qla4xxx_get_fwddb_entry'
 drivers/scsi/qla4xxx/ql4_mbx.c:832: warning: Function parameter or member 'connection_id' not described in 'qla4xxx_get_fwddb_entry'
 drivers/scsi/qla4xxx/ql4_mbx.c:1271: warning: Function parameter or member 'ddb_entry' not described in 'qla4xxx_reset_target'
 drivers/scsi/qla4xxx/ql4_mbx.c:1271: warning: Excess function parameter 'db_entry' description in 'qla4xxx_reset_target'
 drivers/scsi/qla4xxx/ql4_mbx.c:1271: warning: Excess function parameter 'un_entry' description in 'qla4xxx_reset_target'

Cc: QLogic-Storage-Upstream@qlogic.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/scsi/qla4xxx/ql4_mbx.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/scsi/qla4xxx/ql4_mbx.c b/drivers/scsi/qla4xxx/ql4_mbx.c
index 02636b4785c58..bc8de7d402d58 100644
--- a/drivers/scsi/qla4xxx/ql4_mbx.c
+++ b/drivers/scsi/qla4xxx/ql4_mbx.c
@@ -47,7 +47,7 @@ void qla4xxx_process_mbox_intr(struct scsi_qla_host *ha, int out_count)
 /**
  * qla4xxx_is_intr_poll_mode – Are we allowed to poll for interrupts?
  * @ha: Pointer to host adapter structure.
- * @ret: 1=polling mode, 0=non-polling mode
+ * returns: 1=polling mode, 0=non-polling mode
  **/
 static int qla4xxx_is_intr_poll_mode(struct scsi_qla_host *ha)
 {
@@ -810,7 +810,7 @@ int qla4xxx_get_firmware_status(struct scsi_qla_host * ha)
 	return QLA_SUCCESS;
 }
 
-/**
+/*
  * qla4xxx_get_fwddb_entry - retrieves firmware ddb entry
  * @ha: Pointer to host adapter structure.
  * @fw_ddb_index: Firmware's device database index
@@ -1259,8 +1259,7 @@ int qla4xxx_reset_lun(struct scsi_qla_host * ha, struct ddb_entry * ddb_entry,
 /**
  * qla4xxx_reset_target - issues target Reset
  * @ha: Pointer to host adapter structure.
- * @db_entry: Pointer to device database entry
- * @un_entry: Pointer to lun entry structure
+ * @ddb_entry: Pointer to device database entry
  *
  * This routine performs a TARGET RESET on the specified target.
  * The caller must ensure that the ddb_entry pointers
-- 
2.25.1


  parent reply	other threads:[~2020-07-21 16:44 UTC|newest]

Thread overview: 47+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-21 16:41 [PATCH 00/40] Set 4: Next set of SCSI related W=1 warnings Lee Jones
2020-07-21 16:41 ` [PATCH 01/40] scsi: arcmsr: arcmsr_hba: Remove statement with no effect Lee Jones
2020-07-21 16:41 ` [PATCH 02/40] scsi: aic7xxx: aic79xx_core: Remove a bunch of unused variables Lee Jones
2020-07-21 16:41 ` [PATCH 03/40] scsi: aacraid: sa: Add descriptions for missing parameters Lee Jones
2020-07-21 16:41 ` [PATCH 04/40] scsi: aacraid: rkt: Add missing description for 'dev' Lee Jones
2020-07-21 16:41 ` [PATCH 05/40] scsi: aacraid: nark: " Lee Jones
2020-07-21 16:41 ` [PATCH 06/40] scsi: aic94xx: aic94xx_dev: Fix a couple of kerneldoc formatting issues Lee Jones
2020-07-21 16:41 ` [PATCH 07/40] scsi: aacraid: src: Add descriptions for missing parameters Lee Jones
2020-07-21 16:41 ` [PATCH 08/40] scsi: aic94xx: aic94xx_tmf: Fix kerneldoc formatting issue with 'task' Lee Jones
2020-07-21 16:41 ` [PATCH 09/40] scsi: pm8001: pm8001_sas: Fix strncpy() warning Lee Jones
2020-07-21 16:41 ` [PATCH 10/40] scsi: pm8001: pm8001_sas: Mover function header and supply some missing parameter descriptions Lee Jones
2020-07-21 16:41 ` [PATCH 11/40] scsi: pm8001: pm8001_ctl: Add descriptions for unused 'attr' function parameters Lee Jones
2020-07-21 16:41 ` [PATCH 12/40] scsi: qla4xxx: ql4_init: Remove set but unused variable 'func_number' Lee Jones
2020-07-21 16:41 ` [PATCH 13/40] scsi: qla4xxx: ql4_init: Check return value of pci_set_mwi() Lee Jones
2020-07-21 16:41 ` [PATCH 14/40] scsi: qla4xxx: ql4_83xx: Move 'qla4_83xx_reg_tbl' from shared header Lee Jones
2020-07-21 16:41 ` [PATCH 15/40] scsi: aic7xxx: aic79xx_core: Remove set but unused variables 'targ_info' and 'value' Lee Jones
2020-07-21 16:41 ` [PATCH 16/40] scsi: pm8001: pm8001_hwi: Fix a bunch of kerneldoc issues Lee Jones
2020-07-21 16:41 ` [PATCH 17/40] scsi: pm8001: pm80xx_hwi: Fix some function documentation issues Lee Jones
2020-07-21 16:41 ` [PATCH 18/40] scsi: pm8001: pm8001_hwi: Remove a bunch of set but unused variables Lee Jones
2020-07-21 16:41 ` [PATCH 19/40] scsi: qla4xxx: ql4_nx: Move 'qla4_82xx_reg_tbl' to the only place its used Lee Jones
2020-07-21 16:41 ` [PATCH 20/40] scsi: lpfc: lpfc_sli: Remove unused variable 'pg_addr' Lee Jones
2020-07-21 16:41   ` Lee Jones
2020-07-21 16:41 ` Lee Jones [this message]
2020-07-21 16:41 ` [PATCH 22/40] scsi: qla4xxx: ql4_iocb: Fix incorrectly named function parameter Lee Jones
2020-07-21 16:41 ` [PATCH 23/40] scsi: lpfc: lpfc_sli: Fix-up around 120 documentation issues Lee Jones
2020-07-21 16:41   ` Lee Jones
2020-07-21 16:41 ` [PATCH 24/40] scsi: pm8001: pm8001_hwi: Remove unused variable 'value' Lee Jones
2020-07-21 16:41 ` [PATCH 25/40] scsi: pm8001: pm80xx_hwi: Staticify 'pm80xx_pci_mem_copy' and 'mpi_set_phy_profile_req' Lee Jones
2020-07-21 16:41 ` [PATCH 26/40] scsi: qla4xxx: ql4_os: Fix some kerneldoc parameter documentation issues Lee Jones
2020-07-21 16:41 ` [PATCH 27/40] scsi: qla4xxx: ql4_isr: Repair function documentation headers Lee Jones
2020-07-21 16:41 ` [PATCH 28/40] scsi: lpfc: lpfc_mem: Provide description for lpfc_mem_alloc()'s 'align' param Lee Jones
2020-07-21 16:41   ` Lee Jones
2020-07-21 16:41 ` [PATCH 29/40] scsi: qla4xxx: ql4_init: Document qla4xxx_process_ddb()'s 'conn_err' Lee Jones
2020-07-21 16:41 ` [PATCH 30/40] scsi: lpfc: lpfc_ct: Fix-up formatting/docrot where appropriate Lee Jones
2020-07-21 16:41 ` [PATCH 31/40] scsi: csiostor: csio_init: Fix misnamed function parameter Lee Jones
2020-07-21 16:41 ` [PATCH 32/40] scsi: qla4xxx: ql4_nx: Remove three set but unused variables Lee Jones
2020-07-21 16:41 ` [PATCH 33/40] scsi: qla4xxx: ql4_nx: Supply description for 'code' Lee Jones
2020-07-21 16:41 ` [PATCH 34/40] scsi: csiostor: csio_lnode: Demote kerneldoc that fails to meet the criteria Lee Jones
2020-07-21 16:41   ` Lee Jones
2020-07-21 16:41 ` [PATCH 35/40] scsi: bfa: bfad_bsg: Staticify all local functions Lee Jones
2020-07-21 16:41 ` [PATCH 36/40] scsi: lpfc: lpfc_sli: Ensure variable has the same stipulations as code using it Lee Jones
2020-07-21 16:41   ` Lee Jones
2020-07-21 16:41 ` [PATCH 37/40] scsi: sym53c8xx_2: sym_glue: Add missing description for 'pdev' Lee Jones
2020-07-21 16:41 ` [PATCH 38/40] scsi: sym53c8xx_2: sym_hipd: Ensure variable has the same stipulations as code using it Lee Jones
2020-07-21 16:41 ` [PATCH 39/40] scsi: mvsas: mv_init: Move 'core_nr' inside #ifdef and remove unused variable 'res_flag' Lee Jones
2020-07-21 16:41 ` [PATCH 40/40] scsi: cxgbi: cxgb3i: cxgb3i: Remove bad documentation and demote kerneldoc header Lee Jones
2020-07-25  2:56 ` [PATCH 00/40] Set 4: Next 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=20200721164148.2617584-22-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=QLogic-Storage-Upstream@qlogic.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.