[PATCH] pci: fix msi.c kernel-doc warnings

[PATCH] pci: fix msi.c kernel-doc warnings

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warnings in pci/msi.c:

..//drivers/pci/msi.c:623: warning: No description found for parameter 'affd'
..//drivers/pci/msi.c:623: warning: Excess function parameter 'affinity' description in 'msi_capability_init'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 drivers/pci/msi.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- lnx-410-rc1.orig/drivers/pci/msi.c
+++ lnx-410-rc1/drivers/pci/msi.c
@@ -610,7 +610,7 @@ static int msi_verify_entries(struct pci
  * msi_capability_init - configure device's MSI capability structure
  * @dev: pointer to the pci_dev data structure of MSI device function
  * @nvec: number of interrupts to allocate
- * @affinity: flag to indicate cpu irq affinity mask should be set
+ * @affd: description of automatic irq affinity assignments (may be %NULL)
  *
  * Setup the MSI capability structure of the device with the requested
  * number of interrupts.  A return value of zero indicates the successful

Re: [PATCH] pci: fix msi.c kernel-doc warnings

[Bjorn Helgaas]

On Wed, Dec 28, 2016 at 08:25:04AM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warnings in pci/msi.c:
> 
> ..//drivers/pci/msi.c:623: warning: No description found for parameter 'affd'
> ..//drivers/pci/msi.c:623: warning: Excess function parameter 'affinity' description in 'msi_capability_init'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Thanks, applied to pci/msi for v4.11 with this changelog:

    PCI/MSI: Fix msi_capability_init() kernel-doc warnings
    
    Fix kernel-doc warnings in pci/msi.c:
    
      ..//drivers/pci/msi.c:623: warning: No description found for parameter 'affd'
      ..//drivers/pci/msi.c:623: warning: Excess function parameter 'affinity' description in 'msi_capability_init'
    
    Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
    Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>

> ---
>  drivers/pci/msi.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- lnx-410-rc1.orig/drivers/pci/msi.c
> +++ lnx-410-rc1/drivers/pci/msi.c
> @@ -610,7 +610,7 @@ static int msi_verify_entries(struct pci
>   * msi_capability_init - configure device's MSI capability structure
>   * @dev: pointer to the pci_dev data structure of MSI device function
>   * @nvec: number of interrupts to allocate
> - * @affinity: flag to indicate cpu irq affinity mask should be set
> + * @affd: description of automatic irq affinity assignments (may be %NULL)
>   *
>   * Setup the MSI capability structure of the device with the requested
>   * number of interrupts.  A return value of zero indicates the successful
> --
> To unsubscribe from this list: send the line "unsubscribe linux-pci" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html