linux-kernel - Re: [PATCH] mips: cavium-octeon: clean up kernel-doc in cvmx-interrupt-decodes.c

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]

Message-ID: <20210722100724.GA7340@alpha.franken.de>
Date:   Thu, 22 Jul 2021 12:07:24 +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>,
        David Daney <ddaney@...iumnetworks.com>,
        linux-mips@...r.kernel.org
Subject: Re: [PATCH] mips: cavium-octeon: clean up kernel-doc in
 cvmx-interrupt-decodes.c

On Mon, Jul 19, 2021 at 09:16:17PM -0700, Randy Dunlap wrote:
> Fix kernel-doc warnings reported by kernel test robot:
> 
> arch/mips/cavium-octeon/executive/cvmx-interrupt-decodes.c:49: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * __cvmx_interrupt_gmxx_rxx_int_en_enable enables all interrupt bits in cvmx_gmxx_rxx_int_en_t
>    arch/mips/cavium-octeon/executive/cvmx-interrupt-decodes.c:230: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * __cvmx_interrupt_pcsx_intx_en_reg_enable enables all interrupt bits in cvmx_pcsx_intx_en_reg_t
>    arch/mips/cavium-octeon/executive/cvmx-interrupt-decodes.c:271: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * __cvmx_interrupt_pcsxx_int_en_reg_enable enables all interrupt bits in cvmx_pcsxx_int_en_reg_t
>    arch/mips/cavium-octeon/executive/cvmx-interrupt-decodes.c:301: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * __cvmx_interrupt_spxx_int_msk_enable enables all interrupt bits in cvmx_spxx_int_msk_t
>    arch/mips/cavium-octeon/executive/cvmx-interrupt-decodes.c:340: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * __cvmx_interrupt_stxx_int_msk_enable enables all interrupt bits in cvmx_stxx_int_msk_t
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: Aditya Srivastava <yashsri421@...il.com>
> Cc: David Daney <ddaney@...iumnetworks.com>
> Cc: Thomas Bogendoerfer <tsbogend@...ha.franken.de>
> Cc: linux-mips@...r.kernel.org
> ---
> Thomas: There are also 2 warnings in cvmx-l2c.c but that file also says:
>  * This file is part of the OCTEON SDK
> 
> arch/mips/cavium-octeon/executive/cvmx-l2c.c:768: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Return log base 2 of the number of sets in the L2 cache
>    arch/mips/cavium-octeon/executive/cvmx-l2c.c:861: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Flush a line from the L2 cache
> 
> so does it make sense to send a patch for these 2 warnings also?

sure, I haven't seen SDK updates for years, so we are on are own anyway.

>  arch/mips/cavium-octeon/executive/cvmx-interrupt-decodes.c |   17 +++++++---
>  1 file changed, 12 insertions(+), 5 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 ]