linux-scsi.vger.kernel.org archive mirror
 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 26/40] scsi: qla4xxx: ql4_os: Fix some kerneldoc parameter documentation issues
Date: Tue, 21 Jul 2020 17:41:34 +0100	[thread overview]
Message-ID: <20200721164148.2617584-27-lee.jones@linaro.org> (raw)
In-Reply-To: <20200721164148.2617584-1-lee.jones@linaro.org>

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

 drivers/scsi/qla4xxx/ql4_os.c:4551: warning: Function parameter or member 't' not described in 'qla4xxx_timer'
 drivers/scsi/qla4xxx/ql4_os.c:4551: warning: Excess function parameter 'ha' description in 'qla4xxx_timer'
 drivers/scsi/qla4xxx/ql4_os.c:5312: warning: Function parameter or member 'work' not described in 'qla4xxx_do_dpc'
 drivers/scsi/qla4xxx/ql4_os.c:5312: warning: Excess function parameter 'data' description in 'qla4xxx_do_dpc'
 drivers/scsi/qla4xxx/ql4_os.c:8627: warning: Function parameter or member 'ent' not described in 'qla4xxx_probe_adapter'
 drivers/scsi/qla4xxx/ql4_os.c:8627: warning: Excess function parameter 'pci_device_id' description in 'qla4xxx_probe_adapter'
 drivers/scsi/qla4xxx/ql4_os.c:9008: warning: Function parameter or member 'pdev' not described in 'qla4xxx_remove_adapter'
 drivers/scsi/qla4xxx/ql4_os.c:9008: warning: Excess function parameter 'pci_dev' description in 'qla4xxx_remove_adapter'
 drivers/scsi/qla4xxx/ql4_os.c:9181: warning: Function parameter or member 'stgt' not described in 'qla4xxx_eh_wait_for_commands'
 drivers/scsi/qla4xxx/ql4_os.c:9181: warning: Function parameter or member 'sdev' not described in 'qla4xxx_eh_wait_for_commands'
 drivers/scsi/qla4xxx/ql4_os.c:9181: warning: Excess function parameter 't' description in 'qla4xxx_eh_wait_for_commands'
 drivers/scsi/qla4xxx/ql4_os.c:9181: warning: Excess function parameter 'l' description in 'qla4xxx_eh_wait_for_commands'
 drivers/scsi/qla4xxx/ql4_os.c:9646: warning: Function parameter or member 'pdev' not described in 'qla4xxx_pci_mmio_enabled'

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

diff --git a/drivers/scsi/qla4xxx/ql4_os.c b/drivers/scsi/qla4xxx/ql4_os.c
index 2572f7aef8f88..bab87e47b238d 100644
--- a/drivers/scsi/qla4xxx/ql4_os.c
+++ b/drivers/scsi/qla4xxx/ql4_os.c
@@ -4545,7 +4545,7 @@ static void qla4xxx_check_relogin_flash_ddb(struct iscsi_cls_session *cls_sess)
 
 /**
  * qla4xxx_timer - checks every second for work to do.
- * @ha: Pointer to host adapter structure.
+ * @t: Context to obtain pointer to host adapter structure.
  **/
 static void qla4xxx_timer(struct timer_list *t)
 {
@@ -5299,7 +5299,7 @@ static void qla4xxx_do_work(struct scsi_qla_host *ha)
 
 /**
  * qla4xxx_do_dpc - dpc routine
- * @data: in our case pointer to adapter structure
+ * @work: Context to obtain pointer to host adapter structure.
  *
  * This routine is a task that is schedule by the interrupt handler
  * to perform the background processing for interrupts.  We put it
@@ -8616,7 +8616,7 @@ static void qla4xxx_wait_login_resp_boot_tgt(struct scsi_qla_host *ha)
 /**
  * qla4xxx_probe_adapter - callback function to probe HBA
  * @pdev: pointer to pci_dev structure
- * @pci_device_id: pointer to pci_device entry
+ * @ent: pointer to pci_device entry
  *
  * This routine will probe for Qlogic 4xxx iSCSI host adapters.
  * It returns zero if successful. It also initializes all data necessary for
@@ -9002,7 +9002,7 @@ static void qla4xxx_destroy_fw_ddb_session(struct scsi_qla_host *ha)
 }
 /**
  * qla4xxx_remove_adapter - callback function to remove adapter.
- * @pci_dev: PCI device pointer
+ * @pdev: PCI device pointer
  **/
 static void qla4xxx_remove_adapter(struct pci_dev *pdev)
 {
@@ -9169,8 +9169,8 @@ static int qla4xxx_wait_for_hba_online(struct scsi_qla_host *ha)
 /**
  * qla4xxx_eh_wait_for_commands - wait for active cmds to finish.
  * @ha: pointer to HBA
- * @t: target id
- * @l: lun id
+ * @stgt: pointer to SCSI target
+ * @sdev: pointer to SCSI device
  *
  * This function waits for all outstanding commands to a lun to complete. It
  * returns 0 if all pending commands are returned and 1 otherwise.
@@ -9640,6 +9640,7 @@ qla4xxx_pci_error_detected(struct pci_dev *pdev, pci_channel_state_t state)
  * qla4xxx_pci_mmio_enabled() gets called if
  * qla4xxx_pci_error_detected() returns PCI_ERS_RESULT_CAN_RECOVER
  * and read/write to the device still works.
+ * @pdev: PCI device pointer
  **/
 static pci_ers_result_t
 qla4xxx_pci_mmio_enabled(struct pci_dev *pdev)
-- 
2.25.1


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

Thread overview: 42+ 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 ` [PATCH 21/40] scsi: qla4xxx: ql4_mbx: Fix-up incorrectly documented parameter Lee Jones
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 ` [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 ` Lee Jones [this message]
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 ` [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 ` [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 ` [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-27-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 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).