| Message ID | 20231206030523.302-1-rdunlap@infradead.org |
|---|---|
| State | Accepted |
| Commit | 6c826061c5ee42fe547d1ac4792b30125fa8cb13 |
| Headers | show |
| Series | gpio: max730x: don't use kernel-doc marker for regular comment | expand |
On Wed, Dec 6, 2023 at 4:05 AM Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org> > --- > 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
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
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 <rdunlap@infradead.org> --- drivers/gpio/gpio-max730x.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)