| Message ID | 20210314072828.9270-1-yashsri421@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | soc: fsl: guts: fix comment syntax in file | expand |
On 3/13/21 11:28 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for kernel-doc comments. > There are certain comments in include/linux/fsl/guts.h which follows this > syntax, but the content inside does not comply with kernel-doc. > > E.g., opening comment for "Freecale 85xx and 86xx Global Utilties > register set" follows kernel-doc syntax(i.e., '/**'), but the content > inside does not comply with any kernel-doc specification (function, > struct, etc). > > This causes unwelcomed warning from kernel-doc: > "warning: expecting prototype for Freecale 85xx and 86xx Global Utilties register set(). Prototype was for __FSL_GUTS_H__() instead" > > Replace all such comment occurrences with general comment format, > i.e. '/*' to pervent kernel-doc from parsing these. > > Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > * Applies perfectly on next-20210312 > > include/linux/fsl/guts.h | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/include/linux/fsl/guts.h b/include/linux/fsl/guts.h > index 0ac27b233f12..fdb55ca47a4f 100644 > --- a/include/linux/fsl/guts.h > +++ b/include/linux/fsl/guts.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0-or-later */ > -/** > +/* > * Freecale 85xx and 86xx Global Utilties register set > * > * Authors: Jeff Brown > @@ -14,7 +14,7 @@ > #include <linux/types.h> > #include <linux/io.h> > > -/** > +/* > * Global Utility Registers. > * > * Not all registers defined in this structure are available on all chips, so >
diff --git a/include/linux/fsl/guts.h b/include/linux/fsl/guts.h index 0ac27b233f12..fdb55ca47a4f 100644 --- a/include/linux/fsl/guts.h +++ b/include/linux/fsl/guts.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0-or-later */ -/** +/* * Freecale 85xx and 86xx Global Utilties register set * * Authors: Jeff Brown @@ -14,7 +14,7 @@ #include <linux/types.h> #include <linux/io.h> -/** +/* * Global Utility Registers. * * Not all registers defined in this structure are available on all chips, so
The opening comment mark '/**' is used for kernel-doc comments. There are certain comments in include/linux/fsl/guts.h which follows this syntax, but the content inside does not comply with kernel-doc. E.g., opening comment for "Freecale 85xx and 86xx Global Utilties register set" follows kernel-doc syntax(i.e., '/**'), but the content inside does not comply with any kernel-doc specification (function, struct, etc). This causes unwelcomed warning from kernel-doc: "warning: expecting prototype for Freecale 85xx and 86xx Global Utilties register set(). Prototype was for __FSL_GUTS_H__() instead" Replace all such comment occurrences with general comment format, i.e. '/*' to pervent kernel-doc from parsing these. Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> --- * Applies perfectly on next-20210312 include/linux/fsl/guts.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)