linux-kernel - Re: [PATCH] mips: pci: remove extraneous asterisk from top level comment of ar2315 PCI driver

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: <CAHNKnsRUJzRGJ+muGfYAW-5EM91_j9AK-WTeV9pBZeXjH6L_6g@mail.gmail.com>
Date:   Tue, 23 Aug 2022 11:06:08 +0300
From:   Sergey Ryazanov <ryazanov.s.a@...il.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     linux-doc@...r.kernel.org, linux-mips@...r.kernel.org,
        open list <linux-kernel@...r.kernel.org>,
        Thomas Bogendoerfer <tsbogend@...ha.franken.de>,
        Rikard Falkeborn <rikard.falkeborn@...il.com>,
        Ralf Baechle <ralf@...ux-mips.org>,
        Jonathan Corbet <corbet@....net>,
        Aditya Srivastava <yashsri421@...il.com>,
        kernel test robot <lkp@...el.com>, stable@...r.kernel.org
Subject: Re: [PATCH] mips: pci: remove extraneous asterisk from top level
 comment of ar2315 PCI driver

On Tue, Aug 23, 2022 at 6:01 AM Bagas Sanjaya <bagasdotme@...il.com> wrote:
>
> kernel test robot reported kernel-doc 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
>
> The warning above is caused by an extraneous asterisk on the top level
> (description) comment of pci-ar2315.c, for which the comment is confused as
> kernel-doc comment instead.
>
> Remove the asterisk.
>
> Link: https://lore.kernel.org/linux-doc/202208221854.8ASrzjKa-lkp@intel.com/
> Fixes: 3ed7a2a702dc0f ("MIPS: ath25: add AR2315 PCI host controller driver")
> Fixes: 3e58e839150db0 ("scripts: kernel-doc: add warning for comment not following kernel-doc syntax")
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: stable@...r.kernel.org # v5.15, v5.19
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

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