Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <202208221854.8ASrzjKa-lkp@intel.com> <20220823030056.123709-1-bagasdotme@gmail.com>
In-Reply-To: <20220823030056.123709-1-bagasdotme@gmail.com>
From:   Sergey Ryazanov <ryazanov.s.a@gmail.com>
Date:   Tue, 23 Aug 2022 11:06:08 +0300
Message-ID: <CAHNKnsRUJzRGJ+muGfYAW-5EM91_j9AK-WTeV9pBZeXjH6L_6g@mail.gmail.com>
Subject: Re: [PATCH] mips: pci: remove extraneous asterisk from top level
 comment of ar2315 PCI driver
To:     Bagas Sanjaya <bagasdotme@gmail.com>
Cc:     linux-doc@vger.kernel.org, linux-mips@vger.kernel.org,
        open list <linux-kernel@vger.kernel.org>,
        Thomas Bogendoerfer <tsbogend@alpha.franken.de>,
        Rikard Falkeborn <rikard.falkeborn@gmail.com>,
        Ralf Baechle <ralf@linux-mips.org>,
        Jonathan Corbet <corbet@lwn.net>,
        Aditya Srivastava <yashsri421@gmail.com>,
        kernel test robot <lkp@intel.com>, stable@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Tue, Aug 23, 2022 at 6:01 AM Bagas Sanjaya <bagasdotme@gmail.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@intel.com>
> Cc: stable@vger.kernel.org # v5.15, v5.19
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

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