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>, Hannes Reinecke <hare@suse.de>
Subject: [PATCH 12/30] scsi: libfc: fc_fcp: Provide missing and repair existing function documentation
Date: Wed, 8 Jul 2020 13:02:03 +0100 [thread overview]
Message-ID: <20200708120221.3386672-13-lee.jones@linaro.org> (raw)
In-Reply-To: <20200708120221.3386672-1-lee.jones@linaro.org>
Mostly due to descriptions not keeping up with API changes.
Fixes the following W=1 kernel build warning(s):
drivers/scsi/libfc/fc_fcp.c:299: warning: Function parameter or member 'status_code' not described in 'fc_fcp_retry_cmd'
drivers/scsi/libfc/fc_fcp.c:595: warning: Function parameter or member 'seq' not described in 'fc_fcp_send_data'
drivers/scsi/libfc/fc_fcp.c:595: warning: Excess function parameter 'sp' description in 'fc_fcp_send_data'
drivers/scsi/libfc/fc_fcp.c:1289: warning: Function parameter or member 't' not described in 'fc_lun_reset_send'
drivers/scsi/libfc/fc_fcp.c:1289: warning: Excess function parameter 'data' description in 'fc_lun_reset_send'
drivers/scsi/libfc/fc_fcp.c:1422: warning: Function parameter or member 't' not described in 'fc_fcp_timeout'
drivers/scsi/libfc/fc_fcp.c:1422: warning: Excess function parameter 'data' description in 'fc_fcp_timeout'
drivers/scsi/libfc/fc_fcp.c:1696: warning: Function parameter or member 'code' not described in 'fc_fcp_recovery'
drivers/scsi/libfc/fc_fcp.c:1716: warning: Function parameter or member 'offset' not described in 'fc_fcp_srr'
drivers/scsi/libfc/fc_fcp.c:1859: warning: Function parameter or member 'sc_cmd' not described in 'fc_queuecommand'
drivers/scsi/libfc/fc_fcp.c:1859: warning: Excess function parameter 'cmd' description in 'fc_queuecommand'
Cc: Hannes Reinecke <hare@suse.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/scsi/libfc/fc_fcp.c | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/drivers/scsi/libfc/fc_fcp.c b/drivers/scsi/libfc/fc_fcp.c
index bf2cc9656e191..d1ff2335f552b 100644
--- a/drivers/scsi/libfc/fc_fcp.c
+++ b/drivers/scsi/libfc/fc_fcp.c
@@ -289,6 +289,7 @@ static int fc_fcp_send_abort(struct fc_fcp_pkt *fsp)
/**
* fc_fcp_retry_cmd() - Retry a fcp_pkt
* @fsp: The FCP packet to be retried
+ * @status_code: The FCP status code to set
*
* Sets the status code to be FC_ERROR and then calls
* fc_fcp_complete_locked() which in turn calls fc_io_compl().
@@ -580,7 +581,7 @@ static void fc_fcp_recv_data(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
/**
* fc_fcp_send_data() - Send SCSI data to a target
* @fsp: The FCP packet the data is on
- * @sp: The sequence the data is to be sent on
+ * @seq: The sequence the data is to be sent on
* @offset: The starting offset for this data request
* @seq_blen: The burst length for this data request
*
@@ -1283,7 +1284,7 @@ static int fc_fcp_pkt_abort(struct fc_fcp_pkt *fsp)
/**
* fc_lun_reset_send() - Send LUN reset command
- * @data: The FCP packet that identifies the LUN to be reset
+ * @t: Timer context used to fectch the FSP packet
*/
static void fc_lun_reset_send(struct timer_list *t)
{
@@ -1409,7 +1410,7 @@ static void fc_fcp_cleanup(struct fc_lport *lport)
/**
* fc_fcp_timeout() - Handler for fcp_pkt timeouts
- * @data: The FCP packet that has timed out
+ * @t: Timer context used to fectch the FSP packet
*
* If REC is supported then just issue it and return. The REC exchange will
* complete or time out and recovery can continue at that point. Otherwise,
@@ -1691,6 +1692,7 @@ static void fc_fcp_rec_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
/**
* fc_fcp_recovery() - Handler for fcp_pkt recovery
* @fsp: The FCP pkt that needs to be aborted
+ * @code: The FCP status code to set
*/
static void fc_fcp_recovery(struct fc_fcp_pkt *fsp, u8 code)
{
@@ -1709,6 +1711,7 @@ static void fc_fcp_recovery(struct fc_fcp_pkt *fsp, u8 code)
* fc_fcp_srr() - Send a SRR request (Sequence Retransmission Request)
* @fsp: The FCP packet the SRR is to be sent on
* @r_ctl: The R_CTL field for the SRR request
+ * @offset: The SRR relative offset
* This is called after receiving status but insufficient data, or
* when expecting status but the request has timed out.
*/
@@ -1851,7 +1854,7 @@ static inline int fc_fcp_lport_queue_ready(struct fc_lport *lport)
/**
* fc_queuecommand() - The queuecommand function of the SCSI template
* @shost: The Scsi_Host that the command was issued to
- * @cmd: The scsi_cmnd to be executed
+ * @sc_cmd: The scsi_cmnd to be executed
*
* This is the i/o strategy routine, called by the SCSI layer.
*/
--
2.25.1
next prev parent reply other threads:[~2020-07-08 12:04 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-08 12:01 [PATCH 00/30] Fix a bunch more SCSI related W=1 warnings Lee Jones
2020-07-08 12:01 ` [PATCH 01/30] scsi: libfc: fc_exch: Supply some missing kerneldoc struct/function attributes/params Lee Jones
2020-07-08 12:01 ` [PATCH 02/30] include: scsi: scsi_transport_fc: Match HBA Attribute Length with HBAAPI V2.0 definitions Lee Jones
2020-07-08 12:01 ` [PATCH 03/30] scsi: libfc: fc_disc: trivial: Fix spelling mistake of 'discovery' Lee Jones
2020-07-08 12:04 ` Johannes Thumshirn
2020-07-08 12:12 ` Lee Jones
2020-07-08 12:14 ` Johannes Thumshirn
2020-07-08 12:01 ` [PATCH 04/30] scsi: fcoe: fcoe: Fix various kernel-doc infringements Lee Jones
2020-07-08 12:01 ` [PATCH 05/30] scsi: fcoe: fcoe_ctlr: Fix a myriad of documentation issues Lee Jones
2020-07-08 12:01 ` [PATCH 06/30] scsi: fcoe: fcoe_transport: Correct some kernel-doc issues Lee Jones
2020-07-08 12:01 ` [PATCH 07/30] scsi: bnx2fc: bnx2fc_fcoe: Repair a range of kerneldoc issues Lee Jones
2020-07-08 12:01 ` [PATCH 08/30] scsi: qedf: qedf_main: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-08 12:02 ` [PATCH 09/30] scsi: qedf: qedf_main: Remove set but not checked variable 'tmp' Lee Jones
2020-07-08 12:02 ` [PATCH 10/30] scsi: libfc: fc_lport: Repair function parameter documentation Lee Jones
2020-07-08 12:02 ` [PATCH 11/30] scsi: libfc: fc_rport: Fix a couple of misdocumented function parameters Lee Jones
2020-07-08 12:15 ` Johannes Thumshirn
2020-07-08 12:23 ` Lee Jones
2020-07-08 12:02 ` Lee Jones [this message]
2020-07-08 12:02 ` [PATCH 13/30] scsi: libfc: fc_rport: Fix bitrotted function parameter and copy/paste error Lee Jones
2020-07-08 12:17 ` Johannes Thumshirn
2020-07-08 12:24 ` Lee Jones
2020-07-08 12:25 ` Lee Jones
2020-07-08 12:02 ` [PATCH 14/30] scsi: bnx2fc: bnx2fc_hwi: Fix a couple of bitrotted function documentation headers Lee Jones
2020-07-08 12:02 ` [PATCH 15/30] scsi: arcmsr: arcmsr_hba: Remove some set but unused variables Lee Jones
2020-07-08 12:02 ` [PATCH 16/30] scsi: arcmsr: arcmsr_hba: Make room for the trailing NULL, even if it is over-written Lee Jones
2020-07-15 20:26 ` Martin K. Petersen
2020-07-16 7:59 ` Lee Jones
2020-07-08 12:02 ` [PATCH 17/30] scsi: qedf: qedf_io: Remove a whole host of unused variables Lee Jones
2020-07-08 12:02 ` [PATCH 18/30] scsi: bnx2fc: bnx2fc_tgt: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-08 12:02 ` [PATCH 19/30] scsi: aic7xxx: aic7xxx_osm: Remove unused variable 'tinfo' Lee Jones
2020-07-08 12:02 ` [PATCH 20/30] scsi: aic7xxx: aic7xxx_osm: Remove unused variable 'ahc' Lee Jones
2020-07-08 12:02 ` [PATCH 21/30] scsi: aic7xxx: aic7xxx_osm: Remove unused variable 'targ' Lee Jones
2020-07-08 12:02 ` [PATCH 22/30] scsi: aic7xxx: aic7xxx_osm: Fix 'amount_xferred' set but not used issue Lee Jones
2020-07-08 12:02 ` [PATCH 23/30] scsi: qedf: qedf_debugfs: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-08 12:02 ` [PATCH 24/30] scsi: aacraid: linit: Provide suggested curly braces around empty body of if() Lee Jones
2020-07-08 12:02 ` [PATCH 25/30] scsi: aacraid: linit: Fix a couple of small kerneldoc issues Lee Jones
2020-07-08 12:02 ` [PATCH 26/30] scsi: aic94xx: aic94xx_init: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-08 12:02 ` [PATCH 27/30] scsi: pm8001: pm8001_init: Demote obvious misuse of kerneldoc and update others Lee Jones
2020-07-08 12:17 ` Jinpu Wang
2020-07-08 12:02 ` [PATCH 28/30] scsi: aic94xx: aic94xx_hwi: Repair kerneldoc formatting error and remove extra param Lee Jones
2020-07-08 12:02 ` [PATCH 29/30] scsi: aacraid: aachba: Fix a bunch of function doc formatting errors Lee Jones
2020-07-08 12:02 ` [PATCH 30/30] scsi: qla4xxx: ql4_init: Provide a missing function param description and fix formatting Lee Jones
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=20200708120221.3386672-13-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=hare@suse.de \
--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).