* [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files
@ 2021-03-30 21:30 ` Aditya Srivastava
0 siblings, 0 replies; 5+ messages in thread
From: Aditya Srivastava @ 2021-03-30 21:30 UTC (permalink / raw)
To: linux-kernel
Cc: yashsri421, lukas.bulwahn, rdunlap, dvhart, andy, tglx, mingo,
bp, x86, hpa, linux-kernel-mentees, linux-doc,
platform-driver-x86
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files
@ 2021-03-30 21:30 ` Aditya Srivastava
0 siblings, 0 replies; 5+ 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] 5+ messages in thread
* Re: [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
-1 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2021-03-30 21:32 UTC (permalink / raw)
To: Aditya Srivastava, linux-kernel
Cc: lukas.bulwahn, dvhart, andy, tglx, mingo, bp, x86, hpa,
linux-kernel-mentees, linux-doc, platform-driver-x86
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
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files
@ 2021-03-30 21:32 ` Randy Dunlap
0 siblings, 0 replies; 5+ 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] 5+ messages in thread
* [tip: x86/cleanups] x86/platform/intel/quark: Fix incorrect kernel-doc comment syntax in files
2021-03-30 21:30 ` Aditya Srivastava
(?)
(?)
@ 2021-04-10 12:02 ` tip-bot2 for Aditya Srivastava
-1 siblings, 0 replies; 5+ messages in thread
From: tip-bot2 for Aditya Srivastava @ 2021-04-10 12:02 UTC (permalink / raw)
To: linux-tip-commits
Cc: Aditya Srivastava, Thomas Gleixner, Randy Dunlap, x86, linux-kernel
The following commit has been merged into the x86/cleanups branch of tip:
Commit-ID: 0d6c8e1e246586b81cb4e6ab1a93a6d4a08a0cf9
Gitweb: https://git.kernel.org/tip/0d6c8e1e246586b81cb4e6ab1a93a6d4a08a0cf9
Author: Aditya Srivastava <yashsri421@gmail.com>
AuthorDate: Wed, 31 Mar 2021 03:00:22 +05:30
Committer: Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Sat, 10 Apr 2021 13:59:25 +02:00
x86/platform/intel/quark: Fix incorrect kernel-doc comment syntax in files
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>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20210330213022.28769-1-yashsri421@gmail.com
---
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 122e0f3..d3d4569 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 570e306..761f368 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.
^ permalink raw reply related [flat|nested] 5+ messages in thread
end of thread, other threads:[~2021-04-10 12:02 UTC | newest]
Thread overview: 5+ 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:30 ` Aditya Srivastava
2021-03-30 21:32 ` Randy Dunlap
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
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.