MIPS: ath25: clean up non-kernel-doc comment warning

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

Posted by Randy Dunlap 3 years, 7 months ago

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 <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: linux-mips@vger.kernel.org
Cc: Sergey Ryazanov <ryazanov.s.a@gmail.com>
---
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.

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

Posted by Thomas Bogendoerfer 3 years, 6 months ago

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 <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Aditya Srivastava <yashsri421@gmail.com>
> Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
> Cc: linux-mips@vger.kernel.org
> Cc: Sergey Ryazanov <ryazanov.s.a@gmail.com>
> ---
> 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 ]

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

Posted by Sergey Ryazanov 3 years, 7 months ago

On Tue, Aug 23, 2022 at 5:54 AM Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Aditya Srivastava <yashsri421@gmail.com>
> Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
> Cc: linux-mips@vger.kernel.org
> Cc: Sergey Ryazanov <ryazanov.s.a@gmail.com>
> ---
> Fixes: 3ed7a2a702dc ("MIPS: ath25: add AR2315 PCI host controller driver")
>   but backport is not needed.

Acked-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>

Randy, Bagas, which one of these patches should be applied:
* https://patchwork.kernel.org/project/linux-mips/patch/20220823030056.123709-1-bagasdotme@gmail.com/
* https://patchwork.kernel.org/project/linux-mips/patch/20220823025441.30708-1-rdunlap@infradead.org/

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

Posted by Bagas Sanjaya 3 years, 7 months ago

On 8/23/22 15:13, Sergey Ryazanov wrote:
> Acked-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>
> 
> Randy, Bagas, which one of these patches should be applied:
> * https://patchwork.kernel.org/project/linux-mips/patch/20220823030056.123709-1-bagasdotme@gmail.com/
> * https://patchwork.kernel.org/project/linux-mips/patch/20220823025441.30708-1-rdunlap@infradead.org/

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