diff mbox series

misc: pci_endpoint_test: drop initial kernel-doc marker

Message ID 20230113063937.20912-1-rdunlap@infradead.org
State New
Headers
Series misc: pci_endpoint_test: drop initial kernel-doc marker |

Commit Message

Randy Dunlap Jan. 13, 2023, 6:39 a.m. UTC 
  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@infradead.org>
Cc: Lorenzo Pieralisi <lpieralisi@kernel.org>
Cc: Krzysztof Wilczyński <kw@linux.com>
Cc: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Cc: Kishon Vijay Abraham I <kishon@kernel.org>
Cc: linux-pci@vger.kernel.org
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 drivers/misc/pci_endpoint_test.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bjorn Helgaas Jan. 17, 2023, 8:23 p.m. UTC | #1 
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@infradead.org>
> Cc: Lorenzo Pieralisi <lpieralisi@kernel.org>
> Cc: Krzysztof Wilczyński <kw@linux.com>
> Cc: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> Cc: Kishon Vijay Abraham I <kishon@kernel.org>
> Cc: linux-pci@vger.kernel.org
> Cc: Arnd Bergmann <arnd@arndb.de>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.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
diff mbox series

Patch

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