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>,
	Adaptec OEM Raid Solutions <aacraid@microsemi.com>,
	"PMC-Sierra, Inc" <aacraid@pmc-sierra.com>
Subject: [PATCH v2 28/29] scsi: aacraid: aachba: Fix a bunch of function doc formatting errors
Date: Mon, 13 Jul 2020 08:46:44 +0100	[thread overview]
Message-ID: <20200713074645.126138-29-lee.jones@linaro.org> (raw)
In-Reply-To: <20200713074645.126138-1-lee.jones@linaro.org>

And a few missing/excessive parameter descriptions.

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

 drivers/scsi/aacraid/aachba.c:358: warning: Function parameter or member 'dev' not described in 'aac_get_config_status'
 drivers/scsi/aacraid/aachba.c:358: warning: Function parameter or member 'commit_flag' not described in 'aac_get_config_status'
 drivers/scsi/aacraid/aachba.c:358: warning: Excess function parameter 'common' description in 'aac_get_config_status'
 drivers/scsi/aacraid/aachba.c:450: warning: Function parameter or member 'dev' not described in 'aac_get_containers'
 drivers/scsi/aacraid/aachba.c:450: warning: Excess function parameter 'common' description in 'aac_get_containers'
 drivers/scsi/aacraid/aachba.c:568: warning: Function parameter or member 'scsicmd' not described in 'aac_get_container_name'
 drivers/scsi/aacraid/aachba.c:796: warning: Function parameter or member 'scsicmd' not described in 'aac_probe_container_callback1'
 drivers/scsi/aacraid/aachba.c:796: warning: Excess function parameter 'dev' description in 'aac_probe_container_callback1'
 drivers/scsi/aacraid/aachba.c:796: warning: Excess function parameter 'cid' description in 'aac_probe_container_callback1'
 drivers/scsi/aacraid/aachba.c:1105: warning: Function parameter or member 'scsicmd' not described in 'aac_get_container_serial'
 drivers/scsi/aacraid/aachba.c:1961: warning: Excess function parameter 'phys_luns' description in 'aac_set_safw_attr_all_targets'
 drivers/scsi/aacraid/aachba.c:1961: warning: Excess function parameter 'rescan' description in 'aac_set_safw_attr_all_targets'
 drivers/scsi/aacraid/aachba.c:3394: warning: Cannot understand  *
 on line 3394 - I thought it was a doc line
 drivers/scsi/aacraid/aachba.c:3687: warning: Cannot understand  *
 on line 3687 - I thought it was a doc line
 drivers/scsi/aacraid/aachba.c:3752: warning: Cannot understand  *
 on line 3752 - I thought it was a doc line
 drivers/scsi/aacraid/aachba.c:3795: warning: Cannot understand  *
 on line 3795 - I thought it was a doc line

Cc: Adaptec OEM Raid Solutions <aacraid@microsemi.com>
Cc: "PMC-Sierra, Inc" <aacraid@pmc-sierra.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/scsi/aacraid/aachba.c | 17 +++--------------
 1 file changed, 3 insertions(+), 14 deletions(-)

diff --git a/drivers/scsi/aacraid/aachba.c b/drivers/scsi/aacraid/aachba.c
index 2b868f8db8ffe..7ae1e545a255c 100644
--- a/drivers/scsi/aacraid/aachba.c
+++ b/drivers/scsi/aacraid/aachba.c
@@ -561,7 +561,7 @@ static void get_container_name_callback(void *context, struct fib * fibptr)
 	scsicmd->scsi_done(scsicmd);
 }
 
-/**
+/*
  *	aac_get_container_name	-	get container name, none blocking.
  */
 static int aac_get_container_name(struct scsi_cmnd * scsicmd)
