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>, Hannes Reinecke <hare@suse.de>
Subject: [PATCH v2 04/29] scsi: fcoe: fcoe: Fix various kernel-doc infringements
Date: Mon, 13 Jul 2020 08:46:20 +0100	[thread overview]
Message-ID: <20200713074645.126138-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20200713074645.126138-1-lee.jones@linaro.org>

A couple of headers make no attempt to document their associated function
parameters.  Others looks as if they are suffering with a little bitrot.

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

 drivers/scsi/fcoe/fcoe.c:654: warning: Function parameter or member 'lport' not described in 'fcoe_netdev_features_change'
 drivers/scsi/fcoe/fcoe.c:654: warning: Function parameter or member 'netdev' not described in 'fcoe_netdev_features_change'
 drivers/scsi/fcoe/fcoe.c:2039: warning: Function parameter or member 'ctlr_dev' not described in 'fcoe_ctlr_mode'
 drivers/scsi/fcoe/fcoe.c:2039: warning: Excess function parameter 'cdev' description in 'fcoe_ctlr_mode'
 drivers/scsi/fcoe/fcoe.c:2144: warning: Function parameter or member 'fcoe' not described in 'fcoe_dcb_create'
 drivers/scsi/fcoe/fcoe.c:2144: warning: Excess function parameter 'netdev' description in 'fcoe_dcb_create'
 drivers/scsi/fcoe/fcoe.c:2144: warning: Excess function parameter 'port' description in 'fcoe_dcb_create'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'lport' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'did' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'fp' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'op' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'resp' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'arg' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'timeout' not described in 'fcoe_elsct_send'

Cc: Hannes Reinecke <hare@suse.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/scsi/fcoe/fcoe.c | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c
index cb41d166e0c0f..0f9274960dc6b 100644
--- a/drivers/scsi/fcoe/fcoe.c
+++ b/drivers/scsi/fcoe/fcoe.c
@@ -645,7 +645,7 @@ static int fcoe_lport_config(struct fc_lport *lport)
 	return 0;
 }
 
-/**
+/*
  * fcoe_netdev_features_change - Updates the lport's offload flags based
  * on the LLD netdev's FCoE feature flags
  */
@@ -2029,7 +2029,7 @@ static int fcoe_ctlr_enabled(struct fcoe_ctlr_device *cdev)
 
 /**
  * fcoe_ctlr_mode() - Switch FIP mode
- * @cdev: The FCoE Controller that is being modified
+ * @ctlr_dev: The FCoE Controller that is being modified
  *
  * When the FIP mode has been changed we need to update
  * the multicast addresses to ensure we get the correct
@@ -2136,9 +2136,7 @@ static bool fcoe_match(struct net_device *netdev)
 
 /**
  * fcoe_dcb_create() - Initialize DCB attributes and hooks
- * @netdev: The net_device object of the L2 link that should be queried
- * @port: The fcoe_port to bind FCoE APP priority with
- * @
+ * @fcoe:   The new FCoE interface
  */
 static void fcoe_dcb_create(struct fcoe_interface *fcoe)
 {
@@ -2609,7 +2607,7 @@ static void fcoe_logo_resp(struct fc_seq *seq, struct fc_frame *fp, void *arg)
 	fc_lport_logo_resp(seq, fp, lport);
 }
 
-/**
+/*
  * fcoe_elsct_send - FCoE specific ELS handler
  *
  * This does special case handling of FIP encapsualted ELS exchanges for FCoE,
-- 
2.25.1


  parent reply	other threads:[~2020-07-13  7:46 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 ` Lee Jones [this message]
2020-07-14  6:58   ` [PATCH v2 04/29] scsi: fcoe: fcoe: Fix various kernel-doc infringements 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 ` [PATCH v2 28/29] scsi: aacraid: aachba: Fix a bunch of function doc formatting errors Lee Jones
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-5-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 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.