2023-12-06 03:05:38

by Randy Dunlap

Subject: [PATCH] gpio: max730x: don't use kernel-doc marker for regular comment

Use a common C comment (/*) instead of kernel-doc notation to prevent
warnings from scripts/kernel-doc.

gpio-max730x.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
gpio-max730x.c:3: warning: missing initial short description on line:
* Copyright (C) 2006 Juergen Beisert, Pengutronix

Signed-off-by: Randy Dunlap <[email protected]>
---
drivers/gpio/gpio-max730x.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/drivers/gpio/gpio-max730x.c b/drivers/gpio/gpio-max730x.c
--- a/drivers/gpio/gpio-max730x.c
+++ b/drivers/gpio/gpio-max730x.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* Copyright (C) 2006 Juergen Beisert, Pengutronix
* Copyright (C) 2008 Guennadi Liakhovetski, Pengutronix
* Copyright (C) 2009 Wolfram Sang, Pengutronix

2023-12-07 08:24:58

by Bartosz Golaszewski

Subject: Re: [PATCH] gpio: max730x: don't use kernel-doc marker for regular comment

On Wed, Dec 6, 2023 at 4:05 AM Randy Dunlap <[email protected]> wrote:
>
> Use a common C comment (/*) instead of kernel-doc notation to prevent
> warnings from scripts/kernel-doc.
>
> gpio-max730x.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> gpio-max730x.c:3: warning: missing initial short description on line:
> * Copyright (C) 2006 Juergen Beisert, Pengutronix
>
> Signed-off-by: Randy Dunlap <[email protected]>
> ---
> drivers/gpio/gpio-max730x.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/gpio/gpio-max730x.c b/drivers/gpio/gpio-max730x.c
> --- a/drivers/gpio/gpio-max730x.c
> +++ b/drivers/gpio/gpio-max730x.c
> @@ -1,5 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
> * Copyright (C) 2006 Juergen Beisert, Pengutronix
> * Copyright (C) 2008 Guennadi Liakhovetski, Pengutronix
> * Copyright (C) 2009 Wolfram Sang, Pengutronix

Applied, thanks!

Bart