Linux-SCSI Archive on lore.kernel.org
 help / color / 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>,
	James Smart <james.smart@broadcom.com>,
	Dick Kennedy <dick.kennedy@broadcom.com>
Subject: [PATCH 02/40] scsi: lpfc: lpfc_hbadisc: Fix kerneldoc parameter formatting/misnaming/missing issues
Date: Thu, 23 Jul 2020 13:24:08 +0100
Message-ID: <20200723122446.1329773-3-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/lpfc/lpfc_hbadisc.c:1209: warning: Function parameter or member 'phba' not described in 'lpfc_sli4_clear_fcf_rr_bmask'
 drivers/scsi/lpfc/lpfc_hbadisc.c:1309: warning: Function parameter or member 'sw_name' not described in 'lpfc_sw_name_match'
 drivers/scsi/lpfc/lpfc_hbadisc.c:1309: warning: Excess function parameter 'fab_name' description in 'lpfc_sw_name_match'
 drivers/scsi/lpfc/lpfc_hbadisc.c:1397: warning: Function parameter or member 'fcf_rec' not described in 'lpfc_copy_fcf_record'
 drivers/scsi/lpfc/lpfc_hbadisc.c:1397: warning: Excess function parameter 'fcf' description in 'lpfc_copy_fcf_record'
 drivers/scsi/lpfc/lpfc_hbadisc.c:1956: warning: Cannot understand  lpfc_sli4_fcf_record_match - testing new FCF record for matching existing FCF
 on line 1956 - I thought it was a doc line
 drivers/scsi/lpfc/lpfc_hbadisc.c:2078: warning: Function parameter or member 'fcf_index' not described in 'lpfc_sli4_fcf_pri_list_del'
 drivers/scsi/lpfc/lpfc_hbadisc.c:2109: warning: Function parameter or member 'fcf_index' not described in 'lpfc_sli4_set_fcf_flogi_fail'
 drivers/scsi/lpfc/lpfc_hbadisc.c:2135: warning: Function parameter or member 'fcf_index' not described in 'lpfc_sli4_fcf_pri_list_add'
 drivers/scsi/lpfc/lpfc_hbadisc.c:2135: warning: Function parameter or member 'new_fcf_record' not described in 'lpfc_sli4_fcf_pri_list_add'

Cc: James Smart <james.smart@broadcom.com>
Cc: Dick Kennedy <dick.kennedy@broadcom.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/scsi/lpfc/lpfc_hbadisc.c | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/drivers/scsi/lpfc/lpfc_hbadisc.c b/drivers/scsi/lpfc/lpfc_hbadisc.c
index 1713349cec4f5..142a021144793 100644
--- a/drivers/scsi/lpfc/lpfc_hbadisc.c
+++ b/drivers/scsi/lpfc/lpfc_hbadisc.c
@@ -1198,7 +1198,7 @@ lpfc_mbx_cmpl_local_config_link(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb)
 
 /**
  * lpfc_sli4_clear_fcf_rr_bmask
- * @phba pointer to the struct lpfc_hba for this port.
+ * @phba: pointer to the struct lpfc_hba for this port.
  * This fucnction resets the round robin bit mask and clears the
  * fcf priority list. The list deletions are done while holding the
  * hbalock. The ON_LIST flag and the FLOGI_FAILED flags are cleared
@@ -1297,7 +1297,7 @@ lpfc_fab_name_match(uint8_t *fab_name, struct fcf_record *new_fcf_record)
 
 /**
  * lpfc_sw_name_match - Check if the fcf switch name match.
- * @fab_name: pointer to fabric name.
+ * @sw_name: pointer to switch name.
  * @new_fcf_record: pointer to fcf record.
  *
  * This routine compare the fcf record's switch name with provided
@@ -1385,7 +1385,7 @@ __lpfc_update_fcf_record_pri(struct lpfc_hba *phba, uint16_t fcf_index,
 
 /**
  * lpfc_copy_fcf_record - Copy fcf information to lpfc_hba.
- * @fcf: pointer to driver fcf record.
+ * @fcf_rec: pointer to driver fcf record.
  * @new_fcf_record: pointer to fcf record.
  *
  * This routine copies the FCF information from the FCF
@@ -1953,7 +1953,7 @@ lpfc_sli4_log_fcf_record_info(struct lpfc_hba *phba,
 }
 
 /**
- lpfc_sli4_fcf_record_match - testing new FCF record for matching existing FCF
+ * lpfc_sli4_fcf_record_match - testing new FCF record for matching existing FCF
  * @phba: pointer to lpfc hba data structure.
  * @fcf_rec: pointer to an existing FCF record.
  * @new_fcf_record: pointer to a new FCF record.
@@ -2067,7 +2067,7 @@ int lpfc_sli4_fcf_rr_next_proc(struct lpfc_vport *vport, uint16_t fcf_index)
 /**
  * lpfc_sli4_fcf_pri_list_del
  * @phba: pointer to lpfc hba data structure.
- * @fcf_index the index of the fcf record to delete
+ * @fcf_index: the index of the fcf record to delete
  * This routine checks the on list flag of the fcf_index to be deleted.
  * If it is one the list then it is removed from the list, and the flag
  * is cleared. This routine grab the hbalock before removing the fcf
@@ -2097,7 +2097,7 @@ static void lpfc_sli4_fcf_pri_list_del(struct lpfc_hba *phba,
 /**
  * lpfc_sli4_set_fcf_flogi_fail
  * @phba: pointer to lpfc hba data structure.
- * @fcf_index the index of the fcf record to update
+ * @fcf_index: the index of the fcf record to update
  * This routine acquires the hbalock and then set the LPFC_FCF_FLOGI_FAILED
  * flag so the the round robin slection for the particular priority level
  * will try a different fcf record that does not have this bit set.
@@ -2117,7 +2117,8 @@ lpfc_sli4_set_fcf_flogi_fail(struct lpfc_hba *phba, uint16_t fcf_index)
 /**
  * lpfc_sli4_fcf_pri_list_add
  * @phba: pointer to lpfc hba data structure.
- * @fcf_index the index of the fcf record to add
+ * @fcf_index: the index of the fcf record to add
+ * @new_fcf_record: pointer to a new FCF record.
  * This routine checks the priority of the fcf_index to be added.
  * If it is a lower priority than the current head of the fcf_pri list
  * then it is added to the list in the right order.
-- 
2.25.1


  parent reply index

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 ` Lee Jones [this message]
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 ` [PATCH 29/40] scsi: bnx2i: bnx2i_iscsi: Add, remove and edit some function parameter descriptions Lee Jones
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-3-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=dick.kennedy@broadcom.com \
    --cc=james.smart@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

Linux-SCSI Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-scsi/0 linux-scsi/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-scsi linux-scsi/ https://lore.kernel.org/linux-scsi \
		linux-scsi@vger.kernel.org
	public-inbox-index linux-scsi

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-scsi


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git