All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: gregkh@linuxfoundation.org
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org,
	Lee Jones <lee.jones@linaro.org>,
	Alan Stern <stern@rowland.harvard.edu>,
	Nicolas Ferre <nicolas.ferre@microchip.com>,
	Alexandre Belloni <alexandre.belloni@bootlin.com>,
	Ludovic Desroches <ludovic.desroches@microchip.com>,
	Thibaut VARENE <varenet@parisc-linux.org>
Subject: [PATCH 20/30] usb: host: ohci-at91: Demote kerneldoc headers down to basic comment blocks
Date: Thu,  2 Jul 2020 15:46:15 +0100	[thread overview]
Message-ID: <20200702144625.2533530-21-lee.jones@linaro.org> (raw)
In-Reply-To: <20200702144625.2533530-1-lee.jones@linaro.org>

Neither usb_hcd_at91_probe() nor usb_hcd_at91_remove()'s function
headers reach the standards required of a kerneldoc entry.  Only
one attempt at describing an argument was made, as it is not
correct (we're removing that too to save confusion).

Fixes the following kernel build warning(s):

 drivers/usb/host/ohci-at91.c:166: warning: Function parameter or member 'driver' not described in 'usb_hcd_at91_probe'
 drivers/usb/host/ohci-at91.c:166: warning: Function parameter or member 'pdev' not described in 'usb_hcd_at91_probe'
 drivers/usb/host/ohci-at91.c:259: warning: Function parameter or member 'hcd' not described in 'usb_hcd_at91_remove'
 drivers/usb/host/ohci-at91.c:259: warning: Function parameter or member 'pdev' not described in 'usb_hcd_at91_remove'
 drivers/usb/host/ohci-at91.c:259: warning: Excess function parameter 'dev' description in 'usb_hcd_at91_remove'

Cc: Alan Stern <stern@rowland.harvard.edu>
Cc: Nicolas Ferre <nicolas.ferre@microchip.com>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: Ludovic Desroches <ludovic.desroches@microchip.com>
Cc: Thibaut VARENE <varenet@parisc-linux.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/usb/host/ohci-at91.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/usb/host/ohci-at91.c b/drivers/usb/host/ohci-at91.c
index b635c6a1b1a91..0487a4b0501ec 100644
--- a/drivers/usb/host/ohci-at91.c
+++ b/drivers/usb/host/ohci-at91.c
@@ -153,7 +153,7 @@ static struct regmap *at91_dt_syscon_sfr(void)
 /* always called with process context; sleeping is OK */
 
 
-/**
+/*
  * usb_hcd_at91_probe - initialize AT91-based HCDs
  * Context: !in_interrupt()
  *
@@ -244,9 +244,8 @@ static int usb_hcd_at91_probe(const struct hc_driver *driver,
 
 /* may be called with controller, bus, and devices active */
 
-/**
+/*
  * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
- * @dev: USB Host Controller being removed
  * Context: !in_interrupt()
  *
  * Reverses the effect of usb_hcd_at91_probe(), first invoking
-- 
2.25.1


WARNING: multiple messages have this Message-ID (diff)
From: Lee Jones <lee.jones@linaro.org>
To: gregkh@linuxfoundation.org
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>,
	Thibaut VARENE <varenet@parisc-linux.org>,
	linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org,
	Ludovic Desroches <ludovic.desroches@microchip.com>,
	Alan Stern <stern@rowland.harvard.edu>,
	Lee Jones <lee.jones@linaro.org>,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH 20/30] usb: host: ohci-at91: Demote kerneldoc headers down to basic comment blocks
Date: Thu,  2 Jul 2020 15:46:15 +0100	[thread overview]
Message-ID: <20200702144625.2533530-21-lee.jones@linaro.org> (raw)
In-Reply-To: <20200702144625.2533530-1-lee.jones@linaro.org>

Neither usb_hcd_at91_probe() nor usb_hcd_at91_remove()'s function
headers reach the standards required of a kerneldoc entry.  Only
one attempt at describing an argument was made, as it is not
correct (we're removing that too to save confusion).

Fixes the following kernel build warning(s):

 drivers/usb/host/ohci-at91.c:166: warning: Function parameter or member 'driver' not described in 'usb_hcd_at91_probe'
 drivers/usb/host/ohci-at91.c:166: warning: Function parameter or member 'pdev' not described in 'usb_hcd_at91_probe'
 drivers/usb/host/ohci-at91.c:259: warning: Function parameter or member 'hcd' not described in 'usb_hcd_at91_remove'
 drivers/usb/host/ohci-at91.c:259: warning: Function parameter or member 'pdev' not described in 'usb_hcd_at91_remove'
 drivers/usb/host/ohci-at91.c:259: warning: Excess function parameter 'dev' description in 'usb_hcd_at91_remove'

Cc: Alan Stern <stern@rowland.harvard.edu>
Cc: Nicolas Ferre <nicolas.ferre@microchip.com>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: Ludovic Desroches <ludovic.desroches@microchip.com>
Cc: Thibaut VARENE <varenet@parisc-linux.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/usb/host/ohci-at91.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/usb/host/ohci-at91.c b/drivers/usb/host/ohci-at91.c
index b635c6a1b1a91..0487a4b0501ec 100644
--- a/drivers/usb/host/ohci-at91.c
+++ b/drivers/usb/host/ohci-at91.c
@@ -153,7 +153,7 @@ static struct regmap *at91_dt_syscon_sfr(void)
 /* always called with process context; sleeping is OK */
 
 
-/**
+/*
  * usb_hcd_at91_probe - initialize AT91-based HCDs
  * Context: !in_interrupt()
  *
@@ -244,9 +244,8 @@ static int usb_hcd_at91_probe(const struct hc_driver *driver,
 
 /* may be called with controller, bus, and devices active */
 
-/**
+/*
  * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
- * @dev: USB Host Controller being removed
  * Context: !in_interrupt()
  *
  * Reverses the effect of usb_hcd_at91_probe(), first invoking
-- 
2.25.1


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2020-07-02 14:48 UTC|newest]

Thread overview: 95+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-02 14:45 [PATCH 00/30] Fix a bunch of W=1 issues in USB Lee Jones
2020-07-02 14:45 ` Lee Jones
2020-07-02 14:45 ` [PATCH 01/30] usb: phy: phy: Fix-up a whole bunch of formatting issues Lee Jones
2020-07-02 14:45   ` Lee Jones
2020-07-02 14:45 ` [PATCH 02/30] usb: host: pci-quirks: Demote function header from kerneldoc to comment block Lee Jones
2020-07-02 14:45   ` Lee Jones
2020-07-03 10:22   ` Mathias Nyman
2020-07-03 10:22     ` Mathias Nyman
2020-07-02 14:45 ` [PATCH 03/30] usb: common: debug: Demote comment blocks which are obviously not kerneldoc Lee Jones
2020-07-02 14:45   ` Lee Jones
2020-07-02 14:45 ` [PATCH 04/30] usb: common: usb-conn-gpio: Demote comment block which is clearly " Lee Jones
2020-07-02 14:45   ` Lee Jones
2020-07-02 14:46 ` [PATCH 05/30] usb: dwc3: drd: File headers are not doc headers Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 06/30] usb: dwc3: ulpi: " Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 07/30] usb: common: ulpi: Fix a few kerneldoc related issues Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 08/30] usb: dwc3: dwc3-omap: Do not read DMA status Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 09/30] usb: dwc2: gadget: Do not read GINTMSK2 Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 10/30] usb: dwc2: gadget: Remove assigned but never used 'maxsize' Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 11/30] usb: dwc2: gadget: Avoid pointless read of EP control register Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-03  7:29   ` Greg KH
2020-07-03  7:29     ` Greg KH
2020-07-03  7:38     ` Minas Harutyunyan
2020-07-03  7:38       ` Minas Harutyunyan
2020-07-03  7:43       ` Greg KH
2020-07-03  7:43         ` Greg KH
2020-07-03  8:35         ` Minas Harutyunyan
2020-07-03  8:35           ` Minas Harutyunyan
2020-07-03 17:16       ` Lee Jones
2020-07-03 17:16         ` Lee Jones
2020-07-04  6:04         ` Greg KH
2020-07-04  6:04           ` Greg KH
2020-07-02 14:46 ` [PATCH 12/30] usb: host: ehci-omap: Provide documentation for ehci_hcd_omap_probe()'s arg 'pdev' Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 13/30] usb: cdns3: core: Fix incorrect formatting and misspelled function arg docs Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 14/30] usb: cdns3: ep0: Fix a bunch of kerneldoc issues Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 15/30] usb: dwc3: dwc3-haps: Function headers are not suitable for kerneldoc Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 16/30] usb: mtu3: mtu3_trace: " Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-03  1:41   ` Chunfeng Yun
2020-07-03  1:41     ` Chunfeng Yun
2020-07-03  1:41     ` Chunfeng Yun
2020-07-02 14:46 ` [PATCH 17/30] usb: cdns3: gadget: Fix a bunch of kernel doc issues Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 18/30] usb: dwc3: dwc3-of-simple: Function headers are not good candidates for kerneldoc Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 19/30] usb: host: isp1362: Mark the many unused ISP1362_REG entries as __maybe_unused Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` Lee Jones [this message]
2020-07-02 14:46   ` [PATCH 20/30] usb: host: ohci-at91: Demote kerneldoc headers down to basic comment blocks Lee Jones
2020-07-02 14:46 ` [PATCH 21/30] usb: host: ohci: Mark cc_to_error as __maybe_unused Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 22/30] usb: cdns3: ep0: Move 'zlp' description to appropriate function header Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 23/30] usb: host: oxu210hp-hcd: Move declaration of 'qtd' into 'ifdef OXU_URB_TRACE' Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-03  7:36   ` Greg KH
2020-07-03  7:36     ` Greg KH
2020-07-02 14:46 ` [PATCH 24/30] usb: mtu3: mtu3_trace: Supply missing mtu3_debug.h include file Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-03  5:41   ` kernel test robot
2020-07-03  5:41     ` kernel test robot
2020-07-03  5:41     ` kernel test robot
2020-07-02 14:46 ` [PATCH 25/30] usb: mtu3: mtu3_core: Demote obvious misuse of kerneldoc to standard comment block Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 26/30] usb: c67x00: c67x00-ll-hpi: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 27/30] usb: class: cdc-wdm: Provide description for usb_cdc_wdm_register()'s manage_power arg Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-03  7:32   ` Greg KH
2020-07-03  7:32     ` Greg KH
2020-07-02 14:46 ` [PATCH 28/30] usb: c67x00: c67x00-hcd: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-03  7:34   ` Greg KH
2020-07-03  7:34     ` Greg KH
2020-07-02 14:46 ` [PATCH 29/30] usb: class: usbtmc: File headers are not good candidates for kerneldoc Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-02 14:46 ` [PATCH 30/30] usb: c67x00: c67x00-sched: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-02 14:46   ` Lee Jones
2020-07-03  7:37 ` [PATCH 00/30] Fix a bunch of W=1 issues in USB Greg KH
2020-07-03  7:37   ` Greg KH
2020-07-03 17:21   ` Lee Jones
2020-07-03 17:21     ` 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=20200702144625.2533530-21-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=alexandre.belloni@bootlin.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=ludovic.desroches@microchip.com \
    --cc=nicolas.ferre@microchip.com \
    --cc=stern@rowland.harvard.edu \
    --cc=varenet@parisc-linux.org \
    /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.