diff mbox series

pci: fix pci.c kernel-doc parameter warning

Message ID 1fe6f0c6-7ebb-7ddd-af91-659afad2d7da@infradead.org (mailing list archive)
State New, archived
Delegated to: Bjorn Helgaas
Headers show
Series pci: fix pci.c kernel-doc parameter warning | expand

Commit Message

Randy Dunlap Sept. 3, 2018, 2:32 a.m. UTC
From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning:

../drivers/pci/pci.c:218: warning: Excess function parameter 'p' description in 'pci_dev_str_match_path'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Bjorn Helgaas <bhelgaas@google.com>
Cc: linux-pci@vger.kernel.org
---
 drivers/pci/pci.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bjorn Helgaas Sept. 6, 2018, 7:08 p.m. UTC | #1
On Sun, Sep 02, 2018 at 07:32:50PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warning:
> 
> ../drivers/pci/pci.c:218: warning: Excess function parameter 'p' description in 'pci_dev_str_match_path'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Bjorn Helgaas <bhelgaas@google.com>
> Cc: linux-pci@vger.kernel.org

Applied to pci/misc for v4.20, thanks!

> ---
>  drivers/pci/pci.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- lnx-419-rc2.orig/drivers/pci/pci.c
> +++ lnx-419-rc2/drivers/pci/pci.c
> @@ -196,7 +196,7 @@ EXPORT_SYMBOL_GPL(pci_ioremap_wc_bar);
>  /**
>   * pci_dev_str_match_path - test if a path string matches a device
>   * @dev:    the PCI device to test
> - * @p:      string to match the device against
> + * @path:   string to match the device against
>   * @endptr: pointer to the string after the match
>   *
>   * Test if a string (typically from a kernel parameter) formatted as a
>
diff mbox series

Patch

--- lnx-419-rc2.orig/drivers/pci/pci.c
+++ lnx-419-rc2/drivers/pci/pci.c
@@ -196,7 +196,7 @@  EXPORT_SYMBOL_GPL(pci_ioremap_wc_bar);
 /**
  * pci_dev_str_match_path - test if a path string matches a device
  * @dev:    the PCI device to test
- * @p:      string to match the device against
+ * @path:   string to match the device against
  * @endptr: pointer to the string after the match
  *
  * Test if a string (typically from a kernel parameter) formatted as a