* [PATCH] net: encx24j600: fix kernel-doc syntax in file headers
@ 2021-05-20 18:49 Aditya Srivastava
2021-05-20 21:34 ` Randy Dunlap
2021-05-20 22:30 ` patchwork-bot+netdevbpf
0 siblings, 2 replies; 3+ messages in thread
From: Aditya Srivastava @ 2021-05-20 18:49 UTC (permalink / raw)
To: davem
Cc: yashsri421, lukas.bulwahn, rdunlap, kuba, netdev,
linux-kernel-mentees, linux-doc, linux-kernel
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/net/ethernet/microchip/encx24j600 files 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 unexpected warning from kernel-doc.
For e.g., running scripts/kernel-doc -none
drivers/net/ethernet/microchip/encx24j600_hw.h emits:
warning: expecting prototype for h(). Prototype was for _ENCX24J600_HW_H() instead
Provide a simple fix by replacing such occurrences with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
drivers/net/ethernet/microchip/encx24j600.c | 2 +-
drivers/net/ethernet/microchip/encx24j600_hw.h | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/net/ethernet/microchip/encx24j600.c b/drivers/net/ethernet/microchip/encx24j600.c
index 3658c4ae3c37..ee921a99e439 100644
--- a/drivers/net/ethernet/microchip/encx24j600.c
+++ b/drivers/net/ethernet/microchip/encx24j600.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-or-later
-/**
+/*
* Microchip ENCX24J600 ethernet driver
*
* Copyright (C) 2015 Gridpoint
diff --git a/drivers/net/ethernet/microchip/encx24j600_hw.h b/drivers/net/ethernet/microchip/encx24j600_hw.h
index f604a260ede7..fac61a8fbd02 100644
--- a/drivers/net/ethernet/microchip/encx24j600_hw.h
+++ b/drivers/net/ethernet/microchip/encx24j600_hw.h
@@ -1,5 +1,5 @@
/* SPDX-License-Identifier: GPL-2.0 */
-/**
+/*
* encx24j600_hw.h: Register definitions
*
*/
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] net: encx24j600: fix kernel-doc syntax in file headers
2021-05-20 18:49 [PATCH] net: encx24j600: fix kernel-doc syntax in file headers Aditya Srivastava
@ 2021-05-20 21:34 ` Randy Dunlap
2021-05-20 22:30 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2021-05-20 21:34 UTC (permalink / raw)
To: Aditya Srivastava, davem
Cc: lukas.bulwahn, kuba, netdev, linux-kernel-mentees, linux-doc,
linux-kernel
On 5/20/21 11:49 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/net/ethernet/microchip/encx24j600 files 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 unexpected warning from kernel-doc.
> For e.g., running scripts/kernel-doc -none
> drivers/net/ethernet/microchip/encx24j600_hw.h emits:
> warning: expecting prototype for h(). Prototype was for _ENCX24J600_HW_H() instead
>
> Provide a simple fix by replacing such 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>
Thanks.
> ---
> drivers/net/ethernet/microchip/encx24j600.c | 2 +-
> drivers/net/ethernet/microchip/encx24j600_hw.h | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/net/ethernet/microchip/encx24j600.c b/drivers/net/ethernet/microchip/encx24j600.c
> index 3658c4ae3c37..ee921a99e439 100644
> --- a/drivers/net/ethernet/microchip/encx24j600.c
> +++ b/drivers/net/ethernet/microchip/encx24j600.c
> @@ -1,5 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0-or-later
> -/**
> +/*
> * Microchip ENCX24J600 ethernet driver
> *
> * Copyright (C) 2015 Gridpoint
> diff --git a/drivers/net/ethernet/microchip/encx24j600_hw.h b/drivers/net/ethernet/microchip/encx24j600_hw.h
> index f604a260ede7..fac61a8fbd02 100644
> --- a/drivers/net/ethernet/microchip/encx24j600_hw.h
> +++ b/drivers/net/ethernet/microchip/encx24j600_hw.h
> @@ -1,5 +1,5 @@
> /* SPDX-License-Identifier: GPL-2.0 */
> -/**
> +/*
> * encx24j600_hw.h: Register definitions
> *
> */
>
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] net: encx24j600: fix kernel-doc syntax in file headers
2021-05-20 18:49 [PATCH] net: encx24j600: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-20 21:34 ` Randy Dunlap
@ 2021-05-20 22:30 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 3+ messages in thread
From: patchwork-bot+netdevbpf @ 2021-05-20 22:30 UTC (permalink / raw)
To: Aditya Srivastava
Cc: davem, lukas.bulwahn, rdunlap, kuba, netdev,
linux-kernel-mentees, linux-doc, linux-kernel
Hello:
This patch was applied to netdev/net.git (refs/heads/master):
On Fri, 21 May 2021 00:19:15 +0530 you wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/net/ethernet/microchip/encx24j600 files 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 unexpected warning from kernel-doc.
> For e.g., running scripts/kernel-doc -none
> drivers/net/ethernet/microchip/encx24j600_hw.h emits:
> warning: expecting prototype for h(). Prototype was for _ENCX24J600_HW_H() instead
>
> [...]
Here is the summary with links:
- net: encx24j600: fix kernel-doc syntax in file headers
https://git.kernel.org/netdev/net/c/503c599a4f53
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-05-20 22:30 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-20 18:49 [PATCH] net: encx24j600: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-20 21:34 ` Randy Dunlap
2021-05-20 22:30 ` patchwork-bot+netdevbpf
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).