Messages in this thread | | | Subject | Re: [PATCH] ARM: mach-sa1100: fix incorrect kernel-doc comment syntax in file | From | Randy Dunlap <> | Date | Tue, 30 Mar 2021 14:02:48 -0700 |
| |
On 3/30/21 1:44 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for arch/arm/mach-sa1100/jornada720_ssp.c 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 these warnings from kernel-doc: > "warning: Function parameter or member 'jornada_ssp_lock' not described in 'DEFINE_SPINLOCK'" > "warning: expecting prototype for mac(). Prototype was for DEFINE_SPINLOCK() instead" > > Provide a simple fix by replacing this occurrence with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
> --- > * Applies perfectly on next-20210326 > > arch/arm/mach-sa1100/jornada720_ssp.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/arch/arm/mach-sa1100/jornada720_ssp.c b/arch/arm/mach-sa1100/jornada720_ssp.c > index 1dbe98948ce3..148bcee3ee58 100644 > --- a/arch/arm/mach-sa1100/jornada720_ssp.c > +++ b/arch/arm/mach-sa1100/jornada720_ssp.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * arch/arm/mac-sa1100/jornada720_ssp.c > * > * Copyright (C) 2006/2007 Kristoffer Ericson <Kristoffer.Ericson@gmail.com> >
-- ~Randy
| |