* [PATCH] ARM: mach-sa1100: fix incorrect kernel-doc comment syntax in file
@ 2021-03-30 20:44 Aditya Srivastava
2021-03-30 21:02 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Aditya Srivastava @ 2021-03-30 20:44 UTC (permalink / raw)
To: linux
Cc: yashsri421, lukas.bulwahn, rdunlap, linux-kernel-mentees,
linux-doc, linux-arm-kernel, linux-kernel
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>
---
* 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>
--
2.17.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] ARM: mach-sa1100: fix incorrect kernel-doc comment syntax in file
2021-03-30 20:44 [PATCH] ARM: mach-sa1100: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
@ 2021-03-30 21:02 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2021-03-30 21:02 UTC (permalink / raw)
To: Aditya Srivastava, linux
Cc: lukas.bulwahn, linux-kernel-mentees, linux-doc, linux-arm-kernel,
linux-kernel
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-03-30 21:03 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-30 20:44 [PATCH] ARM: mach-sa1100: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
2021-03-30 21:02 ` 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).