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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Mon, 12 Sep 2022 15:40:03 +0200
From:   Thomas Bogendoerfer <tsbogend@...ha.franken.de>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Aditya Srivastava <yashsri421@...il.com>,
        linux-mips@...r.kernel.org,
        Sergey Ryazanov <ryazanov.s.a@...il.com>
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 <rdunlap@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: Aditya Srivastava <yashsri421@...il.com>
> Cc: Thomas Bogendoerfer <tsbogend@...ha.franken.de>
> Cc: linux-mips@...r.kernel.org
> Cc: Sergey Ryazanov <ryazanov.s.a@...il.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 ]