linux-kernel - Re: [PATCH] misc: pci_endpoint_test: drop initial kernel-doc marker

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: <20230117202332.GA144641@bhelgaas>
Date:   Tue, 17 Jan 2023 14:23:32 -0600
From:   Bjorn Helgaas <helgaas@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        Lorenzo Pieralisi <lpieralisi@...nel.org>,
        Krzysztof Wilczyński <kw@...ux.com>,
        Manivannan Sadhasivam <manivannan.sadhasivam@...aro.org>,
        Kishon Vijay Abraham I <kishon@...nel.org>,
        linux-pci@...r.kernel.org, Arnd Bergmann <arnd@...db.de>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Subject: Re: [PATCH] misc: pci_endpoint_test: drop initial kernel-doc marker

On Thu, Jan 12, 2023 at 10:39:37PM -0800, Randy Dunlap wrote:
> This beginning comment is not kernel-doc, so change the "/**" to a
> normal "/*" comment to prevent a kernel-doc warning:
> 
> drivers/misc/pci_endpoint_test.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Host side test driver to test endpoint functionality
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Lorenzo Pieralisi <lpieralisi@...nel.org>
> Cc: Krzysztof Wilczyński <kw@...ux.com>
> Cc: Manivannan Sadhasivam <manivannan.sadhasivam@...aro.org>
> Cc: Kishon Vijay Abraham I <kishon@...nel.org>
> Cc: linux-pci@...r.kernel.org
> Cc: Arnd Bergmann <arnd@...db.de>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>

Applied to pci/misc for v6.3, thanks!

> ---
>  drivers/misc/pci_endpoint_test.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff -- a/drivers/misc/pci_endpoint_test.c b/drivers/misc/pci_endpoint_test.c
> --- a/drivers/misc/pci_endpoint_test.c
> +++ b/drivers/misc/pci_endpoint_test.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Host side test driver to test endpoint functionality
>   *
>   * Copyright (C) 2017 Texas Instruments