* [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files
@ 2021-03-30 21:30 Aditya Srivastava
2021-03-30 21:32 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Aditya Srivastava @ 2021-03-30 21:30 UTC (permalink / raw)
To: linux-kernel
Cc: x86, hpa, yashsri421, rdunlap, linux-doc, platform-driver-x86,
mingo, bp, dvhart, tglx, linux-kernel-mentees, andy
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>
---
* 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.
--
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files
2021-03-30 21:30 [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files Aditya Srivastava
@ 2021-03-30 21:32 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2021-03-30 21:32 UTC (permalink / raw)
To: Aditya Srivastava, linux-kernel
Cc: hpa, linux-doc, x86, platform-driver-x86, mingo, bp, dvhart,
tglx, linux-kernel-mentees, andy
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-03-30 21:35 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-30 21:30 [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files Aditya Srivastava
2021-03-30 21:32 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).