On 5/22/21 5:40 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for drivers/ipack/carriers/tpci200 follows this syntax, but the > content inside does not comply with kernel-doc. > > This line was probably not meant for kernel-doc parsing, but is parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warning from kernel-doc. > > For e.g., running scripts/kernel-doc -none on > drivers/ipack/carriers/tpci200.c emits: > warning: This comment starts with '/**', but isn't a kernel-doc comment. > Refer Documentation/doc-guide/kernel-doc.rst > * tpci200.c > > Provide a simple fix by replacing this occurrence with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Also remove the redundant file name from the comment headers. > > Signed-off-by: Aditya Srivastava <yashsri...@gmail.com>
Acked-by: Randy Dunlap <rdun...@infradead.org> Thanks. > --- > drivers/ipack/carriers/tpci200.c | 4 +--- > drivers/ipack/carriers/tpci200.h | 4 +--- > 2 files changed, 2 insertions(+), 6 deletions(-) > > diff --git a/drivers/ipack/carriers/tpci200.c > b/drivers/ipack/carriers/tpci200.c > index ec71063fff76..a867906777bd 100644 > --- a/drivers/ipack/carriers/tpci200.c > +++ b/drivers/ipack/carriers/tpci200.c > @@ -1,7 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > - * tpci200.c > - * > +/* > * driver for the TEWS TPCI-200 device > * > * Copyright (C) 2009-2012 CERN (www.cern.ch) > diff --git a/drivers/ipack/carriers/tpci200.h > b/drivers/ipack/carriers/tpci200.h > index 2619f827e33f..e79ac64abcff 100644 > --- a/drivers/ipack/carriers/tpci200.h > +++ b/drivers/ipack/carriers/tpci200.h > @@ -1,7 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0-only */ > -/** > - * tpci200.h > - * > +/* > * driver for the carrier TEWS TPCI-200 > * > * Copyright (C) 2009-2012 CERN (www.cern.ch) > -- ~Randy _______________________________________________ Industrypack-devel mailing list Industrypack-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/industrypack-devel
