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 02/24] scsi: aacraid: commctrl: Fix a few kerneldoc issues
Date: Mon, 13 Jul 2020 08:59:39 +0100	[thread overview]
Message-ID: <20200713080001.128044-3-lee.jones@linaro.org> (raw)
In-Reply-To: <20200713080001.128044-1-lee.jones@linaro.org>

Functions must follow imediately after the header documenting them and
all parameters must be present.

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

 drivers/scsi/aacraid/commctrl.c:43: warning: Excess function parameter 'dev' description in 'AAC_DEBUG_PREAMBLE'
 drivers/scsi/aacraid/commctrl.c:43: warning: Excess function parameter 'arg' description in 'AAC_DEBUG_PREAMBLE'
 drivers/scsi/aacraid/commctrl.c:167: warning: Function parameter or member 'dev' not described in 'open_getadapter_fib'
 drivers/scsi/aacraid/commctrl.c:167: warning: Function parameter or member 'arg' not described in 'open_getadapter_fib'
 drivers/scsi/aacraid/commctrl.c:458: warning: Cannot understand  *
 on line 458 - 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/commctrl.c | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/drivers/scsi/aacraid/commctrl.c b/drivers/scsi/aacraid/commctrl.c
index 34e65dea992e4..59e82a832042f 100644
--- a/drivers/scsi/aacraid/commctrl.c
+++ b/drivers/scsi/aacraid/commctrl.c
@@ -32,6 +32,8 @@
 
 #include "aacraid.h"
 
+# define AAC_DEBUG_PREAMBLE	KERN_INFO
+# define AAC_DEBUG_POSTAMBLE
 /**
  *	ioctl_send_fib	-	send a FIB from userspace
  *	@dev:	adapter is being processed
@@ -40,9 +42,6 @@
  *	This routine sends a fib to the adapter on behalf of a user level
  *	program.
  */
