Re: [PATCH] MIPS: msi-octeon: eliminate kernel-doc warnings

[Thomas Bogendoerfer]

On Sat, Jul 23, 2022 at 10:57:23PM -0700, Randy Dunlap wrote:
> 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@xxxxxxxxx>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Aditya Srivastava <yashsri421@xxxxxxxxx>
> Cc: Thomas Bogendoerfer <tsbogend@xxxxxxxxxxxxxxxx>
> Cc: linux-mips@xxxxxxxxxxxxxxx
> ---
>  arch/mips/pci/msi-octeon.c |   16 +++++++++-------
>  1 file changed, 9 insertions(+), 7 deletions(-)

applied to mips-next.

Thomas.

-- 
Crap can work. Given enough thrust pigs will fly, but it's not necessarily a
good idea.                                                [ RFC1925, 2.3 ]