From: Randy Dunlap <rdunlap@infradead.org> To: Aditya Srivastava <yashsri421@gmail.com>, linux-kernel@vger.kernel.org Cc: lukas.bulwahn@gmail.com, dvhart@infradead.org, andy@infradead.org, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de, x86@kernel.org, hpa@zytor.com, linux-kernel-mentees@lists.linuxfoundation.org, linux-doc@vger.kernel.org, platform-driver-x86@vger.kernel.org Subject: Re: [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files Date: Tue, 30 Mar 2021 14:32:46 -0700 [thread overview] Message-ID: <1f37b726-7f03-99dc-546f-7d33a1f2c6c9@infradead.org> (raw) In-Reply-To: <20210330213022.28769-1-yashsri421@gmail.com> On 3/30/21 2:30 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are certain files in arch/x86/platform/intel-quark, which follow this > syntax, but the content inside does not comply with kernel-doc. > Such lines were probably not meant for kernel-doc parsing, but are parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warnings from kernel-doc. > > E.g., presence of kernel-doc like comment in the header lines for > arch/x86/platform/intel-quark/imr.c causes these warnings: > "warning: Function parameter or member 'fmt' not described in 'pr_fmt'" > "warning: expecting prototype for c(). Prototype was for pr_fmt() instead" > > Similarly for arch/x86/platform/intel-quark/imr_selftest.c too. > > Provide a simple fix by replacing these occurrences 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/x86/platform/intel-quark/imr.c | 2 +- > arch/x86/platform/intel-quark/imr_selftest.c | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/arch/x86/platform/intel-quark/imr.c b/arch/x86/platform/intel-quark/imr.c > index 122e0f37b1f5..d3d456925b2a 100644 > --- a/arch/x86/platform/intel-quark/imr.c > +++ b/arch/x86/platform/intel-quark/imr.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * imr.c -- Intel Isolated Memory Region driver > * > * Copyright(c) 2013 Intel Corporation. > diff --git a/arch/x86/platform/intel-quark/imr_selftest.c b/arch/x86/platform/intel-quark/imr_selftest.c > index 570e3062faac..761f3689f60a 100644 > --- a/arch/x86/platform/intel-quark/imr_selftest.c > +++ b/arch/x86/platform/intel-quark/imr_selftest.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * imr_selftest.c -- Intel Isolated Memory Region self-test driver > * > * Copyright(c) 2013 Intel Corporation. > -- ~Randy
WARNING: multiple messages have this Message-ID (diff)
From: Randy Dunlap <rdunlap@infradead.org> To: Aditya Srivastava <yashsri421@gmail.com>, linux-kernel@vger.kernel.org Cc: hpa@zytor.com, linux-doc@vger.kernel.org, x86@kernel.org, platform-driver-x86@vger.kernel.org, mingo@redhat.com, bp@alien8.de, dvhart@infradead.org, tglx@linutronix.de, linux-kernel-mentees@lists.linuxfoundation.org, andy@infradead.org Subject: Re: [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files Date: Tue, 30 Mar 2021 14:32:46 -0700 [thread overview] Message-ID: <1f37b726-7f03-99dc-546f-7d33a1f2c6c9@infradead.org> (raw) In-Reply-To: <20210330213022.28769-1-yashsri421@gmail.com> On 3/30/21 2:30 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are certain files in arch/x86/platform/intel-quark, which follow this > syntax, but the content inside does not comply with kernel-doc. > Such lines were probably not meant for kernel-doc parsing, but are parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warnings from kernel-doc. > > E.g., presence of kernel-doc like comment in the header lines for > arch/x86/platform/intel-quark/imr.c causes these warnings: > "warning: Function parameter or member 'fmt' not described in 'pr_fmt'" > "warning: expecting prototype for c(). Prototype was for pr_fmt() instead" > > Similarly for arch/x86/platform/intel-quark/imr_selftest.c too. > > Provide a simple fix by replacing these occurrences 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/x86/platform/intel-quark/imr.c | 2 +- > arch/x86/platform/intel-quark/imr_selftest.c | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/arch/x86/platform/intel-quark/imr.c b/arch/x86/platform/intel-quark/imr.c > index 122e0f37b1f5..d3d456925b2a 100644 > --- a/arch/x86/platform/intel-quark/imr.c > +++ b/arch/x86/platform/intel-quark/imr.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * imr.c -- Intel Isolated Memory Region driver > * > * Copyright(c) 2013 Intel Corporation. > diff --git a/arch/x86/platform/intel-quark/imr_selftest.c b/arch/x86/platform/intel-quark/imr_selftest.c > index 570e3062faac..761f3689f60a 100644 > --- a/arch/x86/platform/intel-quark/imr_selftest.c > +++ b/arch/x86/platform/intel-quark/imr_selftest.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * imr_selftest.c -- Intel Isolated Memory Region self-test driver > * > * Copyright(c) 2013 Intel Corporation. > -- ~Randy _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2021-03-30 21:35 UTC|newest] Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-03-30 21:30 [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files Aditya Srivastava 2021-03-30 21:30 ` Aditya Srivastava 2021-03-30 21:32 ` Randy Dunlap [this message] 2021-03-30 21:32 ` Randy Dunlap 2021-04-10 12:02 ` [tip: x86/cleanups] x86/platform/intel/quark: Fix " tip-bot2 for Aditya Srivastava
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=1f37b726-7f03-99dc-546f-7d33a1f2c6c9@infradead.org \ --to=rdunlap@infradead.org \ --cc=andy@infradead.org \ --cc=bp@alien8.de \ --cc=dvhart@infradead.org \ --cc=hpa@zytor.com \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel-mentees@lists.linuxfoundation.org \ --cc=linux-kernel@vger.kernel.org \ --cc=lukas.bulwahn@gmail.com \ --cc=mingo@redhat.com \ --cc=platform-driver-x86@vger.kernel.org \ --cc=tglx@linutronix.de \ --cc=x86@kernel.org \ --cc=yashsri421@gmail.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.