Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

MIPS: msi-octeon: eliminate kernel-doc warnings

Rearrange kernel-doc notation for 2 functions to eliminate
kernel-doc warnings. Use Return: notation for the function
return value description. Add function short descriptions
for both functions.
Correct 2 typos.

Fixes these kernel-doc warnings:

msi-octeon.c:49: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Called when a driver request MSI interrupts instead of the
msi-octeon.c:49: warning: missing initial short description on line:
* Called when a driver request MSI interrupts instead of the
msi-octeon.c:62: warning: No description found for return value of 'arch_setup_msi_irq'
msi-octeon.c:189: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Called when a device no longer needs its MSI interrupts. All
msi-octeon.c:189: warning: missing initial short description on line:
* Called when a device no longer needs its MSI interrupts. All

Fixes: e8635b484f64 ("MIPS: Add Cavium OCTEON PCI support.")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: linux-mips@vger.kernel.org
Signed-off-by: Thomas Bogendoerfer <tsbogend@alpha.franken.de>

authored by

Randy Dunlap and committed by
Thomas Bogendoerfer
d3cd4d9f b8295e44

+9 -7
+9 -7
arch/mips/pci/msi-octeon.c
··· 46 46 static int msi_irq_size; 47 47 48 48 /** 49 - * Called when a driver request MSI interrupts instead of the 49 + * arch_setup_msi_irq() - setup MSI IRQs for a device 50 + * @dev: Device requesting MSI interrupts 51 + * @desc: MSI descriptor 52 + * 53 + * Called when a driver requests MSI interrupts instead of the 50 54 * legacy INT A-D. This routine will allocate multiple interrupts 51 55 * for MSI devices that support them. A device can override this by 52 56 * programming the MSI control bits [6:4] before calling 53 57 * pci_enable_msi(). 54 58 * 55 - * @dev: Device requesting MSI interrupts 56 - * @desc: MSI descriptor 57 - * 58 - * Returns 0 on success. 59 + * Return: %0 on success, non-%0 on error. 59 60 */ 60 61 int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc) 61 62 { ··· 187 186 } 188 187 189 188 /** 189 + * arch_teardown_msi_irq() - release MSI IRQs for a device 190 + * @irq: The devices first irq number. There may be multiple in sequence. 191 + * 190 192 * Called when a device no longer needs its MSI interrupts. All 191 193 * MSI interrupts for the device are freed. 192 - * 193 - * @irq: The devices first irq number. There may be multple in sequence. 194 194 */ 195 195 void arch_teardown_msi_irq(unsigned int irq) 196 196 {