-# define AAC_DEBUG_PREAMBLE	KERN_INFO
-# define AAC_DEBUG_POSTAMBLE
-
 static int ioctl_send_fib(struct aac_dev * dev, void __user *arg)
 {
 	struct hw_fib * kfib;
@@ -158,11 +157,12 @@ static int ioctl_send_fib(struct aac_dev * dev, void __user *arg)
 
 /**
  *	open_getadapter_fib	-	Get the next fib
+ *	@dev:	adapter is being processed
+ *	@arg:	arguments to the open call
  *
  *	This routine will get the next Fib, if available, from the AdapterFibContext
  *	passed in from the user.
  */
-
 static int open_getadapter_fib(struct aac_dev * dev, void __user *arg)
 {
 	struct aac_fib_context * fibctx;
@@ -234,7 +234,6 @@ static int open_getadapter_fib(struct aac_dev * dev, void __user *arg)
  *	This routine will get the next Fib, if available, from the AdapterFibContext
  *	passed in from the user.
  */
-
 static int next_getadapter_fib(struct aac_dev * dev, void __user *arg)
 {
 	struct fib_ioctl f;
@@ -455,11 +454,10 @@ static int check_revision(struct aac_dev *dev, void __user *arg)
 
 
 /**
- *
  * aac_send_raw_scb
- *
+ *	@dev:	adapter is being processed
+ *	@arg:	arguments to the send call
  */
-
 static int aac_send_raw_srb(struct aac_dev* dev, void __user * arg)
 {
 	struct fib* srbfib;
-- 
2.25.1


  parent reply	other threads:[~2020-07-13  8:00 UTC|newest]

Thread overview: 48+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-13  7:59 [PATCH v2 00/24] Set 3: Fix another set of SCSI related W=1 warnings Lee Jones
2020-07-13  7:59 ` [PATCH v2 01/24] scsi: aacraid: aachba: Repair two kerneldoc headers Lee Jones
2020-07-13  7:59 ` Lee Jones [this message]
2020-07-13  7:59 ` [PATCH v2 03/24] scsi: aacraid: dpcsup: Fix logical bug when !DBG Lee Jones
2020-07-13  7:59 ` [PATCH v2 04/24] scsi: aacraid: dpcsup: Remove unused variable 'status' Lee Jones
2020-07-13  7:59 ` [PATCH v2 05/24] scsi: aacraid: dpcsup: Demote partially documented function header Lee Jones
2020-07-13  7:59 ` [PATCH v2 06/24] scsi: aic94xx: aic94xx_seq: Document 'lseq' and repair asd_update_port_links() header Lee Jones
2020-07-13  7:59 ` [PATCH v2 07/24] scsi: aacraid: commsup: Fix a bunch of function header issues Lee Jones
2020-07-13  7:59   ` Lee Jones
2020-07-13  7:59 ` [PATCH v2 08/24] scsi: aic94xx: aic94xx_scb: Fix a couple of formatting and bitrot issues Lee Jones
2020-07-13  7:59 ` [PATCH v2 09/24] scsi: aacraid: rx: Fill in the very parameter descriptions for rx_sync_cmd() Lee Jones
2020-07-13  7:59 ` [PATCH v2 10/24] scsi: pm8001: pm8001_ctl: Provide descriptions for the many undocumented 'attr's Lee Jones
2020-07-13  8:18   ` Jinpu Wang
2020-07-13  7:59 ` [PATCH v2 11/24] scsi: ipr: Fix a mountain of kerneldoc misdemeanours Lee Jones
2020-07-13  7:59 ` [PATCH v2 12/24] scsi: virtio_scsi: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-13  7:59   ` Lee Jones
2020-07-13 11:23   ` Michael S. Tsirkin
2020-07-13 11:23     ` Michael S. Tsirkin
2020-07-13 11:53     ` Lee Jones
2020-07-13  7:59 ` [PATCH v2 13/24] scsi: ipr: Remove a bunch of set but checked variables Lee Jones
2020-07-13  7:59 ` [PATCH v2 14/24] scsi: ipr: Fix struct packed-not-aligned issues Lee Jones
2020-07-13  7:59 ` [PATCH v2 15/24] scsi: myrs: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-14  7:45   ` Hannes Reinecke
2020-07-14  8:49     ` Lee Jones
2020-07-13  7:59 ` [PATCH v2 16/24] scsi: megaraid: Fix a whole bunch of function header formatting issues Lee Jones
2020-07-13  7:59 ` [PATCH v2 17/24] scsi: be2iscsi: be_iscsi: Fix API/documentation slip Lee Jones
2020-07-13  7:59 ` [PATCH v2 18/24] scsi: be2iscsi: be_main: Fix misdocumentation of 'pcontext' Lee Jones
2020-07-13  7:59 ` [PATCH v2 19/24] scsi: be2iscsi: be_mgmt: Add missing function parameter description Lee Jones
2020-07-13  7:59 ` [PATCH v2 20/24] scsi: lpfc: lpfc_nvme: Correct some pretty obvious misdocumentation Lee Jones
2020-07-13  7:59 ` [PATCH v2 21/24] scsi: aic7xxx: aic79xx_osm: Remove unused variable 'ahd' Lee Jones
2020-07-14  7:47   ` Hannes Reinecke
2020-07-13  7:59 ` [PATCH v2 22/24] scsi: aic7xxx: aic79xx_osm: Remove unused variables 'wait' and 'paused' Lee Jones
2020-07-14  7:47   ` Hannes Reinecke
2020-07-13  8:00 ` [PATCH v2 23/24] scsi: aic7xxx: aic79xx_osm: Fix 'amount_xferred' set but not used issue Lee Jones
2020-07-14  7:47   ` Hannes Reinecke
2020-07-13  8:00 ` [PATCH v2 24/24] scsi: aic7xxx: aic79xx_osm: Remove set but unused variabes 'saved_scsiid' and 'saved_modes' Lee Jones
2020-07-14  7:46   ` Hannes Reinecke
2020-07-14 15:43     ` James Bottomley
2020-07-14 21:39       ` Lee Jones
2020-07-14 23:03         ` James Bottomley
2020-07-15  6:29           ` Lee Jones
2020-07-21  6:38           ` Hannes Reinecke
2020-07-15  5:58         ` Hannes Reinecke
2020-07-15  6:30           ` Lee Jones
2020-07-15 22:14 ` [PATCH v2 00/24] Set 3: Fix another set of SCSI related W=1 warnings Martin K. Petersen
2020-07-16  7:14   ` Lee Jones
2020-07-16  7:16   ` Lee Jones
2020-07-16  8:00     ` 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=20200713080001.128044-3-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.