2014-02-03 03:02:28

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] pci: fix kernel-doc notation warning

From: Randy Dunlap <[email protected]>

Fix a "blank" kernel-doc line to have an asterisk instead of
being totally empty. This fixes the kernel-doc warning:

Warning(drivers/pci/msi.c:962): bad line:

Signed-off-by: Randy Dunlap <[email protected]>
---
drivers/pci/msi.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

--- lnx-314-rc1.orig/drivers/pci/msi.c
+++ lnx-314-rc1/drivers/pci/msi.c
@@ -959,7 +959,7 @@ EXPORT_SYMBOL(pci_disable_msi);
/**
* pci_msix_vec_count - return the number of device's MSI-X table entries
* @dev: pointer to the pci_dev data structure of MSI-X device function
-
+ *
* This function returns the number of device's MSI-X table entries and
* therefore the number of MSI-X vectors device is capable of sending.
* It returns a negative errno if the device is not capable of sending MSI-X


2014-02-12 00:43:19

by Bjorn Helgaas

[permalink] [raw]
Subject: Re: [PATCH] pci: fix kernel-doc notation warning

On Sun, Feb 02, 2014 at 07:02:24PM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <[email protected]>
>
> Fix a "blank" kernel-doc line to have an asterisk instead of
> being totally empty. This fixes the kernel-doc warning:
>
> Warning(drivers/pci/msi.c:962): bad line:
>
> Signed-off-by: Randy Dunlap <[email protected]>

I applied this fix already (but it's not in -next yet):

http://git.kernel.org/cgit/linux/kernel/git/helgaas/pci.git/commit/?h=pci/msi&id=39af663b5fd25c9dd427e12e106763b6b4f9572c

Thanks!

Bjorn

> ---
> drivers/pci/msi.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- lnx-314-rc1.orig/drivers/pci/msi.c
> +++ lnx-314-rc1/drivers/pci/msi.c
> @@ -959,7 +959,7 @@ EXPORT_SYMBOL(pci_disable_msi);
> /**
> * pci_msix_vec_count - return the number of device's MSI-X table entries
> * @dev: pointer to the pci_dev data structure of MSI-X device function
> -
> + *
> * This function returns the number of device's MSI-X table entries and
> * therefore the number of MSI-X vectors device is capable of sending.
> * It returns a negative errno if the device is not capable of sending MSI-X