2022-08-23 03:02:41

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] MIPS: ath25: clean up non-kernel-doc comment warning

Don't use "/**" kernel-doc notation for comments that are not in
kernel-doc format.

Eliminates one warning:

arch/mips/pci/pci-ar2315.c:6: warning: This comment starts with
'/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst
* Both AR2315 and AR2316 chips have PCI interface unit, which supports DMA

Signed-off-by: Randy Dunlap <[email protected]>
Reported-by: kernel test robot <[email protected]>
Cc: Aditya Srivastava <[email protected]>
Cc: Thomas Bogendoerfer <[email protected]>
Cc: [email protected]
Cc: Sergey Ryazanov <[email protected]>
---
Fixes: 3ed7a2a702dc ("MIPS: ath25: add AR2315 PCI host controller driver")
but backport is not needed.

arch/mips/pci/pci-ar2315.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

--- a/arch/mips/pci/pci-ar2315.c
+++ b/arch/mips/pci/pci-ar2315.c
@@ -2,7 +2,7 @@
/*
*/

-/**
+/*
* Both AR2315 and AR2316 chips have PCI interface unit, which supports DMA
* and interrupt. PCI interface supports MMIO access method, but does not
* seem to support I/O ports.


2022-08-23 09:06:51

by Sergey Ryazanov

[permalink] [raw]
Subject: Re: [PATCH] MIPS: ath25: clean up non-kernel-doc comment warning

On Tue, Aug 23, 2022 at 5:54 AM Randy Dunlap <[email protected]> wrote:
> Don't use "/**" kernel-doc notation for comments that are not in
> kernel-doc format.
>
> Eliminates one warning:
>
> arch/mips/pci/pci-ar2315.c:6: warning: This comment starts with
> '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> * Both AR2315 and AR2316 chips have PCI interface unit, which supports DMA
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Cc: Aditya Srivastava <[email protected]>
> Cc: Thomas Bogendoerfer <[email protected]>
> Cc: [email protected]
> Cc: Sergey Ryazanov <[email protected]>
> ---
> Fixes: 3ed7a2a702dc ("MIPS: ath25: add AR2315 PCI host controller driver")
> but backport is not needed.

Acked-by: Sergey Ryazanov <[email protected]>

Randy, Bagas, which one of these patches should be applied:
* https://patchwork.kernel.org/project/linux-mips/patch/[email protected]/
* https://patchwork.kernel.org/project/linux-mips/patch/[email protected]/

2022-08-23 09:52:37

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: [PATCH] MIPS: ath25: clean up non-kernel-doc comment warning

On 8/23/22 15:13, Sergey Ryazanov wrote:
> Acked-by: Sergey Ryazanov <[email protected]>
>
> Randy, Bagas, which one of these patches should be applied:
> * https://patchwork.kernel.org/project/linux-mips/patch/[email protected]/
> * https://patchwork.kernel.org/project/linux-mips/patch/[email protected]/

Hi Sergey, thanks for replying.

Oh, I don't see Randy's patch, since it wasn't CCed to linux-doc list.
I prefer to choose Randy's one, because the description wording is
clearer.

Thanks.

--
An old man doll... just what I always wanted! - Clara

2022-09-12 14:30:24

by Thomas Bogendoerfer

[permalink] [raw]
Subject: Re: [PATCH] MIPS: ath25: clean up non-kernel-doc comment warning

On Mon, Aug 22, 2022 at 07:54:41PM -0700, Randy Dunlap wrote:
> Don't use "/**" kernel-doc notation for comments that are not in
> kernel-doc format.
>
> Eliminates one warning:
>
> arch/mips/pci/pci-ar2315.c:6: warning: This comment starts with
> '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> * Both AR2315 and AR2316 chips have PCI interface unit, which supports DMA
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Cc: Aditya Srivastava <[email protected]>
> Cc: Thomas Bogendoerfer <[email protected]>
> Cc: [email protected]
> Cc: Sergey Ryazanov <[email protected]>
> ---
> Fixes: 3ed7a2a702dc ("MIPS: ath25: add AR2315 PCI host controller driver")
> but backport is not needed.
>
> arch/mips/pci/pci-ar2315.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- a/arch/mips/pci/pci-ar2315.c
> +++ b/arch/mips/pci/pci-ar2315.c
> @@ -2,7 +2,7 @@
> /*
> */
>
> -/**
> +/*
> * Both AR2315 and AR2316 chips have PCI interface unit, which supports DMA
> * and interrupt. PCI interface supports MMIO access method, but does not
> * seem to support I/O ports.

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 ]