@@ -786,8 +786,7 @@ static int _aac_probe_container(struct scsi_cmnd * scsicmd, int (*callback)(stru
 
 /**
  *	aac_probe_container		-	query a logical volume
- *	@dev: device to query
- *	@cid: container identifier
+ * @scsicmd: the scsi command block
  *
  *	Queries the controller about the given volume. The volume information
  *	is updated in the struct fsa_dev_info structure rather than returned.
@@ -1098,7 +1097,7 @@ static void get_container_serial_callback(void *context, struct fib * fibptr)
 	scsicmd->scsi_done(scsicmd);
 }
 
-/**
+/*
  *	aac_get_container_serial - get container serial, none blocking.
  */
 static int aac_get_container_serial(struct scsi_cmnd * scsicmd)
@@ -1952,8 +1951,6 @@ static int aac_get_safw_attr_all_targets(struct aac_dev *dev)
 /**
  *	aac_set_safw_attr_all_targets-	update current hba map with data from FW
  *	@dev:	aac_dev structure
- *	@phys_luns: FW information from report phys luns
- *	@rescan: Indicates scan type
  *
  *	Update our hba map with the information gathered from the FW
  */
@@ -3391,15 +3388,12 @@ int aac_dev_ioctl(struct aac_dev *dev, unsigned int cmd, void __user *arg)
 }
 
 /**
- *
  * aac_srb_callback
  * @context: the context set in the fib - here it is scsi cmd
  * @fibptr: pointer to the fib
  *
  * Handles the completion of a scsi command to a non dasd device
- *
  */
-
 static void aac_srb_callback(void *context, struct fib * fibptr)
 {
 	struct aac_srb_reply *srbreply;
@@ -3684,13 +3678,11 @@ static void hba_resp_task_failure(struct aac_dev *dev,
 }
 
 /**
- *
  * aac_hba_callback
  * @context: the context set in the fib - here it is scsi cmd
  * @fibptr: pointer to the fib
  *
  * Handles the completion of a native HBA scsi command
- *
  */
 void aac_hba_callback(void *context, struct fib *fibptr)
 {
@@ -3749,14 +3741,12 @@ void aac_hba_callback(void *context, struct fib *fibptr)
 }
 
 /**
- *
  * aac_send_srb_fib
  * @scsicmd: the scsi command block
  *
  * This routine will form a FIB and fill in the aac_srb from the
  * scsicmd passed in.
  */
-
 static int aac_send_srb_fib(struct scsi_cmnd* scsicmd)
 {
 	struct fib* cmd_fibcontext;
@@ -3792,7 +3782,6 @@ static int aac_send_srb_fib(struct scsi_cmnd* scsicmd)
 }
 
 /**
- *
  * aac_send_hba_fib
  * @scsicmd: the scsi command block
  *
-- 
2.25.1


  parent reply	other threads:[~2020-07-13  7:47 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-13  7:46 [PATCH v2 00/29] Fix a bunch more SCSI related W=1 warnings Lee Jones
2020-07-13  7:46 ` [PATCH v2 01/29] scsi: libfc: fc_exch: Supply some missing kerneldoc struct/function attributes/params Lee Jones
2020-07-14  6:47   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 02/29] include: scsi: scsi_transport_fc: Match HBA Attribute Length with HBAAPI V2.0 definitions Lee Jones
2020-07-14  6:49   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 03/29] scsi: libfc: fc_disc: trivial: Fix spelling mistake of 'discovery' Lee Jones
2020-07-14  6:50   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 04/29] scsi: fcoe: fcoe: Fix various kernel-doc infringements Lee Jones
2020-07-14  6:58   ` Hannes Reinecke
2020-07-14  7:58     ` Lee Jones
2020-07-14  8:14       ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 05/29] scsi: fcoe: fcoe_ctlr: Fix a myriad of documentation issues Lee Jones
2020-07-14  7:00   ` Hannes Reinecke
2020-07-14  7:53     ` Lee Jones
2020-07-14 14:08   ` Martin K. Petersen
2020-07-14 14:23     ` Lee Jones
2020-07-14 16:50       ` Martin K. Petersen
2020-07-14 15:07   ` [PATCH v2.1 " Lee Jones
2020-07-14 15:15     ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 06/29] scsi: fcoe: fcoe_transport: Correct some kernel-doc issues Lee Jones
2020-07-14  7:01   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 07/29] scsi: bnx2fc: bnx2fc_fcoe: Repair a range of kerneldoc issues Lee Jones
2020-07-13  7:46 ` [PATCH v2 08/29] scsi: qedf: qedf_main: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-13  7:46 ` [PATCH v2 09/29] scsi: qedf: qedf_main: Remove set but not checked variable 'tmp' Lee Jones
2020-07-13  7:46 ` [PATCH v2 10/29] scsi: libfc: fc_lport: Repair function parameter documentation Lee Jones
2020-07-14  7:04   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 11/29] scsi: libfc: fc_rport: Fix a couple of misdocumented function parameters Lee Jones
2020-07-14  7:04   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 12/29] scsi: libfc: fc_fcp: Provide missing and repair existing function documentation Lee Jones
2020-07-14  7:05   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 13/29] scsi: bnx2fc: bnx2fc_hwi: Fix a couple of bitrotted function documentation headers Lee Jones
2020-07-13  7:46 ` [PATCH v2 14/29] scsi: arcmsr: arcmsr_hba: Remove some set but unused variables Lee Jones
2020-07-13  7:46 ` [PATCH v2 15/29] scsi: arcmsr: arcmsr_hba: Make room for the trailing NULL, even if it is over-written Lee Jones
2020-07-13  7:46 ` [PATCH v2 16/29] scsi: qedf: qedf_io: Remove a whole host of unused variables Lee Jones
2020-07-13  7:46 ` [PATCH v2 17/29] scsi: bnx2fc: bnx2fc_tgt: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-13  7:46 ` [PATCH v2 18/29] scsi: aic7xxx: aic7xxx_osm: Remove unused variable 'tinfo' Lee Jones
2020-07-14 16:24   ` Doug Ledford
2020-07-14 21:08     ` Lee Jones
2020-07-13  7:46 ` [PATCH v2 19/29] scsi: aic7xxx: aic7xxx_osm: Remove unused variable 'ahc' Lee Jones
2020-07-14  7:07   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 20/29] scsi: aic7xxx: aic7xxx_osm: Remove unused variable 'targ' Lee Jones
2020-07-14  7:07   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 21/29] scsi: aic7xxx: aic7xxx_osm: Fix 'amount_xferred' set but not used issue Lee Jones
2020-07-14  7:08   ` Hannes Reinecke
2020-07-13  7:46 ` [PATCH v2 22/29] scsi: qedf: qedf_debugfs: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-13  7:46 ` [PATCH v2 23/29] scsi: aacraid: linit: Provide suggested curly braces around empty body of if() Lee Jones
2020-07-13  7:46 ` [PATCH v2 24/29] scsi: aacraid: linit: Fix a couple of small kerneldoc issues Lee Jones
2020-07-13  7:46 ` [PATCH v2 25/29] scsi: aic94xx: aic94xx_init: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-13  7:46 ` [PATCH v2 26/29] scsi: pm8001: pm8001_init: Demote obvious misuse of kerneldoc and update others Lee Jones
2020-07-13  7:46 ` [PATCH v2 27/29] scsi: aic94xx: aic94xx_hwi: Repair kerneldoc formatting error and remove extra param Lee Jones
2020-07-13  7:46 ` Lee Jones [this message]
2020-07-13  7:46 ` [PATCH v2 29/29] scsi: qla4xxx: ql4_init: Provide a missing function param description and fix formatting Lee Jones
2020-07-15 22:14 ` [PATCH v2 00/29] Fix a bunch more 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=20200713074645.126138-29-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=aacraid@microsemi.com \
    --cc=aacraid@pmc-sierra.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.